Hide singleton providers from wizard providers list if already set up
[modest] / src / modest-account-mgr.h
index eef1cdf..56bfb8f 100644 (file)
@@ -33,8 +33,8 @@
 
 #include <glib-object.h>
 #include <modest-conf.h>
-#include <modest-defs.h>
-#include <modest-protocol-info.h>
+#include <modest-protocol-registry.h>
+#include <modest-account-settings.h>
 
 G_BEGIN_DECLS
 
@@ -75,6 +75,14 @@ struct _ModestAccountMgrClass {
 
        void (* default_account_changed)(ModestAccountMgr *obj, 
                                         gpointer user_data);
+
+       void (* display_name_changed)   (ModestAccountMgr *obj, 
+                                        const gchar *account,
+                                        gpointer user_data);
+       
+       void (* account_updated)   (ModestAccountMgr *obj, 
+                        const gchar *account,
+                        gpointer user_data);
 };
 
 /**
@@ -98,6 +106,18 @@ ModestAccountMgr*        modest_account_mgr_new            (ModestConf *modest_c
 
 
 /**
+ * modest_account_mgr_add_account_from_settings:
+ * @self: a #ModestAccountMgr instance
+ * @self: a #ModestSettings
+ * 
+ * Create a new account from a @settings instance.
+ *
+ * Returns: TRUE if the creation succeeded, FALSE otherwise,
+ */
+gboolean        modest_account_mgr_add_account_from_settings    (ModestAccountMgr *self,
+                                                                ModestAccountSettings *settings);
+
+/**
  * modest_account_mgr_add_account:
  * @self: a ModestAccountMgr instance
  * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
@@ -111,7 +131,11 @@ ModestAccountMgr*        modest_account_mgr_new            (ModestConf *modest_c
  * Returns: TRUE if the creation succeeded, FALSE otherwise,
  */
 gboolean        modest_account_mgr_add_account    (ModestAccountMgr *self,
-                                                  const gchar* name,
+                                                  const gchar *name,
+                                                  const gchar *display_name,
+                                                  const gchar *user_fullname,
+                                                  const gchar *user_email,
+                                                  ModestAccountRetrieveType retrieve_type,
                                                   const gchar* store_name,
                                                   const gchar* transport_name,
                                                   gboolean enabled);
@@ -139,9 +163,9 @@ gboolean modest_account_mgr_add_server_account    (ModestAccountMgr *self,
                                                   const guint portnumber,
                                                   const gchar *username,
                                                   const gchar *password,
-                                                  ModestTransportStoreProtocol proto,
-                                                  ModestConnectionProtocol security,
-                                                  ModestAuthProtocol auth);
+                                                  ModestProtocolType proto,
+                                                  ModestProtocolType security,
+                                                  ModestProtocolType auth);
 
 
 /**
@@ -157,7 +181,7 @@ gboolean modest_account_mgr_add_server_account    (ModestAccountMgr *self,
  */
 gboolean modest_account_mgr_add_server_account_uri    (ModestAccountMgr *self,
                                                       const gchar *name,
-                                                      ModestTransportStoreProtocol proto,
+                                                      ModestProtocolType proto,
                                                       const gchar* uri);
 
 /**
@@ -224,186 +248,20 @@ gboolean modest_account_mgr_account_exists         (ModestAccountMgr *self,
  *
  * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
  */
