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 GSettings * g_settings_new (const gchar *schema);
75 GSettings * g_settings_new_with_path (const gchar *schema,
77 GSettings * g_settings_new_with_backend (const gchar *schema,
78 GSettingsBackend *backend);
79 GSettings * g_settings_new_with_backend_and_path (const gchar *schema,
80 GSettingsBackend *backend,
82 const gchar ** g_settings_list_items (GSettings *settings);
84 gboolean g_settings_set_value (GSettings *settings,
87 GVariant * g_settings_get_value (GSettings *settings,
90 gboolean g_settings_set (GSettings *settings,
94 void g_settings_get (GSettings *settings,
98 void g_settings_reset (GSettings *settings,
101 gint g_settings_get_int (GSettings *settings,
103 gboolean g_settings_set_int (GSettings *settings,
106 gchar * g_settings_get_string (GSettings *settings,
108 gboolean g_settings_set_string (GSettings *settings,
111 gboolean g_settings_get_boolean (GSettings *settings,
113 gboolean g_settings_set_boolean (GSettings *settings,
116 gdouble g_settings_get_double (GSettings *settings,
118 gboolean g_settings_set_double (GSettings *settings,
121 gchar ** g_settings_get_strv (GSettings *settings,
123 gboolean g_settings_set_strv (GSettings *settings,
125 const gchar *const *value);
126 gint g_settings_get_enum (GSettings *settings,
128 gboolean g_settings_set_enum (GSettings *settings,
131 guint g_settings_get_flags (GSettings *settings,
133 gboolean g_settings_set_flags (GSettings *settings,
136 GSettings * g_settings_get_child (GSettings *settings,
139 gboolean g_settings_is_writable (GSettings *settings,
142 void g_settings_delay (GSettings *settings);
143 void g_settings_apply (GSettings *settings);
144 void g_settings_revert (GSettings *settings);
145 gboolean g_settings_get_has_unapplied (GSettings *settings);
146 void g_settings_sync (void);
149 * GSettingsBindSetMapping:
150 * @value: a #GValue containing the property value to map
151 * @expected_type: the #GVariantType to create
152 * @user_data: user data that was specified when the binding was created
153 * @returns: a new #GVariant holding the data from @value,
154 * or %NULL in case of an error
156 * The type for the function that is used to convert an object property
157 * value to a #GVariant for storing it in #GSettings.
159 typedef GVariant * (*GSettingsBindSetMapping) (const GValue *value,
160 const GVariantType *expected_type,
164 * GSettingsBindGetMapping:
165 * @value: return location for the property value
166 * @variant: the #GVariant
167 * @user_data: user data that was specified when the binding was created
168 * @returns: %TRUE if the conversion succeeded, %FALSE in case of an error
170 * The type for the function that is used to convert from #GSettings to
171 * an object property. The @value is already initialized to hold values
172 * of the appropriate type.
174 typedef gboolean (*GSettingsBindGetMapping) (GValue *value,
179 * GSettingsGetMapping:
180 * @value: the #GVariant to map, or %NULL
181 * @result: the result of the mapping
182 * @user_data: the user data that was passed to g_settings_get_mapped()
183 * @returns: %TRUE if the conversion succeeded, %FALSE in case of an error
185 * The type of the function that is used to convert from a value stored
186 * in a #GSettings to a value that is useful to the application.
188 * If the value is successfully mapped, the result should be stored at
189 * @result and %TRUE returned. If mapping fails (for example, if @value
190 * is not in the right format) then %FALSE should be returned.
192 * If @value is %NULL then it means that the mapping function is being
193 * given a "last chance" to successfully return a valid value. %TRUE
194 * must be returned in this case.
196 typedef gboolean (*GSettingsGetMapping) (GVariant *value,
201 * GSettingsBindFlags:
202 * @G_SETTINGS_BIND_DEFAULT: Equivalent to <literal>G_SETTINGS_BIND_GET|G_SETTINGS_BIND_SET</literal>
203 * @G_SETTINGS_BIND_GET: Update the #GObject property when the setting changes.
204 * It is an error to use this flag if the property is not writable.
205 * @G_SETTINGS_BIND_SET: Update the setting when the #GObject property changes.
206 * It is an error to use this flag if the property is not readable.
207 * @G_SETTINGS_BIND_NO_SENSITIVITY: Do not try to bind a "sensitivity" property to the writability of the setting
208 * @G_SETTINGS_BIND_GET_NO_CHANGES: When set in addition to #G_SETTINGS_BIND_GET, set the #GObject property
209 * value initially from the setting, but do not listen for changes of the setting
211 * Flags used when creating a binding. These flags determine in which
212 * direction the binding works. The default is to synchronize in both
217 G_SETTINGS_BIND_DEFAULT,
218 G_SETTINGS_BIND_GET = (1<<0),
219 G_SETTINGS_BIND_SET = (1<<1),
220 G_SETTINGS_BIND_NO_SENSITIVITY = (1<<2),
221 G_SETTINGS_BIND_GET_NO_CHANGES = (1<<3)
222 } GSettingsBindFlags;
224 void g_settings_bind (GSettings *settings,
227 const gchar *property,
228 GSettingsBindFlags flags);
229 void g_settings_bind_with_mapping (GSettings *settings,
232 const gchar *property,
233 GSettingsBindFlags flags,
234 GSettingsBindGetMapping get_mapping,
235 GSettingsBindSetMapping set_mapping,
237 GDestroyNotify destroy);
238 void g_settings_bind_writable (GSettings *settings,
241 const gchar *property,
243 void g_settings_unbind (gpointer object,
244 const gchar *property);
246 gpointer g_settings_get_mapped (GSettings *settings,
248 GSettingsGetMapping mapping,
253 #endif /* __G_SETTINGS_H__ */