* Fixes NB#85740, save separator position as float in order to enhace placement...

[modest] / src / modest-conf.h

diff --git a/src/modest-conf.h b/src/modest-conf.h
index e6d33b8..4cdfb57 100644 (file)
--- a/src/modest-conf.h
+++ b/src/modest-conf.h
@@ -31,7 +31,7 @@
 #define __MODEST_CONF_H__
 
 #include <glib-object.h>
-#include "modest-conf-keys.h"
+#include "modest-defs.h"
 
 G_BEGIN_DECLS
 
@@ -45,17 +45,17 @@ G_BEGIN_DECLS
 
 typedef struct _ModestConf        ModestConf;
 typedef struct _ModestConfClass   ModestConfClass;
-/* typedef enum   _ModestConfEvent   ModestConfEvent; */
-/* typedef enum   _ModestConfValueType   ModestConfValueType; */
 
-typedef enum _ModestConfValueType {
+typedef guint ModestConfNotificationId; 
+
+typedef enum {
        MODEST_CONF_VALUE_INT,
        MODEST_CONF_VALUE_BOOL,
        MODEST_CONF_VALUE_FLOAT,
        MODEST_CONF_VALUE_STRING
 } ModestConfValueType;
 
-typedef enum _ModestConfEvent {
+typedef enum {
        MODEST_CONF_EVENT_KEY_CHANGED,
        MODEST_CONF_EVENT_KEY_UNSET
 } ModestConfEvent;
@@ -66,15 +66,18 @@ struct _ModestConf {
 
 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;
 
@@ -82,9 +85,9 @@ 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);
@@ -118,6 +121,19 @@ gchar*       modest_conf_get_string  (ModestConf* self, const gchar* key, GError
  */
 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:
@@ -146,7 +162,7 @@ gboolean     modest_conf_get_bool    (ModestConf* self, const gchar* key, GError
  * 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, 
+GSList*     modest_conf_get_list    (ModestConf* self, const gchar* key, 
                                      ModestConfValueType list_type, GError **err);
 
 /**
@@ -180,6 +196,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
@@ -196,19 +229,21 @@ gboolean     modest_conf_set_bool    (ModestConf* self, const gchar* key, gboole
 
 
 /** 
- * modest_conf_get_list:
+ * 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.
  * 
- * get a list of values from the configuration system
- *  
- * Returns: a list with the values for the key, or NULL in case of error or
- * if the list is empty; @err gives details in case of error
+ * 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
  */
-GSList *     modest_conf_get_list    (ModestConf* self, const gchar* key, 
-                                     ModestConfValueType list_type, GError **err);
+gboolean     modest_conf_set_list    (ModestConf* self, const gchar* key, 
+                                     GSList *val, ModestConfValueType list_type, 
+                                     GError **err);
 
 
 /**
@@ -255,13 +290,27 @@ 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 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
+ * instance. Note: this for is invidual elements in a key
  * 
  * Returns: a newly allocated string with the escaped version
  */
@@ -274,12 +323,18 @@ gchar* modest_conf_key_escape (const gchar* 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 (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__ */