-/*
- * 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__
#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; */
+/* typedef enum _ModestConfValueType ModestConfValueType; */
+
+typedef enum _ModestConfValueType {
+ MODEST_CONF_VALUE_INT,
+ MODEST_CONF_VALUE_BOOL,
+ MODEST_CONF_VALUE_FLOAT,
+ MODEST_CONF_VALUE_STRING
+} ModestConfValueType;
+
+typedef enum _ModestConfEvent {
+ MODEST_CONF_EVENT_KEY_CHANGED,
+ MODEST_CONF_EVENT_KEY_UNSET
+} 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);
};
-
/**
* modest_conf_get_type:
*
* Returns: a new ModestConf instance, or NULL in case
* of any error
*/
-GObject* modest_conf_new (void);
+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_string_or_default:
+ * @self: a ModestConf instance
+ * @key: the key of the value to retrieve
+ * @err: a GError ptr, or NULL to ignore.
+ *
+ * get a string from the configuration system; if the value is not set,
+ * or some error occurs, return @defaultval (copied)
+ *
+ * Returns: a newly allocated string with the value for the key,
+ * or the @defaultval in case of any error
+ */
+gchar* modest_conf_get_string_or_default (ModestConf* self, const gchar* key,
+ const gchar *defaultval);
+
+
+/**
+ * modest_conf_get_int_or_default:
+ * @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; if the value is not set,
+ * or some error occurs, return @defaultval.
+ *
+ * Returns: an integer with the value for the key, or the @defaultval in case
+ * of any error
+ */
+gint modest_conf_get_int_or_default (ModestConf* self, const gchar* key,
+ int defaultval);
+
+
/**
* modest_conf_set_string:
* @self: a ModestConf instance
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);
+
+
+GSList* modest_conf_get_list (ModestConf* self, const gchar* key, ModestConfValueType list_type, GError **err);
+
G_END_DECLS
#endif /* __MODEST_CONF_H__ */
projects / modest / blobdiff