X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-conf.h;h=759d6200baf0ebd3d8e3a5fc99aa89a17395c422;hp=895ee2b004defc2e5fd89a93b8d7d189bd2f930f;hb=e45958deaf9701399c552ea0d84c2447efacd4ca;hpb=ce20de84bc90c7a0f8f57b511d0a743efbbe4c9b diff --git a/src/modest-conf.h b/src/modest-conf.h index 895ee2b..759d620 100644 --- a/src/modest-conf.h +++ b/src/modest-conf.h @@ -31,7 +31,6 @@ #define __MODEST_CONF_H__ #include -#include "modest-conf-keys.h" G_BEGIN_DECLS @@ -45,7 +44,20 @@ G_BEGIN_DECLS typedef struct _ModestConf ModestConf; typedef struct _ModestConfClass ModestConfClass; -typedef enum _ModestConfEvent ModestConfEvent; + +typedef guint ModestConfNotificationId; + +typedef enum { + MODEST_CONF_VALUE_INT, + MODEST_CONF_VALUE_BOOL, + MODEST_CONF_VALUE_FLOAT, + MODEST_CONF_VALUE_STRING +} ModestConfValueType; + +typedef enum { + MODEST_CONF_EVENT_KEY_CHANGED, + MODEST_CONF_EVENT_KEY_UNSET +} ModestConfEvent; struct _ModestConf { GObject parent; @@ -53,20 +65,18 @@ struct _ModestConf { struct _ModestConfClass { GObjectClass parent_class; - void (* key_changed) (ModestConf* self, const gchar *key, ModestConfEvent event); -}; - -enum _ModestConfEvent { - MODEST_CONF_EVENT_KEY_CHANGED, - MODEST_CONF_EVENT_KEY_UNSET + void (* key_changed) (ModestConf* self, + const gchar *key, + ModestConfEvent event, + ModestConfNotificationId id); }; /** * modest_conf_get_type: * - * get the GType for ModestConf + * get the #GType for #ModestConf * - * Returns: the GType + * Returns: the #GType */ GType modest_conf_get_type (void) G_GNUC_CONST; @@ -74,12 +84,12 @@ GType modest_conf_get_type (void) G_GNUC_CONST; /** * modest_conf_new: * - * create a new modest ModestConf object. + * create a new modest #ModestConf object. * - * Returns: a new ModestConf instance, or NULL in case + * Returns: a new #ModestConf instance, or NULL in case * of any error */ -GObject* modest_conf_new (void); +ModestConf* modest_conf_new (void); /** @@ -108,8 +118,21 @@ gchar* modest_conf_get_string (ModestConf* self, const gchar* key, GError * (of course, -1 can also be returned in non-error cases). * @err gives details in case of error */ -int modest_conf_get_int (ModestConf* self, const gchar* key, GError **err); +gint modest_conf_get_int (ModestConf* self, const gchar* key, GError **err); +/** + * modest_conf_get_float: + * @self: a ModestConf instance + * @key: the key of the value to retrieve + * @err: a GError ptr, or NULL to ignore. + * + * get an integer from the configuration system + * + * Returns: an double with the value for the key, or -1 in case of + * error (of course, -1 can also be returned in non-error cases). + * @err gives details in case of error + */ +gdouble modest_conf_get_float (ModestConf* self, const gchar* key, GError **err); /** * modest_conf_get_bool: @@ -119,13 +142,28 @@ int modest_conf_get_int (ModestConf* self, const gchar* key, GError * * get a boolean value from the configuration system * - * Returns: a boolean value with the value for the key, or -1 in case of error - * (of course, -1 can also be returned in non-error cases). + * Returns: a boolean value with the value for the key, or FALSE in case of error + * (of course, FALSE can also be returned in non-error cases). * @err gives details in case of error */ gboolean modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err); +/** + * modest_conf_get_list: + * @self: a ModestConf instance + * @key: the key of the value to retrieve + * @list_type: the type of the elements of the list + * @err: a GError ptr, or NULL to ignore. + * + * get a list of values from the configuration system + * + * Returns: a list with the values for the key, or NULL in case of error + * @err gives details in case of error + */ +GSList* modest_conf_get_list (ModestConf* self, const gchar* key, + ModestConfValueType list_type, GError **err); + /** * modest_conf_set_string: * @self: a ModestConf instance @@ -157,6 +195,23 @@ gboolean modest_conf_set_int (ModestConf* self, const gchar* key, int val GError **err); /** + * modest_conf_set_float: + * @self: a ModestConf instance + * @key: the key of the value to set + * @val: the value to set + * @err: a GError ptr, or NULL if not interested. + * + * store an integer value in the configuration system + * + * Returns: TRUE if succeeded or FALSE in case of error. + * @err gives details in case of error + */ +gboolean modest_conf_set_float (ModestConf* self, + const gchar* key, + gdouble val, + GError **err); + +/** * modest_conf_set_bool: * @self: a ModestConf instance * @key: the key of the value to set @@ -172,6 +227,24 @@ gboolean modest_conf_set_bool (ModestConf* self, const gchar* key, gboole GError **err); +/** + * modest_conf_set_list: + * @self: a ModestConf instance + * @key: the key of the value to retrieve + * @val: the list with the values to set + * @list_type: the type of the elements of the list + * @err: a GError ptr, or NULL to ignore. + * + * set a list of values in the configuration system + * + * Returns: TRUE if succeeded or FALSE in case of error. + * @err gives details in case of error + */ +gboolean modest_conf_set_list (ModestConf* self, const gchar* key, + GSList *val, ModestConfValueType list_type, + GError **err); + + /** * modest_conf_list_subkeys: * @self: a ModestConf instance @@ -182,7 +255,7 @@ gboolean modest_conf_set_bool (ModestConf* self, const gchar* key, gboole * * Returns: a newly allocated list or NULL in case of error * the returned GSList must be freed by the caller - * @err gives details in case of error + * @err might give details in case of error */ GSList* modest_conf_list_subkeys (ModestConf* self, const gchar* key, GError **err); @@ -197,7 +270,7 @@ GSList* modest_conf_list_subkeys (ModestConf* self, const gchar* key, * attempts to remove @key and all its subkeys * * Returns: TRUE if succeeded or FALSE in case of error. - * @err gives details in case of error + * @err might give details in case of error */ gboolean modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err); @@ -216,6 +289,51 @@ gboolean modest_conf_remove_key (ModestConf* self, const gchar* key, GError gboolean modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err); + +/** + * modest_conf_key_valid: + * @str: some key + * + * check whether @str is a valid key in the config system + * This is a *class* function, and therefore does not require a ModestConf + * instance + * + * Returns: TRUE if it is valid, FALSE otherwise + */ +gboolean modest_conf_key_is_valid (const gchar* str); + + +/** + * modest_conf_key_escape: + * @str: a non-empty string to escape + * + * returns an escaped version of @str, ie. something suitable as a key + * This is a *class* function, and therefore does not require a ModestConf + * instance. Note: this for is invidual elements in a key + * + * Returns: a newly allocated string with the escaped version + */ +gchar* modest_conf_key_escape (const gchar* str); + + +/** + * modest_conf_key_escape: + * @str: a string to escape + * + * returns an unescaped version of @str. This is a *class* function, and + * therefore does not require a ModestConf instance + * Note: this for is invidual elements in a key + * + * Returns: a newly allocated string with the unescaped version + */ +gchar* modest_conf_key_unescape (const gchar* str); + + +void modest_conf_listen_to_namespace (ModestConf *self, + const gchar *namespace); + +void modest_conf_forget_namespace (ModestConf *self, + const gchar *namespace); G_END_DECLS #endif /* __MODEST_CONF_H__ */