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 GSettings * g_settings_new (const gchar *schema);
74 GSettings * g_settings_new_with_path (const gchar *schema,
76 gboolean g_settings_supports_context (const gchar *context);
77 GSettings * g_settings_new_with_context (const gchar *schema,
78 const gchar *context);
79 GSettings * g_settings_new_with_context_and_path (const gchar *schema,
83 gboolean g_settings_set_value (GSettings *settings,
86 GVariant * g_settings_get_value (GSettings *settings,
89 gboolean g_settings_set (GSettings *settings,
93 void g_settings_get (GSettings *settings,
98 gint g_settings_get_int (GSettings *settings,
100 gboolean g_settings_set_int (GSettings *settings,
103 gchar * g_settings_get_string (GSettings *settings,
105 gboolean g_settings_set_string (GSettings *settings,
108 gboolean g_settings_get_boolean (GSettings *settings,
110 gboolean g_settings_set_boolean (GSettings *settings,
113 gdouble g_settings_get_double (GSettings *settings,
115 gboolean g_settings_set_double (GSettings *settings,
118 gchar ** g_settings_get_strv (GSettings *settings,
120 gboolean g_settings_set_strv (GSettings *settings,
122 const gchar *const *value);
123 gint g_settings_get_enum (GSettings *settings,
125 gboolean g_settings_set_enum (GSettings *settings,
128 GSettings * g_settings_get_child (GSettings *settings,
131 gboolean g_settings_is_writable (GSettings *settings,
134 void g_settings_delay (GSettings *settings);
135 void g_settings_apply (GSettings *settings);
136 void g_settings_revert (GSettings *settings);
137 gboolean g_settings_get_has_unapplied (GSettings *settings);
138 void g_settings_sync (const gchar *context);
141 * GSettingsBindSetMapping:
142 * @value: a #GValue containing the property value to map
143 * @expected_type: the #GVariantType to create
144 * @user_data: user data that was specified when the binding was created
145 * @returns: a new #GVariant holding the data from @value,
146 * or %NULL in case of an error
148 * The type for the function that is used to convert an object property
149 * value to a #GVariant for storing it in #GSettings.
151 typedef GVariant * (*GSettingsBindSetMapping) (const GValue *value,
152 const GVariantType *expected_type,
156 * GSettingsBindGetMapping:
157 * @value: return location for the property value
158 * @variant: the #GVariant
159 * @user_data: user data that was specified when the binding was created
160 * @returns: %TRUE if the conversion succeeded, %FALSE in case of an error
162 * The type for the function that is used to convert from #GSettings to
163 * an object property. The @value is already initialized to hold values
164 * of the appropriate type.
166 typedef gboolean (*GSettingsBindGetMapping) (GValue *value,
171 * GSettingsBindFlags:
172 * @G_SETTINGS_BIND_DEFAULT: Equivalent to <literal>G_SETTINGS_BIND_GET|G_SETTINGS_BIND_SET</literal>
173 * @G_SETTINGS_BIND_GET: Update the #GObject property when the setting changes.
174 * It is an error to use this flag if the property is not writable.
175 * @G_SETTINGS_BIND_SET: Update the setting when the #GObject property changes.
176 * It is an error to use this flag if the property is not readable.
177 * @G_SETTINGS_BIND_NO_SENSITIVITY: Do not try to bind a "sensitivity" property to the writability of the setting
178 * @G_SETTINGS_BIND_GET_NO_CHANGES: When set in addition to #G_SETTINGS_BIND_GET, set the #GObject property
179 * value initially from the setting, but do not listen for changes of the setting
181 * Flags used when creating a binding. These flags determine in which
182 * direction the binding works. The default is to synchronize in both
187 G_SETTINGS_BIND_DEFAULT,
188 G_SETTINGS_BIND_GET = (1<<0),
189 G_SETTINGS_BIND_SET = (1<<1),
190 G_SETTINGS_BIND_NO_SENSITIVITY = (1<<2),
191 G_SETTINGS_BIND_GET_NO_CHANGES = (1<<3)
192 } GSettingsBindFlags;
194 void g_settings_bind (GSettings *settings,
197 const gchar *property,
198 GSettingsBindFlags flags);
199 void g_settings_bind_with_mapping (GSettings *settings,
202 const gchar *property,
203 GSettingsBindFlags flags,
204 GSettingsBindGetMapping get_mapping,
205 GSettingsBindSetMapping set_mapping,
207 GDestroyNotify destroy);
208 void g_settings_bind_writable (GSettings *settings,
211 const gchar *property,
213 void g_settings_unbind (gpointer object,
214 const gchar *property);
218 #endif /* __G_SETTINGS_H__ */