* added modest_conf_key_escape and modest_conf_key_unescape, to

[modest] / src / modest-conf.h

diff --git a/src/modest-conf.h b/src/modest-conf.h
index 16cf275..f99e545 100644 (file)
--- a/src/modest-conf.h
+++ b/src/modest-conf.h
@@ -1,5 +1,30 @@
-/*
- * modest-conf.h
+/* 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_CONF_H__
@@ -18,19 +43,23 @@ G_BEGIN_DECLS
 #define MODEST_IS_CONF_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_CONF))
 #define MODEST_CONF_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_CONF,ModestConfClass))
 
-typedef struct _ModestConf      ModestConf;
-typedef struct _ModestConfClass ModestConfClass;
+typedef struct _ModestConf        ModestConf;
+typedef struct _ModestConfClass   ModestConfClass;
+typedef enum   _ModestConfEvent   ModestConfEvent;
 
 struct _ModestConf {
         GObject parent;
 };
 
 struct _ModestConfClass {
-       GObjectClass parent_class;
-       /* insert signal callback declarations, eg. */
-       /* void (* my_event) (ModestConf* obj); */
+       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
+};
 
 /**
  * modest_conf_get_type:
@@ -55,7 +84,7 @@ GObject*     modest_conf_new         (void);
 
 /**
  * modest_conf_get_string:
- * @self: self a ModestConf instance
+ * @self: a ModestConf instance
  * @key: the key of the value to retrieve
  * @err: a GError ptr, or NULL to ignore.
  * 
@@ -69,7 +98,7 @@ gchar*       modest_conf_get_string  (ModestConf* self, const gchar* key, GError
 
 /** 
  * modest_conf_get_int:
- * @self: self a ModestConf instance
+ * @self: a ModestConf instance
  * @key: the key of the value to retrieve
  * @err: a GError ptr, or NULL to ignore.
  * 
@@ -84,7 +113,7 @@ int          modest_conf_get_int     (ModestConf* self, const gchar* key, GError
 
 /** 
  * modest_conf_get_bool:
- * @self: self a ModestConf instance
+ * @self: a ModestConf instance
  * @key: the key of the value to retrieve
  * @err: a GError ptr, or NULL to ignore.
  * 
@@ -181,12 +210,37 @@ gboolean   modest_conf_remove_key    (ModestConf* self, const gchar* key, GError
  *
  * checks if the given key exists in the configuration system
  * 
- * Returns: TRUE if exists, FALSE otherwise.
+ * Returns: TRUE if it exists, FALSE otherwise.
  * @err gives details in case of error
  */
 gboolean   modest_conf_key_exists   (ModestConf* self, const gchar* key, GError **err);
 
 
+/**
+ * modest_conf_key_escape:
+ * @self: a ModestConf instance. Not used, but for consistency with other ModestConf funcs
+ * @str: a string to escape
+ *
+ * returns an escaped version of @str, ie. something suitable as a key
+ * 
+ * Returns: a newly allocated string with the escaped version
+ */
+gchar* modest_conf_key_escape (ModestConf *self, 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: a newly allocated string with the unescaped version
+ */
+gchar* modest_conf_key_unescape (ModestConf *self, const gchar* str);
+
+
+
 G_END_DECLS
 
 #endif /* __MODEST_CONF_H__ */