* many changes:
[modest] / src / modest-account-mgr.h
index 912bbb8..e6cba5b 100644 (file)
@@ -28,8 +28,6 @@
  */
 
 
-/* modest-account-mgr.h */
-
 #ifndef __MODEST_ACCOUNT_MGR_H__
 #define __MODEST_ACCOUNT_MGR_H__
 
@@ -43,7 +41,7 @@ G_BEGIN_DECLS
 /* convenience macros */
 #define MODEST_TYPE_ACCOUNT_MGR             (modest_account_mgr_get_type())
 #define MODEST_ACCOUNT_MGR(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgr))
-#define MODEST_ACCOUNT_MGR_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_ACCOUNT_MGR,GObject))
+#define MODEST_ACCOUNT_MGR_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgrClass))
 #define MODEST_IS_ACCOUNT_MGR(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_ACCOUNT_MGR))
 #define MODEST_IS_ACCOUNT_MGR_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_ACCOUNT_MGR))
 #define MODEST_ACCOUNT_MGR_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgrClass))
@@ -52,16 +50,16 @@ typedef struct _ModestAccountMgr      ModestAccountMgr;
 typedef struct _ModestAccountMgrClass ModestAccountMgrClass;
 
 
-
 struct _ModestAccountMgr {
         GObject parent;
-       /* insert public members, if any */
 };
 
 struct _ModestAccountMgrClass {
        GObjectClass parent_class;
-       /* insert signal callback declarations, eg. */
-       /* void (* my_event) (ModestAccountMgr* obj); */
+
+       void (* account_removed)   (ModestAccountMgr *obj, const gchar* account, gboolean server_account, gpointer user_data);
+       void (* account_changed)   (ModestAccountMgr *obj, const gchar* account, const gchar* key, gboolean server_account,
+                                   gpointer user_data);
 };
 
 
@@ -103,20 +101,6 @@ gboolean        modest_account_mgr_add_account    (ModestAccountMgr *self,
                                                   const gchar* store_name,
                                                   const gchar* transport_name,
                                                   GError **err);
-/**
- * modest_account_mgr_remove_account:
- * @self: a ModestAccountMgr instance
- * @name: the name of the account to remove
- * @err: a GError ptr, or NULL to ignore.
- * 
- * remove an existing account. the account with @name should already exist
- *
- * Returns: TRUE if the creation succeeded, FALSE otherwise,
- * @err gives details in case of error
- */
-gboolean        modest_account_mgr_remove_account         (ModestAccountMgr *self,
-                                                          const gchar* name,
-                                                          GError **err);
 
 
 /**
@@ -141,20 +125,21 @@ gboolean modest_account_mgr_add_server_account    (ModestAccountMgr *self,
                                                   const gchar *proto);  
 
 /**
- * modest_account_mgr_remove_server_account:
+ * modest_account_mgr_remove_account:
  * @self: a ModestAccountMgr instance
- * @name: the name for the server account to remove
+ * @name: the name of the account to remove
  * @err: a GError ptr, or NULL to ignore.
  * 
- * remove a server account from the configuration
- * the server account with @name should exist
+ * remove an existing account. the account with @name should already exist
  *
- * Returns: TRUE if the removal succeeded, FALSE otherwise,
+ * Returns: TRUE if the creation succeeded, FALSE otherwise,
  * @err gives details in case of error
  */
-gboolean        modest_account_mgr_remove_server_account    (ModestAccountMgr *self,
-                                                            const gchar *name,
-                                                            GError **err);
+gboolean        modest_account_mgr_remove_account         (ModestAccountMgr *self,
+                                                          const gchar* name,
+                                                          gboolean server_account,
+                                                          GError **err);
+
 
 /**
  * modest_account_mgr_account_names:
@@ -183,16 +168,17 @@ GSList*           modest_account_mgr_account_names    (ModestAccountMgr *self, GEr
  * Returns: a newly allocated list of server account names, or NULL in case of
  * error or if there are no server accounts. The caller must free the returned GSList
  */
-GSList*  modest_account_mgr_server_account_names   (ModestAccountMgr *self,
-                                                   const gchar*    account_name,
-                                                   ModestProtoType type,
-                                                   const gchar*    proto,
-                                                   gboolean only_enabled);
+GSList*  modest_account_mgr_search_server_accounts  (ModestAccountMgr *self,
+                                                    const gchar*    account_name,
+                                                    ModestProtoType type,
+                                                    const gchar*    proto,
+                                                    gboolean only_enabled);
 
 /**
  * modest_account_mgr_account_exists:
  * @self: a ModestAccountMgr instance
  * @name: the account name to check
+ * @server_account: if TRUE, this is a server account
  * @err: a GError ptr, or NULL to ignore.
  * 
  * check whether account @name exists
@@ -202,21 +188,64 @@ GSList*  modest_account_mgr_server_account_names   (ModestAccountMgr *self,
  */
 gboolean       modest_account_mgr_account_exists         (ModestAccountMgr *self,
                                                           const gchar *name,
+                                                          gboolean server_account,
                                                           GError **err);
