2 * Copyright © 2009, 2010 Codethink Limited
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the licence, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Author: Ryan Lortie <desrt@desrt.ca>
22 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
23 #error "Only <gio/gio.h> can be included directly."
26 #ifndef __G_SETTINGS_H__
27 #define __G_SETTINGS_H__
29 #include <gio/giotypes.h>
33 #define G_TYPE_SETTINGS (g_settings_get_type ())
34 #define G_SETTINGS(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
35 G_TYPE_SETTINGS, GSettings))
36 #define G_SETTINGS_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), \
37 G_TYPE_SETTINGS, GSettingsClass))
38 #define G_IS_SETTINGS(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), G_TYPE_SETTINGS))
39 #define G_IS_SETTINGS_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_SETTINGS))
40 #define G_SETTINGS_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), \
41 G_TYPE_SETTINGS, GSettingsClass))
43 typedef struct _GSettingsPrivate GSettingsPrivate;
44 typedef struct _GSettingsClass GSettingsClass;
46 struct _GSettingsClass
48 GObjectClass parent_class;
51 void (*writable_changed) (GSettings *settings,
53 void (*changed) (GSettings *settings,
55 gboolean (*writable_change_event) (GSettings *settings,
57 gboolean (*change_event) (GSettings *settings,
66 GObject parent_instance;
67 GSettingsPrivate *priv;
71 GType g_settings_get_type (void);
73 const gchar * const * g_settings_list_schemas (void);
74 const gchar * const * g_settings_list_relocatable_schemas (void);
75 GSettings * g_settings_new (const gchar *schema);
76 GSettings * g_settings_new_with_path (const gchar *schema,
78 GSettings * g_settings_new_with_backend (const gchar *schema,
79 GSettingsBackend *backend);
80 GSettings * g_settings_new_with_backend_and_path (const gchar *schema,
81 GSettingsBackend *backend,
83 gchar ** g_settings_list_children (GSettings *settings);
84 gchar ** g_settings_list_keys (GSettings *settings);
85 GVariant * g_settings_get_range (GSettings *settings,
87 gboolean g_settings_range_check (GSettings *settings,
91 gboolean g_settings_set_value (GSettings *settings,
94 GVariant * g_settings_get_value (GSettings *settings,
97 gboolean g_settings_set (GSettings *settings,
101 void g_settings_get (GSettings *settings,
105 void g_settings_reset (GSettings *settings,
108 gint g_settings_get_int (GSettings *settings,
110 gboolean g_settings_set_int (GSettings *settings,
113 gchar * g_settings_get_string (GSettings *settings,
115 gboolean g_settings_set_string (GSettings *settings,
118 gboolean g_settings_get_boolean (GSettings *settings,
120 gboolean g_settings_set_boolean (GSettings *settings,
123 gdouble g_settings_get_double (GSettings *settings,
125 gboolean g_settings_set_double (GSettings *settings,
128 gchar ** g_settings_get_strv (GSettings *settings,
130 gboolean g_settings_set_strv (GSettings *settings,
132 const gchar *const *value);
133 gint g_settings_get_enum (GSettings *settings,
135 gboolean g_settings_set_enum (GSettings *settings,
138 guint g_settings_get_flags (GSettings *settings,
140 gboolean g_settings_set_flags (GSettings *settings,
143 GSettings * g_settings_get_child (GSettings *settings,
146 gboolean g_settings_is_writable (GSettings *settings,
149 void g_settings_delay (GSettings *settings);
150 void g_settings_apply (GSettings *settings);
151 void g_settings_revert (GSettings *settings);
152 gboolean g_settings_get_has_unapplied (GSettings *settings);
153 void g_settings_sync (void);
156 * GSettingsBindSetMapping:
157 * @value: a #GValue containing the property value to map
158 * @expected_type: the #GVariantType to create
159 * @user_data: user data that was specified when the binding was created
160 * @returns: a new #GVariant holding the data from @value,
161 * or %NULL in case of an error
163 * The type for the function that is used to convert an object property
164 * value to a #GVariant for storing it in #GSettings.
166 typedef GVariant * (*GSettingsBindSetMapping) (const GValue *value,
167 const GVariantType *expected_type,
171 * GSettingsBindGetMapping:
172 * @value: return location for the property value
173 * @variant: the #GVariant
174 * @user_data: user data that was specified when the binding was created
175 * @returns: %TRUE if the conversion succeeded, %FALSE in case of an error
177 * The type for the function that is used to convert from #GSettings to
178 * an object property. The @value is already initialized to hold values
179 * of the appropriate type.
181 typedef gboolean (*GSettingsBindGetMapping) (GValue *value,
186 * GSettingsGetMapping:
187 * @value: the #GVariant to map, or %NULL
188 * @result: the result of the mapping
189 * @user_data: the user data that was passed to g_settings_get_mapped()
190 * @returns: %TRUE if the conversion succeeded, %FALSE in case of an error
192 * The type of the function that is used to convert from a value stored
193 * in a #GSettings to a value that is useful to the application.
195 * If the value is successfully mapped, the result should be stored at
196 * @result and %TRUE returned. If mapping fails (for example, if @value
197 * is not in the right format) then %FALSE should be returned.
199 * If @value is %NULL then it means that the mapping function is being
200 * given a "last chance" to successfully return a valid value. %TRUE
201 * must be returned in this case.
203 typedef gboolean (*GSettingsGetMapping) (GVariant *value,
208 * GSettingsBindFlags:
209 * @G_SETTINGS_BIND_DEFAULT: Equivalent to <literal>G_SETTINGS_BIND_GET|G_SETTINGS_BIND_SET</literal>
210 * @G_SETTINGS_BIND_GET: Update the #GObject property when the setting changes.
211 * It is an error to use this flag if the property is not writable.
212 * @G_SETTINGS_BIND_SET: Update the setting when the #GObject property changes.
213 * It is an error to use this flag if the property is not readable.
214 * @G_SETTINGS_BIND_NO_SENSITIVITY: Do not try to bind a "sensitivity" property to the writability of the setting
215 * @G_SETTINGS_BIND_GET_NO_CHANGES: When set in addition to #G_SETTINGS_BIND_GET, set the #GObject property
216 * value initially from the setting, but do not listen for changes of the setting
217 * @G_SETTINGS_BIND_INVERT_BOOLEAN: When passed to g_settings_bind(), uses a pair of mapping functions that invert
218 * the boolean value when mapping between the setting and the property. The setting and property must both
219 * be booleans. You can not pass this flag to g_settings_bind_with_mapping().
221 * Flags used when creating a binding. These flags determine in which
222 * direction the binding works. The default is to synchronize in both
227 G_SETTINGS_BIND_DEFAULT,
228 G_SETTINGS_BIND_GET = (1<<0),
229 G_SETTINGS_BIND_SET = (1<<1),
230 G_SETTINGS_BIND_NO_SENSITIVITY = (1<<2),
231 G_SETTINGS_BIND_GET_NO_CHANGES = (1<<3),
232 G_SETTINGS_BIND_INVERT_BOOLEAN = (1<<4)
233 } GSettingsBindFlags;
235 void g_settings_bind (GSettings *settings,
238 const gchar *property,
239 GSettingsBindFlags flags);
240 void g_settings_bind_with_mapping (GSettings *settings,
243 const gchar *property,
244 GSettingsBindFlags flags,
245 GSettingsBindGetMapping get_mapping,
246 GSettingsBindSetMapping set_mapping,
248 GDestroyNotify destroy);
249 void g_settings_bind_writable (GSettings *settings,
252 const gchar *property,
254 void g_settings_unbind (gpointer object,
255 const gchar *property);
257 gpointer g_settings_get_mapped (GSettings *settings,
259 GSettingsGetMapping mapping,
264 #endif /* __G_SETTINGS_H__ */