X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-account-mgr.h;h=e6cba5b979687fca439fb59da2e40bdc3e5eddfc;hp=f0506351f0339292467d37dd17033ffa00391e99;hb=fe08542c7e5346dc7e08fa67705bccce1c0a9229;hpb=434ec10090daec7d9d80c1f419b9113d15d58fd4 diff --git a/src/modest-account-mgr.h b/src/modest-account-mgr.h index f050635..e6cba5b 100644 --- a/src/modest-account-mgr.h +++ b/src/modest-account-mgr.h @@ -1,5 +1,32 @@ -/* modest-account-mgr.h */ -/* insert (c)/licensing information) */ +/* Copyright (c) 2006, Nokia Corporation + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of the Nokia Corporation nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS + * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A + * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER + * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + #ifndef __MODEST_ACCOUNT_MGR_H__ #define __MODEST_ACCOUNT_MGR_H__ @@ -14,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)) @@ -23,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); }; @@ -60,8 +87,8 @@ GObject* modest_account_mgr_new (ModestConf *modest_conf); * modest_account_mgr_add_account: * @self: a ModestAccountMgr instance * @name: the name of the account to create - * @store: the store account (ie. POP/IMAP) - * @transport: the transport account (ie. sendmail/SMTP) + * @store_name: the store account (ie. POP/IMAP) + * @transport_name: the transport account (ie. sendmail/SMTP) * @err: a GError ptr, or NULL to ignore. * * create a new account. the account with @name should not already exist @@ -74,36 +101,21 @@ 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); - /** * modest_account_mgr_add_server_account: * @self: a ModestAccountMgr instance + * @name: name (id) of the account * @hostname: the hostname * @username: the username * @password: the password - * @proto: the prototype - * @err: a GError ptr, or NULL to ignore. + * @proto: the protocol (imap, smtp, ...) used for this account * - * add a server account to the configuration + * add a server account to the configuration. * the server account with @name should not already exist - * - * Returns: TRUE if succeeded, FALSE otherwise, - * @err gives details in case of error + * + * Returns: TRUE if succeeded, FALSE otherwise, */ gboolean modest_account_mgr_add_server_account (ModestAccountMgr *self, const gchar *name, @@ -113,20 +125,20 @@ 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 + * @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); /** @@ -149,34 +161,82 @@ GSList* modest_account_mgr_account_names (ModestAccountMgr *self, GEr * @account_name: get only server accounts for @account_name, or NULL for any * @type: get only server accounts from protocol type @type, or MODEST_PROTO_TYPE_ANY * @proto: get only server account with protocol @proto, or NULL for any - * @only_enable: get only enable server account if TRUE + * @only_enabled: get only enabled server accounts if TRUE * * list all the server 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 */ -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 * - * Returns: TRUE if the account exists, FALSE otherwise (or in case of error) + * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error) * @err gives details in case of error */ gboolean modest_account_mgr_account_exists (ModestAccountMgr *self, const gchar *name, + gboolean server_account, GError **err); -/* account specific functions */ + +/** + * 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); + @@ -185,105 +245,122 @@ gboolean modest_account_mgr_account_exists (ModestAccountMgr *self, * @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 some 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. @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); + + /** * modest_account_mgr_get_account_int: - * @self: self a ModestAccountMgr instance + * @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 some 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) * @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_int (ModestAccountMgr *self, + const gchar *name, + const gchar *key, + gboolean server_account, + GError **err); /** * modest_account_mgr_get_account_bool: - * @self: self a ModestAccountMgr instance + * @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 some 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) * @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_bool (ModestAccountMgr *self, + const gchar *name, + const gchar *key, + gboolean server_account, + GError **err); /** * modest_account_mgr_set_account_string: - * @self: self a ModestAccountMgr instance + * @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 * @err: a GError ptr, or NULL to ignore. * - * set a config string for some account + * set a config string 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_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: - * @self: self a ModestAccountMgr instance + * @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 * @err: a GError ptr, or NULL to ignore. * - * set a config int for some account + * set a config int 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_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); + /** * modest_account_mgr_set_account_bool: - * @self: self a ModestAccountMgr instance + * @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 * @err: a GError ptr, or NULL to ignore. * - * set a config bool for some account + * set a config bool 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_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 #endif /* __MODEST_ACCOUNT_MGR_H__ */ -