-                                                          
-gboolean       modest_account_mgr_server_account_exists          (ModestAccountMgr *self,
-                                                                  const gchar *name,
-                                                                  GError **err);
+
+
+/**
+ * modest_account_mgr_enable_account:
+ * @self: a ModestAccountMgr instance
+ * @name: the account name to disable
+ * @server_account: if TRUE, this is a server account
+ * 
+ * enable an account that has been disabled with 'modest_account_mgr_disable_account'
+ *
+ * Returns: TRUE if it worked, FALSE otherwise
+ */
+gboolean modest_account_mgr_enable_account (ModestAccountMgr *self, const gchar* name,
+                                           gboolean is_server_account);
+
+
+
+/**
+ * modest_account_mgr_disable_account:
+ * @self: a ModestAccountMgr instance
+ * @name: the account name to disable
+ * @server_account: if TRUE, this is a server account
+ * 
+ * disable an account. this will also stop change notification until
+ * modest_account_mgr_enable_account is called. However, in case of removal, the
+ * appropriate signal will still be emitted.
+ *
+ * Returns: TRUE if it worked, FALSE otherwise
+ */
+gboolean modest_account_mgr_disable_account (ModestAccountMgr *self, const gchar* name,
+                                            gboolean is_server_account);
+
+
+
+/**
+ * modest_account_mgr_account_is_enabled:
+ * @self: a ModestAccountMgr instance
+ * @name: the account name to check
+ * @server_account: if TRUE, this is a server account
+ *
+ * check whether a certain account is enabled
+ *
+ * Returns: TRUE if it is enabled, FALSE otherwise
+ */
+gboolean modest_account_mgr_account_is_enabled (ModestAccountMgr *self, const gchar* name,
+                                               gboolean is_server_account);
 
 
 
-/* account specific functions */
 
 /**
  * modest_account_mgr_get_account_string:
  * @self: self a ModestAccountMgr instance
  * @name: the name of the account
  * @key: the key of the value to retrieve
+ * @server_account: if TRUE, this is a server account
  * @err: a GError ptr, or NULL to ignore.
  * 
  * get a config string from an account
@@ -224,19 +253,19 @@ gboolean  modest_account_mgr_server_account_exists          (ModestAccountMgr *self,
  * Returns: a newly allocated string with the value for the key,
  * or NULL in case of error. @err gives details in case of error
  */
-gchar*         modest_account_mgr_get_account_string     (ModestAccountMgr *self,
-                                                          const gchar *name,
-                                                          const gchar *key, GError **err);
+gchar*         modest_account_mgr_get_string     (ModestAccountMgr *self,
+                                                  const gchar *name,
+                                                  const gchar *key,
+                                                  gboolean server_account,
+                                                  GError **err);
 
-gchar*         modest_account_mgr_get_server_account_string     (ModestAccountMgr *self,
-                                                          const gchar *name,
-                                                          const gchar *key, GError **err);
 
 /**
  * modest_account_mgr_get_account_int:
  * @self: a ModestAccountMgr instance
  * @name: the name of the account
  * @key: the key of the value to retrieve
+ * @server_account: if TRUE, this is a server account
  * @err: a GError ptr, or NULL to ignore.
  * 
  * get a config int from an account
@@ -245,20 +274,18 @@ gchar*            modest_account_mgr_get_server_account_string     (ModestAccountMg
  * error (but of course -1 does not necessarily imply an error)
  * @err gives details in case of error
  */
-gint           modest_account_mgr_get_account_int        (ModestAccountMgr *self,
-                                                          const gchar *name,
-                                                          const gchar *key, GError **err);
-
-gint           modest_account_mgr_get_server_account_int        (ModestAccountMgr *self,
-                                                          const gchar *name,
-                                                          const gchar *key, GError **err);
-
+gint           modest_account_mgr_get_int        (ModestAccountMgr *self,
+                                                  const gchar *name,
+                                                  const gchar *key,
+                                                  gboolean server_account,
+                                                  GError **err);
 
 /**
  * modest_account_mgr_get_account_bool:
  * @self: a ModestAccountMgr instance
  * @name: the name of the account
  * @key: the key of the value to retrieve
+ * @server_account: if TRUE, this is a server account
  * @err: a GError ptr, or NULL to ignore.
  * 
  * get a config boolean from an account
@@ -267,13 +294,11 @@ gint              modest_account_mgr_get_server_account_int        (ModestAccountMgr
  * error (but of course FALSE does not necessarily imply an error)
  * @err gives details in case of error
  */
