X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-account-mgr.h;h=679c97d1c17d68c5167a5e7d5e1328a12594445f;hp=aaf5c06dbecf0272f6fd458f98c9f6c7bc051ff9;hb=4d39841513a3a7f7aa9d38ab97cb9fcc9171e80b;hpb=6ebc23126acdfb8aec11416e4c197c6bee70bef0 diff --git a/src/modest-account-mgr.h b/src/modest-account-mgr.h index aaf5c06..679c97d 100644 --- a/src/modest-account-mgr.h +++ b/src/modest-account-mgr.h @@ -33,8 +33,8 @@ #include #include -#include -#include +#include +#include G_BEGIN_DECLS @@ -56,20 +56,33 @@ struct _ModestAccountMgr { struct _ModestAccountMgrClass { GObjectClass parent_class; - void (* account_removed) (ModestAccountMgr *obj, + void (* account_inserted) (ModestAccountMgr *obj, const gchar* account, - gboolean server_account, gpointer user_data); - void (* account_changed) (ModestAccountMgr *obj, + + void (* account_removed) (ModestAccountMgr *obj, const gchar* account, - const GSList* key, - gboolean server_account, gpointer user_data); - void (* account_busy_changed) (ModestAccountMgr *obj, + + void (* account_changed) (ModestAccountMgr *obj, const gchar* account, - gboolean busy, gpointer user_data); + + void (* account_busy_changed) (ModestAccountMgr *obj, + const gchar* account, + gboolean busy, + gpointer user_data); + + 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); }; /** @@ -93,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 '/' @@ -106,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); @@ -134,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); /** @@ -152,14 +181,13 @@ 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); /** * modest_account_mgr_remove_account: * @self: a ModestAccountMgr instance * @name: the name of the account to remove - * @server_account: TRUE if the account to remove is a server account * @err: a #GError ptr, or NULL to ignore. * * remove an existing account. the account with @name should already exist; note @@ -170,9 +198,19 @@ gboolean modest_account_mgr_add_server_account_uri (ModestAccountMgr *self, * @err gives details in case of error */ gboolean modest_account_mgr_remove_account (ModestAccountMgr *self, - const gchar* name, - gboolean server_account); + const gchar* name); +/** + * modest_account_mgr_remove_account: + * @self: a ModestAccountMgr instance + * @name: the name of the server account to remove + * + * remove an existing server account. This is only for internal use. + * + * Returns: TRUE if the operation succeeded, FALSE otherwise, + */ +gboolean modest_account_mgr_remove_server_account (ModestAccountMgr *self, + const gchar* name); /** * modest_account_mgr_account_names: @@ -184,32 +222,20 @@ gboolean modest_account_mgr_remove_account (ModestAccountMgr *sel * Returns: a newly allocated list of account names, or NULL in case of error or * if there are no accounts. The caller must free the returned GSList. * - * TODO: I believe that the caller must free the strings in the GSList items too, - * because this is implemented via gconf_client_all_dirs() which also requires a deep free, - * though that's not documented. murrayc. */ GSList* modest_account_mgr_account_names (ModestAccountMgr *self, gboolean only_enabled); -#if 0 -/* Not used. */ /** - * modest_account_mgr_search_server_account: - * @self: a ModestAccountMgr instance - * @account_name: get only server accounts for @account_name, or NULL for any - * @type: get only server accounts from protocol type @type, or MODEST_PROTOCOL_TYPE_UNKNOWN - * @proto: get only server account with protocol @proto, or MODEST_PROTOCOL_TRANSPORT_STORE_UNKNOWN for any + * modest_account_mgr_free_account_names: + * @account_name: a gslist of account names * - * List all the server account names, optionally narrowing the result down to one account. + * list all account names * - * 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 + * free the list of account names */ -GSList* modest_account_mgr_search_server_accounts (ModestAccountMgr *self, - const gchar* account_name, - ModestProtocolType type, - ModestTransportStoreProtocol proto); -#endif +void modest_account_mgr_free_account_names (GSList *account_names); + /** * modest_account_mgr_account_exists: @@ -234,186 +260,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); - +gboolean modest_account_mgr_account_with_display_name_exists (ModestAccountMgr *self, + const gchar *display_name); /** - * 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 + * modest_account_mgr_check_already_configured_account: + * @self: a #ModestAccountMgr + * @settings: a #ModestAccountSettings *settings * - * 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 + * Checks if there's already an active store account with the same settings * - * 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) + * Returns: %TRUE if account setup exists */ -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); - - -/** - * 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. - * - * 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 - * - * * set a config list of values of type @list_type of an account - * - * returns TRUE if this succeeded, FALSE otherwise - */ -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: @@ -466,10 +326,55 @@ 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); +gchar * modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name, + const gchar *key, gboolean server_account); G_END_DECLS #endif /* __MODEST_ACCOUNT_MGR_H__ */