1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #ifndef __MODEST_CONF_H__
31 #define __MODEST_CONF_H__
33 #include <glib-object.h>
34 #include "modest-defs.h"
38 /* convenience macros */
39 #define MODEST_TYPE_CONF (modest_conf_get_type())
40 #define MODEST_CONF(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_CONF,ModestConf))
41 #define MODEST_CONF_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_CONF,GObject))
42 #define MODEST_IS_CONF(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_CONF))
43 #define MODEST_IS_CONF_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_CONF))
44 #define MODEST_CONF_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_CONF,ModestConfClass))
46 typedef struct _ModestConf ModestConf;
47 typedef struct _ModestConfClass ModestConfClass;
50 MODEST_CONF_VALUE_INT,
51 MODEST_CONF_VALUE_BOOL,
52 MODEST_CONF_VALUE_FLOAT,
53 MODEST_CONF_VALUE_STRING
54 } ModestConfValueType;
57 MODEST_CONF_EVENT_KEY_CHANGED,
58 MODEST_CONF_EVENT_KEY_UNSET
65 struct _ModestConfClass {
66 GObjectClass parent_class;
67 void (* key_changed) (ModestConf* self, const gchar *key, ModestConfEvent event);
71 * modest_conf_get_type:
73 * get the #GType for #ModestConf
77 GType modest_conf_get_type (void) G_GNUC_CONST;
83 * create a new modest #ModestConf object.
85 * Returns: a new #ModestConf instance, or NULL in case
88 ModestConf* modest_conf_new (void);
92 * modest_conf_get_string:
93 * @self: a ModestConf instance
94 * @key: the key of the value to retrieve
95 * @err: a GError ptr, or NULL to ignore.
97 * get a string from the configuration system
99 * Returns: a newly allocated string with the value for the key,
100 * or NULL in case of error. @err gives details in case of error
102 gchar* modest_conf_get_string (ModestConf* self, const gchar* key, GError **err);
106 * modest_conf_get_int:
107 * @self: a ModestConf instance
108 * @key: the key of the value to retrieve
109 * @err: a GError ptr, or NULL to ignore.
111 * get an integer from the configuration system
113 * Returns: an integer with the value for the key, or -1 in case of error
114 * (of course, -1 can also be returned in non-error cases).
115 * @err gives details in case of error
117 gint modest_conf_get_int (ModestConf* self, const gchar* key, GError **err);
121 * modest_conf_get_bool:
122 * @self: a ModestConf instance
123 * @key: the key of the value to retrieve
124 * @err: a GError ptr, or NULL to ignore.
126 * get a boolean value from the configuration system
128 * Returns: a boolean value with the value for the key, or FALSE in case of error
129 * (of course, FALSE can also be returned in non-error cases).
130 * @err gives details in case of error
132 gboolean modest_conf_get_bool (ModestConf* self, const gchar* key, GError **err);
136 * modest_conf_get_list:
137 * @self: a ModestConf instance
138 * @key: the key of the value to retrieve
139 * @list_type: the type of the elements of the list
140 * @err: a GError ptr, or NULL to ignore.
142 * get a list of values from the configuration system
144 * Returns: a list with the values for the key, or NULL in case of error
145 * @err gives details in case of error
147 GSList* modest_conf_get_list (ModestConf* self, const gchar* key,
148 ModestConfValueType list_type, GError **err);
151 * modest_conf_set_string:
152 * @self: a ModestConf instance
153 * @key: the key of the value to set
154 * @val: the value to set
155 * @err: a GError ptr, or NULL if not interested.
157 * store a string value in the configuration system
159 * Returns: TRUE if succeeded or FALSE in case of error.
160 * @err gives details in case of error
162 gboolean modest_conf_set_string (ModestConf* self, const gchar* key, const gchar *val,
166 * modest_conf_set_int:
167 * @self: a ModestConf instance
168 * @key: the key of the value to set
169 * @val: the value to set
170 * @err: a GError ptr, or NULL if not interested.
172 * store an integer value in the configuration system
174 * Returns: TRUE if succeeded or FALSE in case of error.
175 * @err gives details in case of error
177 gboolean modest_conf_set_int (ModestConf* self, const gchar* key, int val,
181 * modest_conf_set_bool:
182 * @self: a ModestConf instance
183 * @key: the key of the value to set
184 * @val: the value to set
185 * @err: a GError ptr, or NULL if not interested.
187 * store a boolean value in the configuration system
189 * Returns: TRUE if succeeded or FALSE in case of error.
190 * @err gives details in case of error
192 gboolean modest_conf_set_bool (ModestConf* self, const gchar* key, gboolean val,
197 * modest_conf_set_list:
198 * @self: a ModestConf instance
199 * @key: the key of the value to retrieve
200 * @val: the list with the values to set
201 * @list_type: the type of the elements of the list
202 * @err: a GError ptr, or NULL to ignore.
204 * set a list of values in the configuration system
206 * Returns: TRUE if succeeded or FALSE in case of error.
207 * @err gives details in case of error
209 gboolean modest_conf_set_list (ModestConf* self, const gchar* key,
210 GSList *val, ModestConfValueType list_type,
215 * modest_conf_list_subkeys:
216 * @self: a ModestConf instance
217 * @key: the key whose subkeys will be listed
218 * @err: a GError ptr, or NULL if not interested.
220 * list all the subkeys for a given key
222 * Returns: a newly allocated list or NULL in case of error
223 * the returned GSList must be freed by the caller
224 * @err might give details in case of error
226 GSList* modest_conf_list_subkeys (ModestConf* self, const gchar* key,
231 * modest_conf_remove_key:
232 * @self: a ModestConf instance
233 * @key: the key to remove
234 * @err: a GError ptr, or NULL if not interested.
236 * attempts to remove @key and all its subkeys
238 * Returns: TRUE if succeeded or FALSE in case of error.
239 * @err might give details in case of error
241 gboolean modest_conf_remove_key (ModestConf* self, const gchar* key, GError **err);
245 * modest_conf_key_exists:
246 * @self: a ModestConf instance
247 * @key: the key to remove
248 * @err: a GError ptr, or NULL if not interested.
250 * checks if the given key exists in the configuration system
252 * Returns: TRUE if it exists, FALSE otherwise.
253 * @err gives details in case of error
255 gboolean modest_conf_key_exists (ModestConf* self, const gchar* key, GError **err);
260 * modest_conf_key_valid:
263 * check whether @str is a valid key in the config system
264 * This is a *class* function, and therefore does not require a ModestConf
267 * Returns: TRUE if it is valid, FALSE otherwise
269 gboolean modest_conf_key_is_valid (const gchar* str);
273 * modest_conf_key_escape:
274 * @str: a non-empty string to escape
276 * returns an escaped version of @str, ie. something suitable as a key
277 * This is a *class* function, and therefore does not require a ModestConf
278 * instance. Note: this for is invidual elements in a key
280 * Returns: a newly allocated string with the escaped version
282 gchar* modest_conf_key_escape (const gchar* str);
286 * modest_conf_key_escape:
287 * @str: a string to escape
289 * returns an unescaped version of @str. This is a *class* function, and
290 * therefore does not require a ModestConf instance
291 * Note: this for is invidual elements in a key
293 * Returns: a newly allocated string with the unescaped version
295 gchar* modest_conf_key_unescape (const gchar* str);
300 #endif /* __MODEST_CONF_H__ */