-gboolean       modest_account_mgr_get_account_bool       (ModestAccountMgr *self,
-                                                          const gchar *name,
-                                                          const gchar *key, GError **err);
-
-gboolean       modest_account_mgr_get_server_account_bool       (ModestAccountMgr *self,
-                                                                 const gchar *name,
-                                                                 const gchar *key, GError **err);
+gboolean       modest_account_mgr_get_bool       (ModestAccountMgr *self,
+                                                  const gchar *name,
+                                                  const gchar *key,
+                                                  gboolean server_account,
+                                                  GError **err);
 
 /**
  * modest_account_mgr_set_account_string:
@@ -281,6 +306,7 @@ gboolean    modest_account_mgr_get_server_account_bool       (ModestAccountMgr *sel
  * @name: the name of the account
  * @key: the key of the value to set
  * @val: the value to set
+ * @server_account: if TRUE, this is a server account
  * @err: a GError ptr, or NULL to ignore.
  * 
  * set a config string for an account
@@ -288,16 +314,11 @@ gboolean  modest_account_mgr_get_server_account_bool       (ModestAccountMgr *sel
  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
  * @err gives details in case of error
  */
-gboolean       modest_account_mgr_set_account_string     (ModestAccountMgr *self,
-                                                          const gchar *name,
-                                                          const gchar *key, const gchar* val,
-                                                          GError **err);
-
-gboolean       modest_account_mgr_set_server_account_string     (ModestAccountMgr *self,
-                                                          const gchar *name,
-                                                          const gchar *key, const gchar* val,
-                                                          GError **err);
-
+gboolean       modest_account_mgr_set_string     (ModestAccountMgr *self,
+                                                  const gchar *name,
+                                                  const gchar *key, const gchar* val,
+                                                  gboolean server_account,
+                                                  GError **err);
 
 /**
  * modest_account_mgr_set_account_int:
@@ -305,6 +326,7 @@ gboolean    modest_account_mgr_set_server_account_string     (ModestAccountMgr *sel
  * @name: the name of the account
  * @key: the key of the value to set
  * @val: the value to set
+ * @server_account: if TRUE, this is a server account
  * @err: a GError ptr, or NULL to ignore.
  * 
  * set a config int for an account
@@ -312,15 +334,11 @@ gboolean  modest_account_mgr_set_server_account_string     (ModestAccountMgr *sel
  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
  * @err gives details in case of error
  */
-gboolean       modest_account_mgr_set_account_int        (ModestAccountMgr *self,
-                                                          const gchar *name,
-                                                          const gchar *key, gint val,
-                                                          GError **err);
-
-gboolean       modest_account_mgr_set_server_account_int        (ModestAccountMgr *self,
-                                                                 const gchar *name,
-                                                                 const gchar *key, gint val,
-                                                                 GError **err);
+gboolean       modest_account_mgr_set_int        (ModestAccountMgr *self,
+                                                  const gchar *name,
+                                                  const gchar *key, gint val,
+                                                  gboolean server_account,
+                                                  GError **err);
 
 
 /**
@@ -329,6 +347,7 @@ gboolean    modest_account_mgr_set_server_account_int        (ModestAccountMgr *sel
  * @name: the name of the account
  * @key: the key of the value to set
  * @val: the value to set
+ * @server_account: if TRUE, this is a server account
  * @err: a GError ptr, or NULL to ignore.
  * 
  * set a config bool for an account
@@ -336,16 +355,11 @@ gboolean  modest_account_mgr_set_server_account_int        (ModestAccountMgr *sel
  * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
  * @err gives details in case of error
  */
-gboolean       modest_account_mgr_set_account_bool       (ModestAccountMgr *self,
-                                                          const gchar *name,
-                                                          const gchar *key, gboolean val,
-                                                          GError **err);
-
-gboolean       modest_account_mgr_set_server_account_bool       (ModestAccountMgr *self,
-                                                                 const gchar *name,
-                                                                 const gchar *key, gboolean val,
-                                                                 GError **err);
-
+gboolean       modest_account_mgr_set_bool       (ModestAccountMgr *self,
+                                                  const gchar *name,
+                                                  const gchar *key, gboolean val,
+                                                  gboolean server_account,
+                                                  GError **err);
 
 G_END_DECLS