2007-07-31 Philip Van Hoof <pvanhoof@gnome.org>

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

diff --git a/src/modest-tny-account-store.h b/src/modest-tny-account-store.h
index 861209a..76fbe91 100644 (file)
--- a/src/modest-tny-account-store.h
+++ b/src/modest-tny-account-store.h
@@ -40,6 +40,7 @@
 #include <tny-shared.h>
 #include <tny-folder.h>
 #include <modest-account-mgr.h>
+#include <modest-tny-local-folders-account.h>
 
 /* other include files */
 
@@ -64,11 +65,29 @@ struct _ModestTnyAccountStore {
 struct _ModestTnyAccountStoreClass {
        GObjectClass parent_class;
 
-       void (*account_update)    (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);
+
+       /* Signals */
+       void (*account_changed) (TnyAccountStore *self, TnyAccount *account);
+       void (*account_inserted) (TnyAccountStore *self, TnyAccount *account);
+       void (*account_removed) (TnyAccountStore *self, TnyAccount *account);
 };
 
+typedef enum {
+       MODEST_TNY_ACCOUNT_STORE_QUERY_ID,
+       MODEST_TNY_ACCOUNT_STORE_QUERY_URL,
+} ModestTnyAccountStoreQueryType;
+
+
 /**
  * modest_tny_account_store_get_type:
  *
@@ -84,7 +103,53 @@ GType  modest_tny_account_store_get_type   (void) G_GNUC_CONST;
  *
  * Returns: newly created account store or NULL in case of error
  */
-ModestTnyAccountStore*    modest_tny_account_store_new (ModestAccountMgr *account_mgr);
+ModestTnyAccountStore*    modest_tny_account_store_new (ModestAccountMgr *account_mgr,
+                                                       TnyDevice *device);
+
+
+/**
+ * modest_tny_account_store_get_account_by 
+ * @self: a ModestTnyAccountStore instance
+ * @id: some ID
+ * 
+ * get the account with the given str or NULL if it's not found
+ * 
+ * Returns: the tnyaccount or NULL,
+ * g_object_unref when it's no longer needed
+ */
+TnyAccount* modest_tny_account_store_get_tny_account_by  (ModestTnyAccountStore *self,
+                                                         ModestTnyAccountStoreQueryType type,
+                                                         const gchar *str);
+
+/**
+ * modest_tny_account_store_get_server_account
+ * @self: a ModestTnyAccountStore instance
+ * @account_name: a modest account name
+ * @type: the tny account type (store or transport)
+ * 
+ * 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. TODO: Check that callers are unreffing.
+ */
+TnyAccount* modest_tny_account_store_get_server_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
@@ -95,19 +160,15 @@ ModestTnyAccountStore*    modest_tny_account_store_new (ModestAccountMgr *accoun
  *
  * Returns: a tny-camel-session
  */
-TnySessionCamel*    tny_account_store_get_session    (TnyAccountStore *self);
+TnySessionCamel*    modest_tny_account_store_get_session    (TnyAccountStore *self);
 
-/**
- * tny_account_store_get_local_folders_account 
- * @self: a ModestTnyAccountStore instance
+/** modest_tny_account_store_get_local_folders_account:
+ * @self: a TnyAccountStore instance
  * 
- * return the account corresponding to the local folders
- *
- * Returns: the tnyaccount for the local folders
- */
-TnyAccount*    modest_tny_account_store_get_local_folders_account    (ModestTnyAccountStore *self);
+ * Get the user-visible local folders account.
+ **/
+TnyAccount * modest_tny_account_store_get_local_folders_account (ModestTnyAccountStore *self);
 
 G_END_DECLS
 
 #endif /* __MODEST_TNY_ACCOUNT_STORE_H__ */
-