2007-05-23 Murray Cumming <murrayc@murrayc.com>

[modest] / src / modest-tny-account-store.h

diff --git a/src/modest-tny-account-store.h b/src/modest-tny-account-store.h
index 96482d4..0386769 100644 (file)
--- a/src/modest-tny-account-store.h
+++ b/src/modest-tny-account-store.h
@@ -34,9 +34,13 @@
 #define __MODEST_TNY_ACCOUNT_STORE_H__
 
 #include <glib-object.h>
+#include <modest-defs.h>
 #include <tny-account-store.h>
 #include <tny-session-camel.h>
 #include <tny-shared.h>
+#include <tny-folder.h>
+#include <modest-tny-simple-folder-store.h>
+#include <modest-account-mgr.h>
 
 /* other include files */
 
@@ -61,45 +65,79 @@ struct _ModestTnyAccountStore {
 struct _ModestTnyAccountStoreClass {
        GObjectClass parent_class;
 
-       void (*password_requested) (ModestTnyAccountStore *self,
-                                   const gchar *account_name,
-                                   gpointer user_data);
-       void (*update_accounts)    (ModestTnyAccountStore *self,
-                                   const gchar *account_name,
-                                   gpointer user_data);
+       void (*account_update)        (ModestTnyAccountStore *self,
+                                     const gchar *account_name,
+                                     gpointer user_data);
+       void (*password_requested)    (ModestTnyAccountStore *self,
+                                      const gchar *server_account_name,
+                                      gchar **username,
+                                      gchar **password,
+                                      gboolean *remember,
+                                      gboolean *cancel,
+                                      gpointer user_data);
 };
 
-/* member functions */
-
 /**
  * modest_tny_account_store_get_type:
  *
- * Returns: GType of account store
+ * Returns: GType of the account store
  */
-GType        modest_tny_account_store_get_type    (void) G_GNUC_CONST;
+GType  modest_tny_account_store_get_type   (void) G_GNUC_CONST;
 
 /**
  * modest_tny_account_store_new:
- * @modest_acc_mgr: account manager to use for new account store
+ * @account_mgr: account manager to use for new account store
  *
  * creates new (tinymail) account store for account manager modest_acc_mgr
  *
  * Returns: newly created account store or NULL in case of error
  */
-ModestTnyAccountStore*    modest_tny_account_store_new         (ModestAccountMgr *modest_acc_mgr);
+ModestTnyAccountStore*    modest_tny_account_store_new (ModestAccountMgr *account_mgr,
+                                                       TnyDevice *device);
 
 
 /**
- * tny_account_store_set_get_pass_func:
- * @self: a TnyAccountStore instance
- * key: a key
- * func: a function
- *
- * set the password function to function
+ * modest_tny_account_store_get_account_by_id 
+ * @self: a ModestTnyAccountStore instance
+ * @id: some ID
+ * 
+ * get the account with the given ID or NULL if it's not found
+ * 
+ * Returns: the tnyaccount or NULL,
+ * g_object_unref when it's no longer needed
  */
-void
-modest_tny_account_store_set_get_pass_func (ModestTnyAccountStore *, ModestTnyGetPassFunc);
+TnyAccount* modest_tny_account_store_get_tny_account_by_id  (ModestTnyAccountStore *self,
+                                                            const gchar *id);
 
+/**
+ * modest_tny_account_store_get_tny_account_by_account
+ * @self: a ModestTnyAccountStore instance
+ * @account_name: an account name
+ * @type: the tny account type
+ * 
+ * Get the tny account corresponding to one of the server_accounts for account with @account_name
+ * 
+ * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
+ * g_object_unref when it's no longer needed
+ */
+TnyAccount* modest_tny_account_store_get_tny_account_by_account (ModestTnyAccountStore *self,
+                                                                const gchar *account_name,
+                                                                TnyAccountType type);
+               
+/**
+ * modest_tny_account_store_get_transport_account_for_open_connection
+ * @self: a ModestTnyAccountStore instance
+ * @account_name: an account name
+ * 
+ * Get the tny account corresponding to the transport server account for the account with @account_name,
+ * returning the connection-specific SMTP-server transport server account if one is specified,
+ * otherwise just returning the regular transport server account.
+ * 
+ * Returns: the tnyaccount for the server account or NULL in case it's not found or error,
+ * g_object_unref when it's no longer needed
+ */                                             
+TnyAccount* modest_tny_account_store_get_transport_account_for_open_connection (ModestTnyAccountStore *self,
+                                                                const gchar *account_name);
 
 /**
  * tny_account_store_get_session
@@ -110,8 +148,17 @@ modest_tny_account_store_set_get_pass_func (ModestTnyAccountStore *, ModestTnyGe
  *
  * Returns: a tny-camel-session
  */
-TnySessionCamel*    tny_account_store_get_session    (TnyAccountStore *self);
+TnySessionCamel*    modest_tny_account_store_get_session    (TnyAccountStore *self);
+
 
+/** modest_tny_folder_store_is_virtual_local_folders:
+ * @self A TnyFolderStore.
+ * 
+ * A convenience function to identify whether TnyAccount or other TnyFolderStore 
+ * is the virtual local folders store, containing the folders from local_folders/
+ * and the outboxes from outboxes/<account-name>/.
+ **/
+gboolean modest_tny_folder_store_is_virtual_local_folders (TnyFolderStore *self);
 
 G_END_DECLS