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);
86 gboolean g_settings_set_value (GSettings *settings,
89 GVariant * g_settings_get_value (GSettings *settings,
92 gboolean g_settings_set (GSettings *settings,
96 void g_settings_get (GSettings *settings,
100 void g_settings_reset (GSettings *settings,
103 gint g_settings_get_int (GSettings *settings,
105 gboolean g_settings_set_int (GSettings *settings,
108 gchar * g_settings_get_string (GSettings *settings,
110 gboolean g_settings_set_string (GSettings *settings,
113 gboolean g_settings_get_boolean (GSettings *settings,
115 gboolean g_settings_set_boolean (GSettings *settings,
118 gdouble g_settings_get_double (GSettings *settings,
120 gboolean g_settings_set_double (GSettings *settings,
123 gchar ** g_settings_get_strv (GSettings *settings,
125 gboolean g_settings_set_strv (GSettings *settings,
127 const gchar *const *value);
128 gint g_settings_get_enum (GSettings *settings,
130 gboolean g_settings_set_enum (GSettings *settings,
133 guint g_settings_get_flags (GSettings *settings,
135 gboolean g_settings_set_flags (GSettings *settings,
138 GSettings * g_settings_get_child (GSettings *settings,
141 gboolean g_settings_is_writable (GSettings *settings,
144 void g_settings_delay (GSettings *settings);
145 void g_settings_apply (GSettings *settings);
146 void g_settings_revert (GSettings *settings);
147 gboolean g_settings_get_has_unapplied (GSettings *settings);
148 void g_settings_sync (void);
151 * GSettingsBindSetMapping:
152 * @value: a #GValue containing the property value to map
153 * @expected_type: the #GVariantType to create
154 * @user_data: user data that was specified when the binding was created
155 * @returns: a new #GVariant holding the data from @value,
156 * or %NULL in case of an error
158 * The type for the function that is used to convert an object property
159 * value to a #GVariant for storing it in #GSettings.
161 typedef GVariant * (*GSettingsBindSetMapping) (const GValue *value,
162 const GVariantType *expected_type,
166 * GSettingsBindGetMapping:
167 * @value: return location for the property value
168 * @variant: the #GVariant
169 * @user_data: user data that was specified when the binding was created
170 * @returns: %TRUE if the conversion succeeded, %FALSE in case of an error
172 * The type for the function that is used to convert from #GSettings to
173 * an object property. The @value is already initialized to hold values
174 * of the appropriate type.
176 typedef gboolean (*GSettingsBindGetMapping) (GValue *value,
181 * GSettingsGetMapping:
182 * @value: the #GVariant to map, or %NULL
183 * @result: the result of the mapping
184 * @user_data: the user data that was passed to g_settings_get_mapped()
185 * @returns: %TRUE if the conversion succeeded, %FALSE in case of an error
187 * The type of the function that is used to convert from a value stored
188 * in a #GSettings to a value that is useful to the application.
190 * If the value is successfully mapped, the result should be stored at
191 * @result and %TRUE returned. If mapping fails (for example, if @value
192 * is not in the right format) then %FALSE should be returned.
194 * If @value is %NULL then it means that the mapping function is being
195 * given a "last chance" to successfully return a valid value. %TRUE
196 * must be returned in this case.
198 typedef gboolean (*GSettingsGetMapping) (GVariant *value,
203 * GSettingsBindFlags:
204 * @G_SETTINGS_BIND_DEFAULT: Equivalent to <literal>G_SETTINGS_BIND_GET|G_SETTINGS_BIND_SET</literal>
205 * @G_SETTINGS_BIND_GET: Update the #GObject property when the setting changes.
206 * It is an error to use this flag if the property is not writable.
207 * @G_SETTINGS_BIND_SET: Update the setting when the #GObject property changes.
208 * It is an error to use this flag if the property is not readable.
209 * @G_SETTINGS_BIND_NO_SENSITIVITY: Do not try to bind a "sensitivity" property to the writability of the setting
210 * @G_SETTINGS_BIND_GET_NO_CHANGES: When set in addition to #G_SETTINGS_BIND_GET, set the #GObject property
211 * value initially from the setting, but do not listen for changes of the setting
212 * @G_SETTINGS_BIND_INVERT_BOOLEAN: When passed to g_settings_bind(), uses a pair of mapping functions that invert
213 * the boolean value when mapping between the setting and the property. The setting and property must both
214 * be booleans. You can not pass this flag to g_settings_bind_with_mapping().
216 * Flags used when creating a binding. These flags determine in which
217 * direction the binding works. The default is to synchronize in both
222 G_SETTINGS_BIND_DEFAULT,
223 G_SETTINGS_BIND_GET = (1<<0),
224 G_SETTINGS_BIND_SET = (1<<1),
225 G_SETTINGS_BIND_NO_SENSITIVITY = (1<<2),
226 G_SETTINGS_BIND_GET_NO_CHANGES = (1<<3),
227 G_SETTINGS_BIND_INVERT_BOOLEAN = (1<<4)
228 } GSettingsBindFlags;
230 void g_settings_bind (GSettings *settings,
233 const gchar *property,
234 GSettingsBindFlags flags);
235 void g_settings_bind_with_mapping (GSettings *settings,
238 const gchar *property,
239 GSettingsBindFlags flags,
240 GSettingsBindGetMapping get_mapping,
241 GSettingsBindSetMapping set_mapping,
243 GDestroyNotify destroy);
244 void g_settings_bind_writable (GSettings *settings,
247 const gchar *property,
249 void g_settings_unbind (gpointer object,
250 const gchar *property);
252 gpointer g_settings_get_mapped (GSettings *settings,
254 GSettingsGetMapping mapping,
259 #endif /* __G_SETTINGS_H__ */