-gboolean       modest_account_mgr_account_with_display_name_exists       (ModestAccountMgr *self,
-                                                          const gchar *display_name);
-
-
-/**
- * modest_account_mgr_get_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
- * 
- * get a config string from an account
- *
- * Returns: a newly allocated string with the value for the key,
- * or NULL in case of error. 
- */
-gchar*         modest_account_mgr_get_string     (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key,
-                                                  gboolean server_account);
-
-
-/**
- * modest_account_mgr_get_password:
- * @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
- * 
- * get a password from an account
- *
- * Returns: a newly allocated string with the value for the key,
- * or NULL in case of error.
- */
-gchar*         modest_account_mgr_get_password     (ModestAccountMgr *self,
-                                                    const gchar *name,
-                                                    const gchar *key,
-                                                    gboolean server_account);
-
-/**
- * modest_account_mgr_get_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
- * 
- * get a config int from an account
- *
- * Returns: an integer with the value for the key, or -1 in case of
- * error (but of course -1 does not necessarily imply an error)
- */
-gint           modest_account_mgr_get_int        (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key,
-                                                  gboolean server_account);
-
-/**
- * modest_account_mgr_get_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
- * 
- * get a config boolean from an account
- *
- * Returns: an boolean with the value for the key, or FALSE in case of
- * error (but of course FALSE does not necessarily imply an error)
- */
-gboolean       modest_account_mgr_get_bool       (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key,
-                                                  gboolean server_account);
-
-/**
- * modest_account_mgr_get_list:
- * @self: a ModestAccountMgr instance
- * @name: the name of the account
- * @key: the key of the value to get
- * @list_type: the type of the members of the list
- * @server_account: if TRUE, this is a server account
- * 
- * get a config list of values of type @list_type of an account
- *
- * Returns: a newly allocated list of elements
- */
-GSList*                modest_account_mgr_get_list       (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key,
-                                                  ModestConfValueType list_type,
-                                                  gboolean server_account);
-
-/**
- * modest_account_mgr_set_string:
- * @self: a ModestAccountMgr instance
- * @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
- * 
- * set a config string for an account.
- *
- * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
- */
-gboolean       modest_account_mgr_set_string     (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key, const gchar* val,
-                                                  gboolean server_account);
-
+gboolean       modest_account_mgr_account_with_display_name_exists (ModestAccountMgr *self,
+                                                                    const gchar *display_name);
 
 /**
- * modest_account_mgr_set_password:
- * @self: a ModestAccountMgr instance
- * @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
- * 
- * set a password for an account.
+ * modest_account_mgr_check_already_configured_account:
+ * @self: a #ModestAccountMgr
+ * @settings: a #ModestAccountSettings *settings
  *
- * 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_password     (ModestAccountMgr *self,
-                                                    const gchar *name,
-                                                    const gchar *key, const gchar* val,
-                                                    gboolean server_account);
-
-/**
- * modest_account_mgr_set_int:
- * @self: a ModestAccountMgr instance
- * @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
- * 
- * set a config int for an account
- *
- * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
- */
-gboolean       modest_account_mgr_set_int        (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key, gint val,
-                                                  gboolean server_account);
-
-/**
- * modest_account_mgr_set_bool:
- * @self: a ModestAccountMgr instance
- * @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
- * 
- * set a config bool for an account
- *
- * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
- */
-gboolean       modest_account_mgr_set_bool       (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key, gboolean val,
-                                                  gboolean server_account);
-
-/**
- * modest_account_mgr_set_list:
- * @self: a ModestAccountMgr instance
- * @name: the name of the account
- * @key: the key of the value to set
- * @val: the list with the values to set
- * @list_type: the type of the members of the list
- * @server_account: if TRUE, this is a server account
+ * Checks if there's already an active store account with the same settings
  *
- * * set a config list of values of type @list_type of an account
- * 
- * returns TRUE if this succeeded, FALSE otherwise 
+ * Returns: %TRUE if account setup exists
  */
-gboolean               modest_account_mgr_set_list       (ModestAccountMgr *self,
-                                                          const gchar *name,
-                                                          const gchar *key,
-                                                          GSList *val,
-                                                          ModestConfValueType list_type,
-                                                          gboolean server_account);
+gboolean        modest_account_mgr_check_already_configured_account (ModestAccountMgr * self,
+                                                                    ModestAccountSettings *settings);
 
 /**
  * modest_account_mgr_unset:
@@ -456,9 +314,52 @@ void modest_account_mgr_set_account_busy(ModestAccountMgr* self, const gchar* ac
  * Returns: If the account is currently busy or not
  *
  */
-gboolean
-modest_account_mgr_account_is_busy(ModestAccountMgr* self, const gchar* account_name);
+gboolean modest_account_mgr_account_is_busy (ModestAccountMgr* self, 
+                                            const gchar* account_name);
+
+
+void modest_account_mgr_notify_account_update (ModestAccountMgr* self, 
+                                              const gchar *server_account_name);
+
+/**
+ * modest_account_mgr_set_default_account:
+ * @self: a ModestAccountMgr instance
+ * @account: the name of an existing account
+ * 
+ * set the default account name (which must be valid account)
+ *
+ * Returns: TRUE if succeeded, FALSE otherwise
+ */
+gboolean modest_account_mgr_set_default_account  (ModestAccountMgr *self,
+                                                 const gchar* account);
+
+/**
+ * modest_account_mgr_get_default_account:
+ * @self: a ModestAccountMgr instance
+ * 
+ * get the default account name, or NULL if none is found
+ *
+ * Returns: the default account name (as newly allocated string, which
+ * must be g_free'd), or NULL
+ */
+gchar* modest_account_mgr_get_default_account  (ModestAccountMgr *self);
+
+/**
+ * modest_account_mgr_get_display_name:
+ * @self: a ModestAccountMgr instance
+ * @name: the account name to check
+ *
+ * Return the human-readable account title for this account, or NULL.
+ */
+gchar* modest_account_mgr_get_display_name (ModestAccountMgr *self, 
+                                           const gchar* name);
+
+void  modest_account_mgr_set_display_name (ModestAccountMgr *self, 
+                                          const gchar *account_name,
+                                          const gchar *display_name);
 
+gboolean modest_account_mgr_singleton_protocol_exists (ModestAccountMgr *mgr,
+                                                      ModestProtocolType protocol_type);
 
 G_END_DECLS