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>
30 #include "gsettings.h"
32 #include "gdelayedsettingsbackend.h"
33 #include "gsettingsbackendinternal.h"
34 #include "gsettings-mapping.h"
35 #include "gio-marshal.h"
36 #include "gsettingsschema.h"
45 * @short_description: a high-level API for application settings
47 * The #GSettings class provides a convenient API for storing and retrieving
48 * application settings.
50 * When creating a GSettings instance, you have to specify a schema
51 * that describes the keys in your settings and their types and default
52 * values, as well as some other information.
54 * Normally, a schema has as fixed path that determines where the settings
55 * are stored in the conceptual global tree of settings. However, schemas
56 * can also be 'relocatable', i.e. not equipped with a fixed path. This is
57 * useful e.g. when the schema describes an 'account', and you want to be
58 * able to store a arbitrary number of accounts.
60 * Unlike other configuration systems (like GConf), GSettings does not
61 * restrict keys to basic types like strings and numbers. GSettings stores
62 * values as #GVariant, and allows any #GVariantType for keys. Key names
63 * are restricted to lowercase characters, numbers and '-'. Furthermore,
64 * the names must begin with a lowercase character, must not end
65 * with a '-', and must not contain consecutive dashes. Key names can
66 * be up to 32 characters long.
68 * Similar to GConf, the default values in GSettings schemas can be
69 * localized, but the localized values are stored in gettext catalogs
70 * and looked up with the domain that is specified in the
71 * <tag class="attribute">gettext-domain</tag> attribute of the
72 * <tag class="starttag">schemalist</tag> or <tag class="starttag">schema</tag>
73 * elements and the category that is specified in the l10n attribute of the
74 * <tag class="starttag">key</tag> element.
76 * GSettings uses schemas in a compact binary form that is created
77 * by the <link linkend="glib-compile-schemas">glib-compile-schemas</link>
78 * utility. The input is a schema description in an XML format that can be
79 * described by the following DTD:
80 * |[<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/gschema.dtd"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include>]|
82 * At runtime, schemas are identified by their id (as specified
83 * in the <tag class="attribute">id</tag> attribute of the
84 * <tag class="starttag">schema</tag> element). The
85 * convention for schema ids is to use a dotted name, similar in
86 * style to a DBus bus name, e.g. "org.gnome.font-rendering".
88 * <example><title>Default values</title>
89 * <programlisting><![CDATA[
91 * <schema id="org.gtk.test" path="/tests/" gettext-domain="test">
93 * <key name="greeting" type="s">
94 * <default l10n="messages">"Hello, earthlings"</default>
95 * <summary>A greeting</summary>
97 * Greeting of the invading martians
101 * <key name="box" type="(ii)">
102 * <default>(20,30)</default>
107 * ]]></programlisting></example>
109 * <example><title>Ranges, choices and enumerated types</title>
110 * <programlisting><![CDATA[
114 * <value nick="first" value="1"/>
115 * <value nick="second" value="2"/>
118 * <schema id="org.gtk.test">
120 * <key name="key-with-range" type="i">
121 * <range min="1" max="100"/>
122 * <default>10</default>
125 * <key name="key-with-choices" type="s">
127 * <choice value='Elisabeth'/>
128 * <choice value='Annabeth'/>
129 * <choice value='Joe'/>
132 * <alias value='Anna' target='Annabeth'/>
133 * <alias value='Beth' target='Elisabeth'/>
135 * <default>'Joe'</default>
138 * <key name='enumerated-key' enum='myenum'>
139 * <default>'first'</default>
144 * ]]></programlisting></example>
147 * <title>Vendor overrides</title>
149 * Default values are defined in the schemas that get installed by
150 * an application. Sometimes, it is necessary for a vendor or distributor
151 * to adjust these defaults. Since patching the XML source for the schema
152 * is inconvenient and error-prone,
153 * <link linkend="glib-compile-schemas">glib-compile-schemas</link> reads
154 * so-called 'vendor override' files. These are keyfiles in the same
155 * directory as the XML schema sources which can override default values.
156 * The schema id serves as the group name in the key file, and the values
157 * are expected in serialized GVariant form, as in the following example:
158 * <informalexample><programlisting>
162 * </programlisting></informalexample>
167 * <title>Binding</title>
169 * A very convenient feature of GSettings lets you bind #GObject properties
170 * directly to settings, using g_settings_bind(). Once a GObject property
171 * has been bound to a setting, changes on either side are automatically
172 * propagated to the other side. GSettings handles details like
173 * mapping between GObject and GVariant types, and preventing infinite
177 * This makes it very easy to hook up a preferences dialog to the
178 * underlying settings. To make this even more convenient, GSettings
179 * looks for a boolean property with the name "sensitivity" and
180 * automatically binds it to the writability of the bound setting.
181 * If this 'magic' gets in the way, it can be suppressed with the
182 * #G_SETTINGS_BIND_NO_SENSITIVITY flag.
187 struct _GSettingsPrivate
189 /* where the signals go... */
190 GMainContext *main_context;
192 GSettingsBackend *backend;
193 GSettingsSchema *schema;
197 GDelayedSettingsBackend *delayed;
211 SIGNAL_WRITABLE_CHANGE_EVENT,
212 SIGNAL_WRITABLE_CHANGED,
218 static guint g_settings_signals[N_SIGNALS];
220 G_DEFINE_TYPE (GSettings, g_settings, G_TYPE_OBJECT)
224 g_settings_real_change_event (GSettings *settings,
231 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
233 for (i = 0; i < n_keys; i++)
234 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGED],
235 keys[i], g_quark_to_string (keys[i]));
241 g_settings_real_writable_change_event (GSettings *settings,
244 const GQuark *keys = &key;
249 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
251 for (i = 0; i < n_keys; i++)
252 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGED],
253 keys[i], g_quark_to_string (keys[i]));
259 settings_backend_changed (GObject *target,
260 GSettingsBackend *backend,
264 GSettings *settings = G_SETTINGS (target);
265 gboolean ignore_this;
268 g_assert (settings->priv->backend == backend);
270 for (i = 0; key[i] == settings->priv->path[i]; i++);
272 if (settings->priv->path[i] == '\0' &&
273 g_settings_schema_has_key (settings->priv->schema, key + i))
277 quark = g_quark_from_string (key + i);
278 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
279 0, &quark, 1, &ignore_this);
284 settings_backend_path_changed (GObject *target,
285 GSettingsBackend *backend,
289 GSettings *settings = G_SETTINGS (target);
290 gboolean ignore_this;
292 g_assert (settings->priv->backend == backend);
294 if (g_str_has_prefix (settings->priv->path, path))
295 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
296 0, NULL, 0, &ignore_this);
300 settings_backend_keys_changed (GObject *target,
301 GSettingsBackend *backend,
303 const gchar * const *items,
306 GSettings *settings = G_SETTINGS (target);
307 gboolean ignore_this;
310 g_assert (settings->priv->backend == backend);
312 for (i = 0; settings->priv->path[i] &&
313 settings->priv->path[i] == path[i]; i++);
320 for (j = 0; items[j]; j++)
322 const gchar *item = items[j];
325 for (k = 0; item[k] == settings->priv->path[i + k]; k++);
327 if (settings->priv->path[i + k] == '\0' &&
328 g_settings_schema_has_key (settings->priv->schema, item + k))
329 quarks[l++] = g_quark_from_string (item + k);
331 /* "256 quarks ought to be enough for anybody!"
332 * If this bites you, I'm sorry. Please file a bug.
338 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
339 0, quarks, l, &ignore_this);
344 settings_backend_writable_changed (GObject *target,
345 GSettingsBackend *backend,
348 GSettings *settings = G_SETTINGS (target);
349 gboolean ignore_this;
352 g_assert (settings->priv->backend == backend);
354 for (i = 0; key[i] == settings->priv->path[i]; i++);
356 if (settings->priv->path[i] == '\0' &&
357 g_settings_schema_has_key (settings->priv->schema, key + i))
358 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
359 0, g_quark_from_string (key + i), &ignore_this);
363 settings_backend_path_writable_changed (GObject *target,
364 GSettingsBackend *backend,
367 GSettings *settings = G_SETTINGS (target);
368 gboolean ignore_this;
370 g_assert (settings->priv->backend == backend);
372 if (g_str_has_prefix (settings->priv->path, path))
373 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
374 0, (GQuark) 0, &ignore_this);
377 /* Properties, Construction, Destruction {{{1 */
379 g_settings_set_property (GObject *object,
384 GSettings *settings = G_SETTINGS (object);
389 g_assert (settings->priv->schema_name == NULL);
390 settings->priv->schema_name = g_value_dup_string (value);
394 settings->priv->path = g_value_dup_string (value);
398 settings->priv->backend = g_value_dup_object (value);
402 g_assert_not_reached ();
407 g_settings_get_property (GObject *object,
412 GSettings *settings = G_SETTINGS (object);
417 g_value_set_string (value, settings->priv->schema_name);
421 g_value_set_string (value, settings->priv->path);
424 case PROP_HAS_UNAPPLIED:
425 g_value_set_boolean (value, g_settings_get_has_unapplied (settings));
429 g_assert_not_reached ();
433 static const GSettingsListenerVTable listener_vtable = {
434 settings_backend_changed,
435 settings_backend_path_changed,
436 settings_backend_keys_changed,
437 settings_backend_writable_changed,
438 settings_backend_path_writable_changed
442 g_settings_constructed (GObject *object)
444 GSettings *settings = G_SETTINGS (object);
445 const gchar *schema_path;
447 settings->priv->schema = g_settings_schema_new (settings->priv->schema_name);
448 schema_path = g_settings_schema_get_path (settings->priv->schema);
450 if (settings->priv->path && schema_path && strcmp (settings->priv->path, schema_path) != 0)
451 g_error ("settings object created with schema '%s' and path '%s', but "
452 "path '%s' is specified by schema",
453 settings->priv->schema_name, settings->priv->path, schema_path);
455 if (settings->priv->path == NULL)
457 if (schema_path == NULL)
458 g_error ("attempting to create schema '%s' without a path",
459 settings->priv->schema_name);
461 settings->priv->path = g_strdup (schema_path);
464 if (settings->priv->backend == NULL)
465 settings->priv->backend = g_settings_backend_get_default ();
467 g_settings_backend_watch (settings->priv->backend,
468 &listener_vtable, G_OBJECT (settings),
469 settings->priv->main_context);
470 g_settings_backend_subscribe (settings->priv->backend,
471 settings->priv->path);
475 g_settings_finalize (GObject *object)
477 GSettings *settings = G_SETTINGS (object);
479 g_settings_backend_unsubscribe (settings->priv->backend,
480 settings->priv->path);
481 g_main_context_unref (settings->priv->main_context);
482 g_object_unref (settings->priv->backend);
483 g_object_unref (settings->priv->schema);
484 g_free (settings->priv->schema_name);
485 g_free (settings->priv->path);
487 G_OBJECT_CLASS (g_settings_parent_class)->finalize (object);
491 g_settings_init (GSettings *settings)
493 settings->priv = G_TYPE_INSTANCE_GET_PRIVATE (settings,
497 settings->priv->main_context = g_main_context_get_thread_default ();
499 if (settings->priv->main_context == NULL)
500 settings->priv->main_context = g_main_context_default ();
502 g_main_context_ref (settings->priv->main_context);
506 g_settings_class_init (GSettingsClass *class)
508 GObjectClass *object_class = G_OBJECT_CLASS (class);
510 class->writable_change_event = g_settings_real_writable_change_event;
511 class->change_event = g_settings_real_change_event;
513 object_class->set_property = g_settings_set_property;
514 object_class->get_property = g_settings_get_property;
515 object_class->constructed = g_settings_constructed;
516 object_class->finalize = g_settings_finalize;
518 g_type_class_add_private (object_class, sizeof (GSettingsPrivate));
521 * GSettings::changed:
522 * @settings: the object on which the signal was emitted
523 * @key: the name of the key that changed
525 * The "changed" signal is emitted when a key has potentially changed.
526 * You should call one of the g_settings_get() calls to check the new
529 * This signal supports detailed connections. You can connect to the
530 * detailed signal "changed::x" in order to only receive callbacks
531 * when key "x" changes.
533 g_settings_signals[SIGNAL_CHANGED] =
534 g_signal_new ("changed", G_TYPE_SETTINGS,
535 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
536 G_STRUCT_OFFSET (GSettingsClass, changed),
537 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
538 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
541 * GSettings::change-event:
542 * @settings: the object on which the signal was emitted
543 * @keys: an array of #GQuark<!-- -->s for the changed keys, or %NULL
544 * @n_keys: the length of the @keys array, or 0
545 * @returns: %TRUE to stop other handlers from being invoked for the
546 * event. FALSE to propagate the event further.
548 * The "change-event" signal is emitted once per change event that
549 * affects this settings object. You should connect to this signal
550 * only if you are interested in viewing groups of changes before they
551 * are split out into multiple emissions of the "changed" signal.
552 * For most use cases it is more appropriate to use the "changed" signal.
554 * In the event that the change event applies to one or more specified
555 * keys, @keys will be an array of #GQuark of length @n_keys. In the
556 * event that the change event applies to the #GSettings object as a
557 * whole (ie: potentially every key has been changed) then @keys will
558 * be %NULL and @n_keys will be 0.
560 * The default handler for this signal invokes the "changed" signal
561 * for each affected key. If any other connected handler returns
562 * %TRUE then this default functionality will be supressed.
564 g_settings_signals[SIGNAL_CHANGE_EVENT] =
565 g_signal_new ("change-event", G_TYPE_SETTINGS,
567 G_STRUCT_OFFSET (GSettingsClass, change_event),
568 g_signal_accumulator_true_handled, NULL,
569 _gio_marshal_BOOL__POINTER_INT,
570 G_TYPE_BOOLEAN, 2, G_TYPE_POINTER, G_TYPE_INT);
573 * GSettings::writable-changed:
574 * @settings: the object on which the signal was emitted
577 * The "writable-changed" signal is emitted when the writability of a
578 * key has potentially changed. You should call
579 * g_settings_is_writable() in order to determine the new status.
581 * This signal supports detailed connections. You can connect to the
582 * detailed signal "writable-changed::x" in order to only receive
583 * callbacks when the writability of "x" changes.
585 g_settings_signals[SIGNAL_WRITABLE_CHANGED] =
586 g_signal_new ("writable-changed", G_TYPE_SETTINGS,
587 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
588 G_STRUCT_OFFSET (GSettingsClass, changed),
589 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
590 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
593 * GSettings::writable-change-event:
594 * @settings: the object on which the signal was emitted
595 * @key: the quark of the key, or 0
596 * @returns: %TRUE to stop other handlers from being invoked for the
597 * event. FALSE to propagate the event further.
599 * The "writable-change-event" signal is emitted once per writability
600 * change event that affects this settings object. You should connect
601 * to this signal if you are interested in viewing groups of changes
602 * before they are split out into multiple emissions of the
603 * "writable-changed" signal. For most use cases it is more
604 * appropriate to use the "writable-changed" signal.
606 * In the event that the writability change applies only to a single
607 * key, @key will be set to the #GQuark for that key. In the event
608 * that the writability change affects the entire settings object,
611 * The default handler for this signal invokes the "writable-changed"
612 * and "changed" signals for each affected key. This is done because
613 * changes in writability might also imply changes in value (if for
614 * example, a new mandatory setting is introduced). If any other
615 * connected handler returns %TRUE then this default functionality
618 g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT] =
619 g_signal_new ("writable-change-event", G_TYPE_SETTINGS,
621 G_STRUCT_OFFSET (GSettingsClass, writable_change_event),
622 g_signal_accumulator_true_handled, NULL,
623 _gio_marshal_BOOLEAN__UINT, G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
628 * The name of the context that the settings are stored in.
630 g_object_class_install_property (object_class, PROP_BACKEND,
631 g_param_spec_object ("backend",
632 P_("GSettingsBackend"),
633 P_("The GSettingsBackend for this settings object"),
634 G_TYPE_SETTINGS_BACKEND, G_PARAM_CONSTRUCT_ONLY |
635 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
640 * The name of the schema that describes the types of keys
641 * for this #GSettings object.
643 g_object_class_install_property (object_class, PROP_SCHEMA,
644 g_param_spec_string ("schema",
646 P_("The name of the schema for this settings object"),
648 G_PARAM_CONSTRUCT_ONLY |
649 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
654 * The path within the backend where the settings are stored.
656 g_object_class_install_property (object_class, PROP_PATH,
657 g_param_spec_string ("path",
659 P_("The path within the backend where the settings are"),
661 G_PARAM_CONSTRUCT_ONLY |
662 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
665 * GSettings:has-unapplied:
667 * If this property is %TRUE, the #GSettings object has outstanding
668 * changes that will be applied when g_settings_apply() is called.
670 g_object_class_install_property (object_class, PROP_HAS_UNAPPLIED,
671 g_param_spec_boolean ("has-unapplied",
672 P_("Has unapplied changes"),
673 P_("TRUE if there are outstanding changes to apply()"),
675 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
679 /* Construction (new, new_with_path, etc.) {{{1 */
682 * @schema: the name of the schema
683 * @returns: a new #GSettings object
685 * Creates a new #GSettings object with a given schema.
687 * Signals on the newly created #GSettings object will be dispatched
688 * via the thread-default #GMainContext in effect at the time of the
689 * call to g_settings_new(). The new #GSettings will hold a reference
690 * on the context. See g_main_context_push_thread_default().
695 g_settings_new (const gchar *schema)
697 g_return_val_if_fail (schema != NULL, NULL);
699 return g_object_new (G_TYPE_SETTINGS,
705 * g_settings_new_with_path:
706 * @schema: the name of the schema
707 * @path: the path to use
708 * @returns: a new #GSettings object
710 * Creates a new #GSettings object with a given schema and path.
712 * You only need to do this if you want to directly create a settings
713 * object with a schema that doesn't have a specified path of its own.
716 * It is a programmer error to call this function for a schema that
717 * has an explicitly specified path.
722 g_settings_new_with_path (const gchar *schema,
725 g_return_val_if_fail (schema != NULL, NULL);
726 g_return_val_if_fail (path != NULL, NULL);
728 return g_object_new (G_TYPE_SETTINGS,
735 * g_settings_new_with_backend:
736 * @schema: the name of the schema
737 * @backend: the #GSettingsBackend to use
738 * @returns: a new #GSettings object
740 * Creates a new #GSettings object with a given schema and backend.
742 * Creating settings objects with an different backend allows accessing settings
743 * from a database other than the usual one. For example, it may make
744 * sense to pass a backend corresponding to the "defaults" settings database on
745 * the system to get a settings object that modifies the system default
746 * settings instead of the settings for this user.
751 g_settings_new_with_backend (const gchar *schema,
752 GSettingsBackend *backend)
754 g_return_val_if_fail (schema != NULL, NULL);
755 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
757 return g_object_new (G_TYPE_SETTINGS,
764 * g_settings_new_with_backend_and_path:
765 * @schema: the name of the schema
766 * @backend: the #GSettingsBackend to use
767 * @path: the path to use
768 * @returns: a new #GSettings object
770 * Creates a new #GSettings object with a given schema, backend and
773 * This is a mix of g_settings_new_with_backend() and
774 * g_settings_new_with_path().
779 g_settings_new_with_backend_and_path (const gchar *schema,
780 GSettingsBackend *backend,
783 g_return_val_if_fail (schema != NULL, NULL);
784 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
785 g_return_val_if_fail (path != NULL, NULL);
787 return g_object_new (G_TYPE_SETTINGS,
794 /* Internal read/write utilities, enum/flags conversion, validation {{{1 */
800 GSettingsSchema *schema;
805 const guint32 *strinfo;
806 gsize strinfo_length;
808 const gchar *unparsed;
811 const GVariantType *type;
812 GVariant *minimum, *maximum;
813 GVariant *default_value;
817 g_settings_get_key_info (GSettingsKeyInfo *info,
825 memset (info, 0, sizeof *info);
827 iter = g_settings_schema_get_value (settings->priv->schema, key);
829 info->default_value = g_variant_iter_next_value (iter);
830 info->type = g_variant_get_type (info->default_value);
831 info->settings = g_object_ref (settings);
832 info->key = g_intern_string (key);
834 while (g_variant_iter_next (iter, "(y*)", &code, &data))
839 /* translation requested */
840 g_variant_get (data, "(y&s)", &info->lc_char, &info->unparsed);
844 /* enumerated types... */
845 info->is_enum = TRUE;
850 info->is_flags = TRUE;
854 /* ..., choices, aliases */
855 info->strinfo = g_variant_get_fixed_array (data,
856 &info->strinfo_length,
861 g_variant_get (data, "(**)", &info->minimum, &info->maximum);
865 g_warning ("unknown schema extension '%c'", code);
869 g_variant_unref (data);
872 g_variant_iter_free (iter);
876 g_settings_free_key_info (GSettingsKeyInfo *info)
879 g_variant_unref (info->minimum);
882 g_variant_unref (info->maximum);
884 g_variant_unref (info->default_value);
885 g_object_unref (info->settings);
889 g_settings_write_to_backend (GSettingsKeyInfo *info,
895 path = g_strconcat (info->settings->priv->path, info->key, NULL);
896 success = g_settings_backend_write (info->settings->priv->backend,
904 g_settings_type_check (GSettingsKeyInfo *info,
907 g_return_val_if_fail (value != NULL, FALSE);
909 return g_variant_is_of_type (value, info->type);
913 g_settings_range_check (GSettingsKeyInfo *info,
916 if (info->minimum == NULL && info->strinfo == NULL)
919 if (g_variant_is_container (value))
925 g_variant_iter_init (&iter, value);
926 while (ok && (child = g_variant_iter_next_value (&iter)))
928 ok = g_settings_range_check (info, child);
929 g_variant_unref (child);
937 return g_variant_compare (info->minimum, value) <= 0 &&
938 g_variant_compare (value, info->maximum) <= 0;
941 return strinfo_is_string_valid (info->strinfo,
942 info->strinfo_length,
943 g_variant_get_string (value, NULL));
947 g_settings_range_fixup (GSettingsKeyInfo *info,
952 if (g_settings_range_check (info, value))
953 return g_variant_ref (value);
955 if (info->strinfo == NULL)
958 if (g_variant_is_container (value))
960 GVariantBuilder builder;
964 g_variant_iter_init (&iter, value);
965 g_variant_builder_init (&builder, g_variant_get_type (value));
967 while ((child = g_variant_iter_next_value (&iter)))
971 fixed = g_settings_range_fixup (info, child);
972 g_variant_unref (child);
976 g_variant_builder_clear (&builder);
980 g_variant_builder_add_value (&builder, fixed);
981 g_variant_unref (fixed);
984 return g_variant_ref_sink (g_variant_builder_end (&builder));
987 target = strinfo_string_from_alias (info->strinfo, info->strinfo_length,
988 g_variant_get_string (value, NULL));
989 return target ? g_variant_ref_sink (g_variant_new_string (target)) : NULL;
993 g_settings_read_from_backend (GSettingsKeyInfo *info)
999 path = g_strconcat (info->settings->priv->path, info->key, NULL);
1000 value = g_settings_backend_read (info->settings->priv->backend,
1001 path, info->type, FALSE);
1006 fixup = g_settings_range_fixup (info, value);
1007 g_variant_unref (value);
1016 g_settings_get_translated_default (GSettingsKeyInfo *info)
1018 const gchar *translated;
1019 GError *error = NULL;
1020 const gchar *domain;
1023 if (info->lc_char == '\0')
1024 /* translation not requested for this key */
1027 domain = g_settings_schema_get_gettext_domain (info->settings->priv->schema);
1029 if (info->lc_char == 't')
1030 translated = g_dcgettext (domain, info->unparsed, LC_TIME);
1032 translated = g_dgettext (domain, info->unparsed);
1034 if (translated == info->unparsed)
1035 /* the default value was not translated */
1038 /* try to parse the translation of the unparsed default */
1039 value = g_variant_parse (info->type, translated, NULL, NULL, &error);
1043 g_warning ("Failed to parse translated string `%s' for "
1044 "key `%s' in schema `%s': %s", info->unparsed, info->key,
1045 info->settings->priv->schema_name, error->message);
1046 g_warning ("Using untranslated default instead.");
1047 g_error_free (error);
1050 else if (!g_settings_range_check (info, value))
1052 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
1053 "is outside of valid range", info->unparsed, info->key,
1054 info->settings->priv->schema_name);
1055 g_variant_unref (value);
1063 g_settings_to_enum (GSettingsKeyInfo *info,
1069 it_worked = strinfo_enum_from_string (info->strinfo, info->strinfo_length,
1070 g_variant_get_string (value, NULL),
1073 /* 'value' can only come from the backend after being filtered for validity,
1074 * from the translation after being filtered for validity, or from the schema
1075 * itself (which the schema compiler checks for validity). If this assertion
1076 * fails then it's really a bug in GSettings or the schema compiler...
1078 g_assert (it_worked);
1084 g_settings_from_enum (GSettingsKeyInfo *info,
1087 const gchar *string;
1089 string = strinfo_string_from_enum (info->strinfo,
1090 info->strinfo_length,
1096 return g_variant_new_string (string);
1100 g_settings_to_flags (GSettingsKeyInfo *info,
1108 g_variant_iter_init (&iter, value);
1109 while (g_variant_iter_next (&iter, "&s", &flag))
1114 it_worked = strinfo_enum_from_string (info->strinfo,
1115 info->strinfo_length,
1117 /* as in g_settings_to_enum() */
1118 g_assert (it_worked);
1120 result |= flag_value;
1127 g_settings_from_flags (GSettingsKeyInfo *info,
1130 GVariantBuilder builder;
1133 g_variant_builder_init (&builder, G_VARIANT_TYPE ("as"));
1135 for (i = 0; i < 32; i++)
1136 if (value & (1u << i))
1138 const gchar *string;
1140 string = strinfo_string_from_enum (info->strinfo,
1141 info->strinfo_length,
1146 g_variant_builder_clear (&builder);
1150 g_variant_builder_add (&builder, "s", string);
1153 return g_variant_builder_end (&builder);
1156 /* Public Get/Set API {{{1 (get, get_value, set, set_value, get_mapped) */
1158 * g_settings_get_value:
1159 * @settings: a #GSettings object
1160 * @key: the key to get the value for
1161 * @returns: a new #GVariant
1163 * Gets the value that is stored in @settings for @key.
1165 * It is a programmer error to give a @key that isn't contained in the
1166 * schema for @settings.
1171 g_settings_get_value (GSettings *settings,
1174 GSettingsKeyInfo info;
1177 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1178 g_return_val_if_fail (key != NULL, NULL);
1180 g_settings_get_key_info (&info, settings, key);
1181 value = g_settings_read_from_backend (&info);
1184 value = g_settings_get_translated_default (&info);
1187 value = g_variant_ref (info.default_value);
1189 g_settings_free_key_info (&info);
1195 * g_settings_get_enum:
1196 * @settings: a #GSettings object
1197 * @key: the key to get the value for
1198 * @returns: the enum value
1200 * Gets the value that is stored in @settings for @key and converts it
1201 * to the enum value that it represents.
1203 * In order to use this function the type of the value must be a string
1204 * and it must be marked in the schema file as an enumerated type.
1206 * It is a programmer error to give a @key that isn't contained in the
1207 * schema for @settings or is not marked as an enumerated type.
1209 * If the value stored in the configuration database is not a valid
1210 * value for the enumerated type then this function will return the
1216 g_settings_get_enum (GSettings *settings,
1219 GSettingsKeyInfo info;
1223 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1224 g_return_val_if_fail (key != NULL, -1);
1226 g_settings_get_key_info (&info, settings, key);
1230 g_critical ("g_settings_get_enum() called on key `%s' which is not "
1231 "associated with an enumerated type", info.key);
1232 g_settings_free_key_info (&info);
1236 value = g_settings_read_from_backend (&info);
1239 value = g_settings_get_translated_default (&info);
1242 value = g_variant_ref (info.default_value);
1244 result = g_settings_to_enum (&info, value);
1245 g_settings_free_key_info (&info);
1246 g_variant_unref (value);
1252 * g_settings_set_enum:
1253 * @settings: a #GSettings object
1254 * @key: a key, within @settings
1255 * @value: an enumerated value
1256 * @returns: %TRUE, if the set succeeds
1258 * Looks up the enumerated type nick for @value and writes it to @key,
1261 * It is a programmer error to give a @key that isn't contained in the
1262 * schema for @settings or is not marked as an enumerated type, or for
1263 * @value not to be a valid value for the named type.
1265 * After performing the write, accessing @key directly with
1266 * g_settings_get_string() will return the 'nick' associated with
1270 g_settings_set_enum (GSettings *settings,
1274 GSettingsKeyInfo info;
1278 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1279 g_return_val_if_fail (key != NULL, FALSE);
1281 g_settings_get_key_info (&info, settings, key);
1285 g_critical ("g_settings_set_enum() called on key `%s' which is not "
1286 "associated with an enumerated type", info.key);
1290 if (!(variant = g_settings_from_enum (&info, value)))
1292 g_critical ("g_settings_set_enum(): invalid enum value %d for key `%s' "
1293 "in schema `%s'. Doing nothing.", value, info.key,
1294 info.settings->priv->schema_name);
1295 g_settings_free_key_info (&info);
1299 success = g_settings_write_to_backend (&info, variant);
1300 g_settings_free_key_info (&info);
1306 * g_settings_get_flags:
1307 * @settings: a #GSettings object
1308 * @key: the key to get the value for
1309 * @returns: the flags value
1311 * Gets the value that is stored in @settings for @key and converts it
1312 * to the flags value that it represents.
1314 * In order to use this function the type of the value must be an array
1315 * of strings and it must be marked in the schema file as an flags type.
1317 * It is a programmer error to give a @key that isn't contained in the
1318 * schema for @settings or is not marked as a flags type.
1320 * If the value stored in the configuration database is not a valid
1321 * value for the flags type then this function will return the default
1327 g_settings_get_flags (GSettings *settings,
1330 GSettingsKeyInfo info;
1334 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1335 g_return_val_if_fail (key != NULL, -1);
1337 g_settings_get_key_info (&info, settings, key);
1341 g_critical ("g_settings_get_flags() called on key `%s' which is not "
1342 "associated with a flags type", info.key);
1343 g_settings_free_key_info (&info);
1347 value = g_settings_read_from_backend (&info);
1350 value = g_settings_get_translated_default (&info);
1353 value = g_variant_ref (info.default_value);
1355 result = g_settings_to_flags (&info, value);
1356 g_settings_free_key_info (&info);
1357 g_variant_unref (value);
1363 * g_settings_set_flags:
1364 * @settings: a #GSettings object
1365 * @key: a key, within @settings
1366 * @value: a flags value
1367 * @returns: %TRUE, if the set succeeds
1369 * Looks up the flags type nicks for the bits specified by @value, puts
1370 * them in an array of strings and writes the array to @key, withing
1373 * It is a programmer error to give a @key that isn't contained in the
1374 * schema for @settings or is not marked as a flags type, or for @value
1375 * to contain any bits that are not value for the named type.
1377 * After performing the write, accessing @key directly with
1378 * g_settings_get_strv() will return an array of 'nicks'; one for each
1382 g_settings_set_flags (GSettings *settings,
1386 GSettingsKeyInfo info;
1390 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1391 g_return_val_if_fail (key != NULL, FALSE);
1393 g_settings_get_key_info (&info, settings, key);
1397 g_critical ("g_settings_set_flags() called on key `%s' which is not "
1398 "associated with a flags type", info.key);
1402 if (!(variant = g_settings_from_flags (&info, value)))
1404 g_critical ("g_settings_set_flags(): invalid flags value 0x%08x "
1405 "for key `%s' in schema `%s'. Doing nothing.",
1406 value, info.key, info.settings->priv->schema_name);
1407 g_settings_free_key_info (&info);
1411 success = g_settings_write_to_backend (&info, variant);
1412 g_settings_free_key_info (&info);
1418 * g_settings_set_value:
1419 * @settings: a #GSettings object
1420 * @key: the name of the key to set
1421 * @value: a #GVariant of the correct type
1422 * @returns: %TRUE if setting the key succeeded,
1423 * %FALSE if the key was not writable
1425 * Sets @key in @settings to @value.
1427 * It is a programmer error to give a @key that isn't contained in the
1428 * schema for @settings or for @value to have the incorrect type, per
1431 * If @value is floating then this function consumes the reference.
1436 g_settings_set_value (GSettings *settings,
1440 GSettingsKeyInfo info;
1442 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1443 g_return_val_if_fail (key != NULL, FALSE);
1445 g_settings_get_key_info (&info, settings, key);
1446 g_return_val_if_fail (g_settings_type_check (&info, value), FALSE);
1447 g_return_val_if_fail (g_settings_range_check (&info, value), FALSE);
1448 g_settings_free_key_info (&info);
1450 return g_settings_write_to_backend (&info, value);
1455 * @settings: a #GSettings object
1456 * @key: the key to get the value for
1457 * @format: a #GVariant format string
1458 * @...: arguments as per @format
1460 * Gets the value that is stored at @key in @settings.
1462 * A convenience function that combines g_settings_get_value() with
1465 * It is a programmer error to give a @key that isn't contained in the
1466 * schema for @settings or for the #GVariantType of @format to mismatch
1467 * the type given in the schema.
1472 g_settings_get (GSettings *settings,
1474 const gchar *format,
1480 value = g_settings_get_value (settings, key);
1482 va_start (ap, format);
1483 g_variant_get_va (value, format, NULL, &ap);
1486 g_variant_unref (value);
1491 * @settings: a #GSettings object
1492 * @key: the name of the key to set
1493 * @format: a #GVariant format string
1494 * @...: arguments as per @format
1495 * @returns: %TRUE if setting the key succeeded,
1496 * %FALSE if the key was not writable
1498 * Sets @key in @settings to @value.
1500 * A convenience function that combines g_settings_set_value() with
1503 * It is a programmer error to give a @key that isn't contained in the
1504 * schema for @settings or for the #GVariantType of @format to mismatch
1505 * the type given in the schema.
1510 g_settings_set (GSettings *settings,
1512 const gchar *format,
1518 va_start (ap, format);
1519 value = g_variant_new_va (format, NULL, &ap);
1522 return g_settings_set_value (settings, key, value);
1526 * g_settings_get_mapped:
1527 * @settings: a #GSettings object
1528 * @key: the key to get the value for
1529 * @mapping: the function to map the value in the settings database to
1530 * the value used by the application
1531 * @user_data: user data for @mapping
1532 * @returns: (transfer full): the result, which may be %NULL
1534 * Gets the value that is stored at @key in @settings, subject to
1535 * application-level validation/mapping.
1537 * You should use this function when the application needs to perform
1538 * some processing on the value of the key (for example, parsing). The
1539 * @mapping function performs that processing. If the function
1540 * indicates that the processing was unsuccessful (due to a parse error,
1541 * for example) then the mapping is tried again with another value.
1543 * This allows a robust 'fall back to defaults' behaviour to be
1544 * implemented somewhat automatically.
1546 * The first value that is tried is the user's setting for the key. If
1547 * the mapping function fails to map this value, other values may be
1548 * tried in an unspecified order (system or site defaults, translated
1549 * schema default values, untranslated schema default values, etc).
1551 * If the mapping function fails for all possible values, one additional
1552 * attempt is made: the mapping function is called with a %NULL value.
1553 * If the mapping function still indicates failure at this point then
1554 * the application will be aborted.
1556 * The result parameter for the @mapping function is pointed to a
1557 * #gpointer which is initially set to %NULL. The same pointer is given
1558 * to each invocation of @mapping. The final value of that #gpointer is
1559 * what is returned by this function. %NULL is valid; it is returned
1560 * just as any other value would be.
1563 g_settings_get_mapped (GSettings *settings,
1565 GSettingsGetMapping mapping,
1568 gpointer result = NULL;
1569 GSettingsKeyInfo info;
1573 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1574 g_return_val_if_fail (key != NULL, NULL);
1575 g_return_val_if_fail (mapping != NULL, NULL);
1577 g_settings_get_key_info (&info, settings, key);
1579 if ((value = g_settings_read_from_backend (&info)))
1581 okay = mapping (value, &result, user_data);
1582 g_variant_unref (value);
1583 if (okay) goto okay;
1586 if ((value = g_settings_get_translated_default (&info)))
1588 okay = mapping (value, &result, user_data);
1589 g_variant_unref (value);
1590 if (okay) goto okay;
1593 if (mapping (info.default_value, &result, user_data))
1596 if (!mapping (NULL, &result, user_data))
1597 g_error ("The mapping function given to g_settings_get_mapped() for key "
1598 "`%s' in schema `%s' returned FALSE when given a NULL value.",
1599 key, settings->priv->schema_name);
1602 g_settings_free_key_info (&info);
1607 /* Convenience API (get, set_string, int, double, boolean, strv) {{{1 */
1609 * g_settings_get_string:
1610 * @settings: a #GSettings object
1611 * @key: the key to get the value for
1612 * @returns: a newly-allocated string
1614 * Gets the value that is stored at @key in @settings.
1616 * A convenience variant of g_settings_get() for strings.
1618 * It is a programmer error to give a @key that isn't specified as
1619 * having a string type in the schema for @settings.
1624 g_settings_get_string (GSettings *settings,
1630 value = g_settings_get_value (settings, key);
1631 result = g_variant_dup_string (value, NULL);
1632 g_variant_unref (value);
1638 * g_settings_set_string:
1639 * @settings: a #GSettings object
1640 * @key: the name of the key to set
1641 * @value: the value to set it to
1642 * @returns: %TRUE if setting the key succeeded,
1643 * %FALSE if the key was not writable
1645 * Sets @key in @settings to @value.
1647 * A convenience variant of g_settings_set() for strings.
1649 * It is a programmer error to give a @key that isn't specified as
1650 * having a string type in the schema for @settings.
1655 g_settings_set_string (GSettings *settings,
1659 return g_settings_set_value (settings, key, g_variant_new_string (value));
1663 * g_settings_get_int:
1664 * @settings: a #GSettings object
1665 * @key: the key to get the value for
1666 * @returns: an integer
1668 * Gets the value that is stored at @key in @settings.
1670 * A convenience variant of g_settings_get() for 32-bit integers.
1672 * It is a programmer error to give a @key that isn't specified as
1673 * having a int32 type in the schema for @settings.
1678 g_settings_get_int (GSettings *settings,
1684 value = g_settings_get_value (settings, key);
1685 result = g_variant_get_int32 (value);
1686 g_variant_unref (value);
1692 * g_settings_set_int:
1693 * @settings: a #GSettings object
1694 * @key: the name of the key to set
1695 * @value: the value to set it to
1696 * @returns: %TRUE if setting the key succeeded,
1697 * %FALSE if the key was not writable
1699 * Sets @key in @settings to @value.
1701 * A convenience variant of g_settings_set() for 32-bit integers.
1703 * It is a programmer error to give a @key that isn't specified as
1704 * having a int32 type in the schema for @settings.
1709 g_settings_set_int (GSettings *settings,
1713 return g_settings_set_value (settings, key, g_variant_new_int32 (value));
1717 * g_settings_get_double:
1718 * @settings: a #GSettings object
1719 * @key: the key to get the value for
1720 * @returns: a double
1722 * Gets the value that is stored at @key in @settings.
1724 * A convenience variant of g_settings_get() for doubles.
1726 * It is a programmer error to give a @key that isn't specified as
1727 * having a 'double' type in the schema for @settings.
1732 g_settings_get_double (GSettings *settings,
1738 value = g_settings_get_value (settings, key);
1739 result = g_variant_get_double (value);
1740 g_variant_unref (value);
1746 * g_settings_set_double:
1747 * @settings: a #GSettings object
1748 * @key: the name of the key to set
1749 * @value: the value to set it to
1750 * @returns: %TRUE if setting the key succeeded,
1751 * %FALSE if the key was not writable
1753 * Sets @key in @settings to @value.
1755 * A convenience variant of g_settings_set() for doubles.
1757 * It is a programmer error to give a @key that isn't specified as
1758 * having a 'double' type in the schema for @settings.
1763 g_settings_set_double (GSettings *settings,
1767 return g_settings_set_value (settings, key, g_variant_new_double (value));
1771 * g_settings_get_boolean:
1772 * @settings: a #GSettings object
1773 * @key: the key to get the value for
1774 * @returns: a boolean
1776 * Gets the value that is stored at @key in @settings.
1778 * A convenience variant of g_settings_get() for booleans.
1780 * It is a programmer error to give a @key that isn't specified as
1781 * having a boolean type in the schema for @settings.
1786 g_settings_get_boolean (GSettings *settings,
1792 value = g_settings_get_value (settings, key);
1793 result = g_variant_get_boolean (value);
1794 g_variant_unref (value);
1800 * g_settings_set_boolean:
1801 * @settings: a #GSettings object
1802 * @key: the name of the key to set
1803 * @value: the value to set it to
1804 * @returns: %TRUE if setting the key succeeded,
1805 * %FALSE if the key was not writable
1807 * Sets @key in @settings to @value.
1809 * A convenience variant of g_settings_set() for booleans.
1811 * It is a programmer error to give a @key that isn't specified as
1812 * having a boolean type in the schema for @settings.
1817 g_settings_set_boolean (GSettings *settings,
1821 return g_settings_set_value (settings, key, g_variant_new_boolean (value));
1825 * g_settings_get_strv:
1826 * @settings: a #GSettings object
1827 * @key: the key to get the value for
1828 * @returns: a newly-allocated, %NULL-terminated array of strings
1830 * A convenience variant of g_settings_get() for string arrays.
1832 * It is a programmer error to give a @key that isn't specified as
1833 * having an array of strings type in the schema for @settings.
1835 * Returns: (array zero-terminated=1) (transfer full): the value that is
1836 * stored at @key in @settings.
1841 g_settings_get_strv (GSettings *settings,
1847 value = g_settings_get_value (settings, key);
1848 result = g_variant_dup_strv (value, NULL);
1849 g_variant_unref (value);
1855 * g_settings_set_strv:
1856 * @settings: a #GSettings object
1857 * @key: the name of the key to set
1858 * @value: (allow-none) (array zero-terminated=1): the value to set it to, or %NULL
1859 * @returns: %TRUE if setting the key succeeded,
1860 * %FALSE if the key was not writable
1862 * Sets @key in @settings to @value.
1864 * A convenience variant of g_settings_set() for string arrays. If
1865 * @value is %NULL, then @key is set to be the empty array.
1867 * It is a programmer error to give a @key that isn't specified as
1868 * having an array of strings type in the schema for @settings.
1873 g_settings_set_strv (GSettings *settings,
1875 const gchar * const *value)
1880 array = g_variant_new_strv (value, -1);
1882 array = g_variant_new_strv (NULL, 0);
1884 return g_settings_set_value (settings, key, array);
1887 /* Delayed apply (delay, apply, revert, get_has_unapplied) {{{1 */
1890 * @settings: a #GSettings object
1892 * Changes the #GSettings object into 'delay-apply' mode. In this
1893 * mode, changes to @settings are not immediately propagated to the
1894 * backend, but kept locally until g_settings_apply() is called.
1899 g_settings_delay (GSettings *settings)
1901 g_return_if_fail (G_IS_SETTINGS (settings));
1903 if (settings->priv->delayed)
1906 settings->priv->delayed =
1907 g_delayed_settings_backend_new (settings->priv->backend,
1909 settings->priv->main_context);
1910 g_settings_backend_unwatch (settings->priv->backend, G_OBJECT (settings));
1911 g_object_unref (settings->priv->backend);
1913 settings->priv->backend = G_SETTINGS_BACKEND (settings->priv->delayed);
1914 g_settings_backend_watch (settings->priv->backend,
1915 &listener_vtable, G_OBJECT (settings),
1916 settings->priv->main_context);
1921 * @settings: a #GSettings instance
1923 * Applies any changes that have been made to the settings. This
1924 * function does nothing unless @settings is in 'delay-apply' mode;
1925 * see g_settings_delay(). In the normal case settings are always
1926 * applied immediately.
1929 g_settings_apply (GSettings *settings)
1931 if (settings->priv->delayed)
1933 GDelayedSettingsBackend *delayed;
1935 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
1936 g_delayed_settings_backend_apply (delayed);
1941 * g_settings_revert:
1942 * @settings: a #GSettings instance
1944 * Reverts all non-applied changes to the settings. This function
1945 * does nothing unless @settings is in 'delay-apply' mode; see
1946 * g_settings_delay(). In the normal case settings are always applied
1949 * Change notifications will be emitted for affected keys.
1952 g_settings_revert (GSettings *settings)
1954 if (settings->priv->delayed)
1956 GDelayedSettingsBackend *delayed;
1958 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
1959 g_delayed_settings_backend_revert (delayed);
1964 * g_settings_get_has_unapplied:
1965 * @settings: a #GSettings object
1966 * @returns: %TRUE if @settings has unapplied changes
1968 * Returns whether the #GSettings object has any unapplied
1969 * changes. This can only be the case if it is in 'delayed-apply' mode.
1974 g_settings_get_has_unapplied (GSettings *settings)
1976 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1978 return settings->priv->delayed &&
1979 g_delayed_settings_backend_get_has_unapplied (
1980 G_DELAYED_SETTINGS_BACKEND (settings->priv->backend));
1983 /* Extra API (reset, sync, get_child, is_writable, list_*) {{{1 */
1986 * @settings: a #GSettings object
1987 * @key: the name of a key
1989 * Resets @key to its default value.
1991 * This call resets the key, as much as possible, to its default value.
1992 * That might the value specified in the schema or the one set by the
1996 g_settings_reset (GSettings *settings,
2001 path = g_strconcat (settings->priv->path, key, NULL);
2002 g_settings_backend_reset (settings->priv->backend, path, NULL);
2009 * Ensures that all pending operations for the given are complete for
2010 * the default backend.
2012 * Writes made to a #GSettings are handled asynchronously. For this
2013 * reason, it is very unlikely that the changes have it to disk by the
2014 * time g_settings_set() returns.
2016 * This call will block until all of the writes have made it to the
2017 * backend. Since the mainloop is not running, no change notifications
2018 * will be dispatched during this call (but some may be queued by the
2019 * time the call is done).
2022 g_settings_sync (void)
2024 g_settings_backend_sync_default ();
2028 * g_settings_is_writable:
2029 * @settings: a #GSettings object
2030 * @name: the name of a key
2031 * @returns: %TRUE if the key @name is writable
2033 * Finds out if a key can be written or not
2038 g_settings_is_writable (GSettings *settings,
2044 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
2046 path = g_strconcat (settings->priv->path, name, NULL);
2047 writable = g_settings_backend_get_writable (settings->priv->backend, path);
2054 * g_settings_get_child:
2055 * @settings: a #GSettings object
2056 * @name: the name of the 'child' schema
2057 * @returns: (transfer full): a 'child' settings object
2059 * Creates a 'child' settings object which has a base path of
2060 * <replaceable>base-path</replaceable>/@name", where
2061 * <replaceable>base-path</replaceable> is the base path of @settings.
2063 * The schema for the child settings object must have been declared
2064 * in the schema of @settings using a <tag class="starttag">child</tag> element.
2069 g_settings_get_child (GSettings *settings,
2072 const gchar *child_schema;
2077 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
2079 child_name = g_strconcat (name, "/", NULL);
2080 child_schema = g_settings_schema_get_string (settings->priv->schema,
2082 if (child_schema == NULL)
2083 g_error ("Schema '%s' has no child '%s'",
2084 settings->priv->schema_name, name);
2086 child_path = g_strconcat (settings->priv->path, child_name, NULL);
2087 child = g_object_new (G_TYPE_SETTINGS,
2088 "schema", child_schema,
2091 g_free (child_path);
2092 g_free (child_name);
2098 * g_settings_list_keys:
2099 * @settings: a #GSettings object
2100 * @returns: (transfer full) (element-type utf8): a list of the keys on @settings
2102 * Introspects the list of keys on @settings.
2104 * You should probably not be calling this function from "normal" code
2105 * (since you should already know what keys are in your schema). This
2106 * function is intended for introspection reasons.
2108 * You should free the return value with g_strfreev() when you are done
2112 g_settings_list_keys (GSettings *settings)
2119 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2120 strv = g_new (gchar *, n_keys + 1);
2121 for (i = j = 0; i < n_keys; i++)
2123 const gchar *key = g_quark_to_string (keys[i]);
2125 if (!g_str_has_suffix (key, "/"))
2126 strv[j++] = g_strdup (key);
2134 * g_settings_list_children:
2135 * @settings: a #GSettings object
2136 * @returns: (transfer full) (element-type utf8): a list of the children on @settings
2138 * Gets the list of children on @settings.
2140 * The list is exactly the list of strings for which it is not an error
2141 * to call g_settings_get_child().
2143 * For GSettings objects that are lists, this value can change at any
2144 * time and you should connect to the "children-changed" signal to watch
2145 * for those changes. Note that there is a race condition here: you may
2146 * request a child after listing it only for it to have been destroyed
2147 * in the meantime. For this reason, g_settings_get_chuld() may return
2148 * %NULL even for a child that was listed by this function.
2150 * For GSettings objects that are not lists, you should probably not be
2151 * calling this function from "normal" code (since you should already
2152 * know what children are in your schema). This function may still be
2153 * useful there for introspection reasons, however.
2155 * You should free the return value with g_strfreev() when you are done
2159 g_settings_list_children (GSettings *settings)
2166 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2167 strv = g_new (gchar *, n_keys + 1);
2168 for (i = j = 0; i < n_keys; i++)
2170 const gchar *key = g_quark_to_string (keys[i]);
2172 if (g_str_has_suffix (key, "/"))
2174 gint length = strlen (key);
2176 strv[j] = g_memdup (key, length);
2177 strv[j][length - 1] = '\0';
2189 GSettingsKeyInfo info;
2192 GSettingsBindGetMapping get_mapping;
2193 GSettingsBindSetMapping set_mapping;
2195 GDestroyNotify destroy;
2197 guint writable_handler_id;
2198 guint property_handler_id;
2199 const GParamSpec *property;
2200 guint key_handler_id;
2202 /* prevent recursion */
2207 g_settings_binding_free (gpointer data)
2209 GSettingsBinding *binding = data;
2211 g_assert (!binding->running);
2213 if (binding->writable_handler_id)
2214 g_signal_handler_disconnect (binding->info.settings,
2215 binding->writable_handler_id);
2217 if (binding->key_handler_id)
2218 g_signal_handler_disconnect (binding->info.settings,
2219 binding->key_handler_id);
2221 if (g_signal_handler_is_connected (binding->object,
2222 binding->property_handler_id))
2223 g_signal_handler_disconnect (binding->object,
2224 binding->property_handler_id);
2226 g_settings_free_key_info (&binding->info);
2228 if (binding->destroy)
2229 binding->destroy (binding->user_data);
2231 g_slice_free (GSettingsBinding, binding);
2235 g_settings_binding_quark (const char *property)
2240 tmp = g_strdup_printf ("gsettingsbinding-%s", property);
2241 quark = g_quark_from_string (tmp);
2248 g_settings_binding_key_changed (GSettings *settings,
2252 GSettingsBinding *binding = user_data;
2253 GValue value = { 0, };
2256 g_assert (settings == binding->info.settings);
2257 g_assert (key == binding->info.key);
2259 if (binding->running)
2262 binding->running = TRUE;
2264 g_value_init (&value, binding->property->value_type);
2266 variant = g_settings_read_from_backend (&binding->info);
2267 if (variant && !binding->get_mapping (&value, variant, binding->user_data))
2269 /* silently ignore errors in the user's config database */
2270 g_variant_unref (variant);
2274 if (variant == NULL)
2276 variant = g_settings_get_translated_default (&binding->info);
2278 !binding->get_mapping (&value, variant, binding->user_data))
2280 /* flag translation errors with a warning */
2281 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
2282 "was rejected by the binding mapping function",
2283 binding->info.unparsed, binding->info.key,
2284 binding->info.settings->priv->schema_name);
2285 g_variant_unref (variant);
2290 if (variant == NULL)
2292 variant = g_variant_ref (binding->info.default_value);
2293 if (!binding->get_mapping (&value, variant, binding->user_data))
2294 g_error ("The schema default value for key `%s' in schema `%s' "
2295 "was rejected by the binding mapping function.",
2297 binding->info.settings->priv->schema_name);
2300 g_object_set_property (binding->object, binding->property->name, &value);
2301 g_variant_unref (variant);
2302 g_value_unset (&value);
2304 binding->running = FALSE;
2308 g_settings_binding_property_changed (GObject *object,
2309 const GParamSpec *pspec,
2312 GSettingsBinding *binding = user_data;
2313 GValue value = { 0, };
2316 g_assert (object == binding->object);
2317 g_assert (pspec == binding->property);
2319 if (binding->running)
2322 binding->running = TRUE;
2324 g_value_init (&value, pspec->value_type);
2325 g_object_get_property (object, pspec->name, &value);
2326 if ((variant = binding->set_mapping (&value, binding->info.type,
2327 binding->user_data)))
2329 if (g_variant_is_floating (variant))
2330 g_variant_ref_sink (variant);
2332 if (!g_settings_type_check (&binding->info, variant))
2334 g_critical ("binding mapping function for key `%s' returned "
2335 "GVariant of type `%s' when type `%s' was requested",
2336 binding->info.key, g_variant_get_type_string (variant),
2337 g_variant_type_dup_string (binding->info.type));
2341 if (!g_settings_range_check (&binding->info, variant))
2343 g_critical ("GObject property `%s' on a `%s' object is out of "
2344 "schema-specified range for key `%s' of `%s': %s",
2345 binding->property->name,
2346 g_type_name (binding->property->owner_type),
2348 binding->info.settings->priv->schema_name,
2349 g_variant_print (variant, TRUE));
2353 g_settings_write_to_backend (&binding->info, variant);
2354 g_variant_unref (variant);
2356 g_value_unset (&value);
2358 binding->running = FALSE;
2362 g_settings_bind_invert_boolean_get_mapping (GValue *value,
2366 g_value_set_boolean (value, !g_variant_get_boolean (variant));
2371 g_settings_bind_invert_boolean_set_mapping (const GValue *value,
2372 const GVariantType *expected_type,
2375 return g_variant_new_boolean (!g_value_get_boolean (value));
2380 * @settings: a #GSettings object
2381 * @key: the key to bind
2382 * @object: a #GObject
2383 * @property: the name of the property to bind
2384 * @flags: flags for the binding
2386 * Create a binding between the @key in the @settings object
2387 * and the property @property of @object.
2389 * The binding uses the default GIO mapping functions to map
2390 * between the settings and property values. These functions
2391 * handle booleans, numeric types and string types in a
2392 * straightforward way. Use g_settings_bind_with_mapping() if
2393 * you need a custom mapping, or map between types that are not
2394 * supported by the default mapping functions.
2396 * Unless the @flags include %G_SETTINGS_BIND_NO_SENSITIVITY, this
2397 * function also establishes a binding between the writability of
2398 * @key and the "sensitive" property of @object (if @object has
2399 * a boolean property by that name). See g_settings_bind_writable()
2400 * for more details about writable bindings.
2402 * Note that the lifecycle of the binding is tied to the object,
2403 * and that you can have only one binding per object property.
2404 * If you bind the same property twice on the same object, the second
2405 * binding overrides the first one.
2410 g_settings_bind (GSettings *settings,
2413 const gchar *property,
2414 GSettingsBindFlags flags)
2416 GSettingsBindGetMapping get_mapping = NULL;
2417 GSettingsBindSetMapping set_mapping = NULL;
2419 if (flags & G_SETTINGS_BIND_INVERT_BOOLEAN)
2421 get_mapping = g_settings_bind_invert_boolean_get_mapping;
2422 set_mapping = g_settings_bind_invert_boolean_set_mapping;
2424 /* can't pass this flag to g_settings_bind_with_mapping() */
2425 flags &= ~G_SETTINGS_BIND_INVERT_BOOLEAN;
2428 g_settings_bind_with_mapping (settings, key, object, property, flags,
2429 get_mapping, set_mapping, NULL, NULL);
2433 * g_settings_bind_with_mapping:
2434 * @settings: a #GSettings object
2435 * @key: the key to bind
2436 * @object: a #GObject
2437 * @property: the name of the property to bind
2438 * @flags: flags for the binding
2439 * @get_mapping: a function that gets called to convert values
2440 * from @settings to @object, or %NULL to use the default GIO mapping
2441 * @set_mapping: a function that gets called to convert values
2442 * from @object to @settings, or %NULL to use the default GIO mapping
2443 * @user_data: data that gets passed to @get_mapping and @set_mapping
2444 * @destroy: #GDestroyNotify function for @user_data
2446 * Create a binding between the @key in the @settings object
2447 * and the property @property of @object.
2449 * The binding uses the provided mapping functions to map between
2450 * settings and property values.
2452 * Note that the lifecycle of the binding is tied to the object,
2453 * and that you can have only one binding per object property.
2454 * If you bind the same property twice on the same object, the second
2455 * binding overrides the first one.
2460 g_settings_bind_with_mapping (GSettings *settings,
2463 const gchar *property,
2464 GSettingsBindFlags flags,
2465 GSettingsBindGetMapping get_mapping,
2466 GSettingsBindSetMapping set_mapping,
2468 GDestroyNotify destroy)
2470 GSettingsBinding *binding;
2471 GObjectClass *objectclass;
2472 gchar *detailed_signal;
2473 GQuark binding_quark;
2475 g_return_if_fail (G_IS_SETTINGS (settings));
2476 g_return_if_fail (~flags & G_SETTINGS_BIND_INVERT_BOOLEAN);
2478 objectclass = G_OBJECT_GET_CLASS (object);
2480 binding = g_slice_new0 (GSettingsBinding);
2481 g_settings_get_key_info (&binding->info, settings, key);
2482 binding->object = object;
2483 binding->property = g_object_class_find_property (objectclass, property);
2484 binding->user_data = user_data;
2485 binding->destroy = destroy;
2486 binding->get_mapping = get_mapping ? get_mapping : g_settings_get_mapping;
2487 binding->set_mapping = set_mapping ? set_mapping : g_settings_set_mapping;
2489 if (!(flags & (G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET)))
2490 flags |= G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET;
2492 if (binding->property == NULL)
2494 g_critical ("g_settings_bind: no property '%s' on class '%s'",
2495 property, G_OBJECT_TYPE_NAME (object));
2499 if ((flags & G_SETTINGS_BIND_GET) &&
2500 (binding->property->flags & G_PARAM_WRITABLE) == 0)
2502 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2503 "writable", property, G_OBJECT_TYPE_NAME (object));
2506 if ((flags & G_SETTINGS_BIND_SET) &&
2507 (binding->property->flags & G_PARAM_READABLE) == 0)
2509 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2510 "readable", property, G_OBJECT_TYPE_NAME (object));
2514 if (get_mapping == g_settings_bind_invert_boolean_get_mapping)
2516 /* g_settings_bind_invert_boolean_get_mapping() is a private
2517 * function, so if we are here it means that g_settings_bind() was
2518 * called with G_SETTINGS_BIND_INVERT_BOOLEAN.
2520 * Ensure that both sides are boolean.
2523 if (binding->property->value_type != G_TYPE_BOOLEAN)
2525 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2526 "was specified, but property `%s' on type `%s' has "
2527 "type `%s'", property, G_OBJECT_TYPE_NAME (object),
2528 g_type_name ((binding->property->value_type)));
2532 if (!g_variant_type_equal (binding->info.type, G_VARIANT_TYPE_BOOLEAN))
2534 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2535 "was specified, but key `%s' on schema `%s' has "
2536 "type `%s'", key, settings->priv->schema_name,
2537 g_variant_type_dup_string (binding->info.type));
2543 else if (((get_mapping == NULL && (flags & G_SETTINGS_BIND_GET)) ||
2544 (set_mapping == NULL && (flags & G_SETTINGS_BIND_SET))) &&
2545 !g_settings_mapping_is_compatible (binding->property->value_type,
2546 binding->info.type))
2548 g_critical ("g_settings_bind: property '%s' on class '%s' has type "
2549 "'%s' which is not compatible with type '%s' of key '%s' "
2550 "on schema '%s'", property, G_OBJECT_TYPE_NAME (object),
2551 g_type_name (binding->property->value_type),
2552 g_variant_type_dup_string (binding->info.type), key,
2553 settings->priv->schema_name);
2557 if ((flags & G_SETTINGS_BIND_SET) &&
2558 (~flags & G_SETTINGS_BIND_NO_SENSITIVITY))
2560 GParamSpec *sensitive;
2562 sensitive = g_object_class_find_property (objectclass, "sensitive");
2564 if (sensitive && sensitive->value_type == G_TYPE_BOOLEAN &&
2565 (sensitive->flags & G_PARAM_WRITABLE))
2566 g_settings_bind_writable (settings, binding->info.key,
2567 object, "sensitive", FALSE);
2570 if (flags & G_SETTINGS_BIND_SET)
2572 detailed_signal = g_strdup_printf ("notify::%s", property);
2573 binding->property_handler_id =
2574 g_signal_connect (object, detailed_signal,
2575 G_CALLBACK (g_settings_binding_property_changed),
2577 g_free (detailed_signal);
2579 if (~flags & G_SETTINGS_BIND_GET)
2580 g_settings_binding_property_changed (object,
2585 if (flags & G_SETTINGS_BIND_GET)
2587 if (~flags & G_SETTINGS_BIND_GET_NO_CHANGES)
2589 detailed_signal = g_strdup_printf ("changed::%s", key);
2590 binding->key_handler_id =
2591 g_signal_connect (settings, detailed_signal,
2592 G_CALLBACK (g_settings_binding_key_changed),
2594 g_free (detailed_signal);
2597 g_settings_binding_key_changed (settings, binding->info.key, binding);
2600 binding_quark = g_settings_binding_quark (property);
2601 g_object_set_qdata_full (object, binding_quark,
2602 binding, g_settings_binding_free);
2605 /* Writability binding {{{1 */
2608 GSettings *settings;
2611 const gchar *property;
2614 } GSettingsWritableBinding;
2617 g_settings_writable_binding_free (gpointer data)
2619 GSettingsWritableBinding *binding = data;
2621 g_signal_handler_disconnect (binding->settings, binding->handler_id);
2622 g_object_unref (binding->settings);
2623 g_slice_free (GSettingsWritableBinding, binding);
2627 g_settings_binding_writable_changed (GSettings *settings,
2631 GSettingsWritableBinding *binding = user_data;
2634 g_assert (settings == binding->settings);
2635 g_assert (key == binding->key);
2637 writable = g_settings_is_writable (settings, key);
2639 if (binding->inverted)
2640 writable = !writable;
2642 g_object_set (binding->object, binding->property, writable, NULL);
2646 * g_settings_bind_writable:
2647 * @settings: a #GSettings object
2648 * @key: the key to bind
2649 * @object: a #GObject
2650 * @property: the name of a boolean property to bind
2651 * @inverted: whether to 'invert' the value
2653 * Create a binding between the writability of @key in the
2654 * @settings object and the property @property of @object.
2655 * The property must be boolean; "sensitive" or "visible"
2656 * properties of widgets are the most likely candidates.
2658 * Writable bindings are always uni-directional; changes of the
2659 * writability of the setting will be propagated to the object
2660 * property, not the other way.
2662 * When the @inverted argument is %TRUE, the binding inverts the
2663 * value as it passes from the setting to the object, i.e. @property
2664 * will be set to %TRUE if the key is <emphasis>not</emphasis>
2667 * Note that the lifecycle of the binding is tied to the object,
2668 * and that you can have only one binding per object property.
2669 * If you bind the same property twice on the same object, the second
2670 * binding overrides the first one.
2675 g_settings_bind_writable (GSettings *settings,
2678 const gchar *property,
2681 GSettingsWritableBinding *binding;
2682 gchar *detailed_signal;
2685 g_return_if_fail (G_IS_SETTINGS (settings));
2687 pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
2690 g_critical ("g_settings_bind_writable: no property '%s' on class '%s'",
2691 property, G_OBJECT_TYPE_NAME (object));
2694 if ((pspec->flags & G_PARAM_WRITABLE) == 0)
2696 g_critical ("g_settings_bind_writable: property '%s' on class '%s' is not writable",
2697 property, G_OBJECT_TYPE_NAME (object));
2701 binding = g_slice_new (GSettingsWritableBinding);
2702 binding->settings = g_object_ref (settings);
2703 binding->object = object;
2704 binding->key = g_intern_string (key);
2705 binding->property = g_intern_string (property);
2706 binding->inverted = inverted;
2708 detailed_signal = g_strdup_printf ("writable-changed::%s", key);
2709 binding->handler_id =
2710 g_signal_connect (settings, detailed_signal,
2711 G_CALLBACK (g_settings_binding_writable_changed),
2713 g_free (detailed_signal);
2715 g_object_set_qdata_full (object, g_settings_binding_quark (property),
2716 binding, g_settings_writable_binding_free);
2718 g_settings_binding_writable_changed (settings, binding->key, binding);
2722 * g_settings_unbind:
2723 * @object: the object
2724 * @property: the property whose binding is removed
2726 * Removes an existing binding for @property on @object.
2728 * Note that bindings are automatically removed when the
2729 * object is finalized, so it is rarely necessary to call this
2735 g_settings_unbind (gpointer object,
2736 const gchar *property)
2738 GQuark binding_quark;
2740 binding_quark = g_settings_binding_quark (property);
2741 g_object_set_qdata (object, binding_quark, NULL);
2746 /* vim:set foldmethod=marker: */