#define __MODEST_CONF_H__
#include <glib-object.h>
-#include "modest-conf-keys.h"
+#include "modest-defs.h"
G_BEGIN_DECLS
typedef struct _ModestConf ModestConf;
typedef struct _ModestConfClass ModestConfClass;
-typedef enum _ModestConfEvent ModestConfEvent;
-enum _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;
struct _ModestConfClass {
GObjectClass parent_class;
- void (* key_changed) (ModestConf* self, const gchar *key, ModestConfEvent event);
+ 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;
/**
* 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
*/
ModestConf* modest_conf_new (void);
* (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);
/**
*
* 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
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
*
* 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);
* 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);
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:
- * @self: a ModestConf instance. Not used, but for consistency with other ModestConf funcs
- * @str: a string to 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 (ModestConf *self, const gchar* str);
+gchar* modest_conf_key_escape (const gchar* str);
/**
* modest_conf_key_escape:
- * @self: a ModestConf instance. Not used, but for consistency with other ModestConf funcs
* @str: a string to escape
*
- * returns an unescaped version of @str
+ * 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 (ModestConf *self, const gchar* str);
+gchar* modest_conf_key_unescape (const gchar* str);
+
+ModestConfNotificationId modest_conf_listen_to_namespace (ModestConf *self,
+ const gchar *namespace);
+void modest_conf_forget_namespace (ModestConf *self,
+ const gchar *namespace,
+ ModestConfNotificationId id);
G_END_DECLS
projects / modest / blobdiff