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>
29 #include "gsettings.h"
31 #include "gdelayedsettingsbackend.h"
32 #include "gsettingsbackendinternal.h"
33 #include "gsettings-mapping.h"
34 #include "gsettingsschema.h"
43 * @short_description: High-level API for application settings
45 * The #GSettings class provides a convenient API for storing and retrieving
46 * application settings.
48 * Reads and writes can be considered to be non-blocking. Reading
49 * settings with #GSettings is typically extremely fast: on
50 * approximately the same order of magnitude (but slower than) a
51 * #GHashTable lookup. Writing settings is also extremely fast in terms
52 * of time to return to your application, but can be extremely expensive
53 * for other threads and other processes. Many settings backends
54 * (including dconf) have lazy initialisation which means in the common
55 * case of the user using their computer without modifying any settings
56 * a lot of work can be avoided. For dconf, the D-Bus service doesn't
57 * even need to be started in this case. For this reason, you should
58 * only ever modify #GSettings keys in response to explicit user action.
59 * Particular care should be paid to ensure that modifications are not
60 * made during startup -- for example, when setting the initial value
61 * of preferences widgets. The built-in g_settings_bind() functionality
62 * is careful not to write settings in response to notify signals as a
63 * result of modifications that it makes to widgets.
65 * When creating a GSettings instance, you have to specify a schema
66 * that describes the keys in your settings and their types and default
67 * values, as well as some other information.
69 * Normally, a schema has as fixed path that determines where the settings
70 * are stored in the conceptual global tree of settings. However, schemas
71 * can also be 'relocatable', i.e. not equipped with a fixed path. This is
72 * useful e.g. when the schema describes an 'account', and you want to be
73 * able to store a arbitrary number of accounts.
75 * Unlike other configuration systems (like GConf), GSettings does not
76 * restrict keys to basic types like strings and numbers. GSettings stores
77 * values as #GVariant, and allows any #GVariantType for keys. Key names
78 * are restricted to lowercase characters, numbers and '-'. Furthermore,
79 * the names must begin with a lowercase character, must not end
80 * with a '-', and must not contain consecutive dashes.
82 * Similar to GConf, the default values in GSettings schemas can be
83 * localized, but the localized values are stored in gettext catalogs
84 * and looked up with the domain that is specified in the
85 * <tag class="attribute">gettext-domain</tag> attribute of the
86 * <tag class="starttag">schemalist</tag> or <tag class="starttag">schema</tag>
87 * elements and the category that is specified in the l10n attribute of the
88 * <tag class="starttag">key</tag> element.
90 * GSettings uses schemas in a compact binary form that is created
91 * by the <link linkend="glib-compile-schemas">glib-compile-schemas</link>
92 * utility. The input is a schema description in an XML format that can be
93 * described by the following DTD:
94 * |[<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>]|
96 * glib-compile-schemas expects schema files to have the extension <filename>.gschema.xml</filename>
98 * At runtime, schemas are identified by their id (as specified
99 * in the <tag class="attribute">id</tag> attribute of the
100 * <tag class="starttag">schema</tag> element). The
101 * convention for schema ids is to use a dotted name, similar in
102 * style to a D-Bus bus name, e.g. "org.gnome.SessionManager". In particular,
103 * if the settings are for a specific service that owns a D-Bus bus name,
104 * the D-Bus bus name and schema id should match. For schemas which deal
105 * with settings not associated with one named application, the id should
106 * not use StudlyCaps, e.g. "org.gnome.font-rendering".
108 * In addition to #GVariant types, keys can have types that have enumerated
109 * types. These can be described by a <tag class="starttag">choice</tag>,
110 * <tag class="starttag">enum</tag> or <tag class="starttag">flags</tag> element, see
111 * <xref linkend="schema-enumerated"/>. The underlying type of
112 * such a key is string, but you can use g_settings_get_enum(),
113 * g_settings_set_enum(), g_settings_get_flags(), g_settings_set_flags()
114 * access the numeric values corresponding to the string value of enum
117 * <example id="schema-default-values"><title>Default values</title>
118 * <programlisting><![CDATA[
120 * <schema id="org.gtk.Test" path="/tests/" gettext-domain="test">
122 * <key name="greeting" type="s">
123 * <default l10n="messages">"Hello, earthlings"</default>
124 * <summary>A greeting</summary>
126 * Greeting of the invading martians
130 * <key name="box" type="(ii)">
131 * <default>(20,30)</default>
136 * ]]></programlisting></example>
138 * <example id="schema-enumerated"><title>Ranges, choices and enumerated types</title>
139 * <programlisting><![CDATA[
142 * <enum id="org.gtk.Test.myenum">
143 * <value nick="first" value="1"/>
144 * <value nick="second" value="2"/>
147 * <flags id="org.gtk.Test.myflags">
148 * <value nick="flag1" value="1"/>
149 * <value nick="flag2" value="2"/>
150 * <value nick="flag3" value="4"/>
153 * <schema id="org.gtk.Test">
155 * <key name="key-with-range" type="i">
156 * <range min="1" max="100"/>
157 * <default>10</default>
160 * <key name="key-with-choices" type="s">
162 * <choice value='Elisabeth'/>
163 * <choice value='Annabeth'/>
164 * <choice value='Joe'/>
167 * <alias value='Anna' target='Annabeth'/>
168 * <alias value='Beth' target='Elisabeth'/>
170 * <default>'Joe'</default>
173 * <key name='enumerated-key' enum='org.gtk.Test.myenum'>
174 * <default>'first'</default>
177 * <key name='flags-key' flags='org.gtk.Test.myflags'>
178 * <default>["flag1",flag2"]</default>
182 * ]]></programlisting></example>
185 * <title>Vendor overrides</title>
187 * Default values are defined in the schemas that get installed by
188 * an application. Sometimes, it is necessary for a vendor or distributor
189 * to adjust these defaults. Since patching the XML source for the schema
190 * is inconvenient and error-prone,
191 * <link linkend="glib-compile-schemas">glib-compile-schemas</link> reads
192 * so-called 'vendor override' files. These are keyfiles in the same
193 * directory as the XML schema sources which can override default values.
194 * The schema id serves as the group name in the key file, and the values
195 * are expected in serialized GVariant form, as in the following example:
196 * <informalexample><programlisting>
200 * </programlisting></informalexample>
203 * glib-compile-schemas expects schema files to have the extension
204 * <filename>.gschema.override</filename>
209 * <title>Binding</title>
211 * A very convenient feature of GSettings lets you bind #GObject properties
212 * directly to settings, using g_settings_bind(). Once a GObject property
213 * has been bound to a setting, changes on either side are automatically
214 * propagated to the other side. GSettings handles details like
215 * mapping between GObject and GVariant types, and preventing infinite
219 * This makes it very easy to hook up a preferences dialog to the
220 * underlying settings. To make this even more convenient, GSettings
221 * looks for a boolean property with the name "sensitivity" and
222 * automatically binds it to the writability of the bound setting.
223 * If this 'magic' gets in the way, it can be suppressed with the
224 * #G_SETTINGS_BIND_NO_SENSITIVITY flag.
229 struct _GSettingsPrivate
231 /* where the signals go... */
232 GMainContext *main_context;
234 GSettingsBackend *backend;
235 GSettingsSchema *schema;
239 GDelayedSettingsBackend *delayed;
254 SIGNAL_WRITABLE_CHANGE_EVENT,
255 SIGNAL_WRITABLE_CHANGED,
261 static guint g_settings_signals[N_SIGNALS];
263 G_DEFINE_TYPE (GSettings, g_settings, G_TYPE_OBJECT)
267 g_settings_real_change_event (GSettings *settings,
274 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
276 for (i = 0; i < n_keys; i++)
277 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGED],
278 keys[i], g_quark_to_string (keys[i]));
284 g_settings_real_writable_change_event (GSettings *settings,
287 const GQuark *keys = &key;
292 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
294 for (i = 0; i < n_keys; i++)
295 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGED],
296 keys[i], g_quark_to_string (keys[i]));
302 settings_backend_changed (GObject *target,
303 GSettingsBackend *backend,
307 GSettings *settings = G_SETTINGS (target);
308 gboolean ignore_this;
311 /* We used to assert here:
313 * settings->priv->backend == backend
315 * but it could be the case that a notification is queued for delivery
316 * while someone calls g_settings_delay() (which changes the backend).
318 * Since the delay backend would just pass that straight through
319 * anyway, it doesn't make sense to try to detect this case.
320 * Therefore, we just accept it.
323 for (i = 0; key[i] == settings->priv->path[i]; i++);
325 if (settings->priv->path[i] == '\0' &&
326 g_settings_schema_has_key (settings->priv->schema, key + i))
330 quark = g_quark_from_string (key + i);
331 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
332 0, &quark, 1, &ignore_this);
337 settings_backend_path_changed (GObject *target,
338 GSettingsBackend *backend,
342 GSettings *settings = G_SETTINGS (target);
343 gboolean ignore_this;
345 if (g_str_has_prefix (settings->priv->path, path))
346 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
347 0, NULL, 0, &ignore_this);
351 settings_backend_keys_changed (GObject *target,
352 GSettingsBackend *backend,
354 const gchar * const *items,
357 GSettings *settings = G_SETTINGS (target);
358 gboolean ignore_this;
361 for (i = 0; settings->priv->path[i] &&
362 settings->priv->path[i] == path[i]; i++);
369 for (j = 0; items[j]; j++)
371 const gchar *item = items[j];
374 for (k = 0; item[k] == settings->priv->path[i + k]; k++);
376 if (settings->priv->path[i + k] == '\0' &&
377 g_settings_schema_has_key (settings->priv->schema, item + k))
378 quarks[l++] = g_quark_from_string (item + k);
380 /* "256 quarks ought to be enough for anybody!"
381 * If this bites you, I'm sorry. Please file a bug.
387 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
388 0, quarks, l, &ignore_this);
393 settings_backend_writable_changed (GObject *target,
394 GSettingsBackend *backend,
397 GSettings *settings = G_SETTINGS (target);
398 gboolean ignore_this;
401 for (i = 0; key[i] == settings->priv->path[i]; i++);
403 if (settings->priv->path[i] == '\0' &&
404 g_settings_schema_has_key (settings->priv->schema, key + i))
405 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
406 0, g_quark_from_string (key + i), &ignore_this);
410 settings_backend_path_writable_changed (GObject *target,
411 GSettingsBackend *backend,
414 GSettings *settings = G_SETTINGS (target);
415 gboolean ignore_this;
417 if (g_str_has_prefix (settings->priv->path, path))
418 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
419 0, (GQuark) 0, &ignore_this);
422 /* Properties, Construction, Destruction {{{1 */
424 g_settings_set_property (GObject *object,
429 GSettings *settings = G_SETTINGS (object);
434 g_assert (settings->priv->schema_name == NULL);
435 settings->priv->schema_name = g_value_dup_string (value);
439 settings->priv->path = g_value_dup_string (value);
443 settings->priv->backend = g_value_dup_object (value);
447 g_assert_not_reached ();
452 g_settings_get_property (GObject *object,
457 GSettings *settings = G_SETTINGS (object);
462 g_value_set_string (value, settings->priv->schema_name);
466 g_value_set_object (value, settings->priv->backend);
470 g_value_set_string (value, settings->priv->path);
473 case PROP_HAS_UNAPPLIED:
474 g_value_set_boolean (value, g_settings_get_has_unapplied (settings));
477 case PROP_DELAY_APPLY:
478 g_value_set_boolean (value, settings->priv->delayed != NULL);
482 g_assert_not_reached ();
486 static const GSettingsListenerVTable listener_vtable = {
487 settings_backend_changed,
488 settings_backend_path_changed,
489 settings_backend_keys_changed,
490 settings_backend_writable_changed,
491 settings_backend_path_writable_changed
495 g_settings_constructed (GObject *object)
497 GSettings *settings = G_SETTINGS (object);
498 const gchar *schema_path;
500 settings->priv->schema = g_settings_schema_new (settings->priv->schema_name);
502 if (settings->priv->schema == NULL)
505 schema_path = g_settings_schema_get_path (settings->priv->schema);
507 if (settings->priv->path && schema_path && strcmp (settings->priv->path, schema_path) != 0)
509 g_critical ("settings object created with schema '%s' and path '%s', but "
510 "path '%s' is specified by schema",
511 settings->priv->schema_name, settings->priv->path, schema_path);
515 if (settings->priv->path == NULL)
517 if (schema_path == NULL)
519 g_critical ("attempting to create schema '%s' without a path",
520 settings->priv->schema_name);
524 settings->priv->path = g_strdup (schema_path);
527 if (settings->priv->backend == NULL)
528 settings->priv->backend = g_settings_backend_get_default ();
530 g_settings_backend_watch (settings->priv->backend,
531 &listener_vtable, G_OBJECT (settings),
532 settings->priv->main_context);
533 g_settings_backend_subscribe (settings->priv->backend,
534 settings->priv->path);
538 if (settings->priv->schema != NULL)
539 g_object_unref (settings->priv->schema);
540 settings->priv->schema = NULL;
542 g_free (settings->priv->path);
543 settings->priv->path = NULL;
545 if (settings->priv->backend != NULL)
546 g_object_unref (settings->priv->backend);
547 settings->priv->backend = NULL;
551 g_settings_finalize (GObject *object)
553 GSettings *settings = G_SETTINGS (object);
555 g_settings_backend_unsubscribe (settings->priv->backend,
556 settings->priv->path);
557 g_main_context_unref (settings->priv->main_context);
558 g_object_unref (settings->priv->backend);
559 g_object_unref (settings->priv->schema);
560 g_free (settings->priv->schema_name);
561 g_free (settings->priv->path);
563 G_OBJECT_CLASS (g_settings_parent_class)->finalize (object);
567 g_settings_init (GSettings *settings)
569 settings->priv = G_TYPE_INSTANCE_GET_PRIVATE (settings,
573 settings->priv->main_context = g_main_context_get_thread_default ();
575 if (settings->priv->main_context == NULL)
576 settings->priv->main_context = g_main_context_default ();
578 g_main_context_ref (settings->priv->main_context);
582 g_settings_class_init (GSettingsClass *class)
584 GObjectClass *object_class = G_OBJECT_CLASS (class);
586 class->writable_change_event = g_settings_real_writable_change_event;
587 class->change_event = g_settings_real_change_event;
589 object_class->set_property = g_settings_set_property;
590 object_class->get_property = g_settings_get_property;
591 object_class->constructed = g_settings_constructed;
592 object_class->finalize = g_settings_finalize;
594 g_type_class_add_private (object_class, sizeof (GSettingsPrivate));
597 * GSettings::changed:
598 * @settings: the object on which the signal was emitted
599 * @key: the name of the key that changed
601 * The "changed" signal is emitted when a key has potentially changed.
602 * You should call one of the g_settings_get() calls to check the new
605 * This signal supports detailed connections. You can connect to the
606 * detailed signal "changed::x" in order to only receive callbacks
607 * when key "x" changes.
609 g_settings_signals[SIGNAL_CHANGED] =
610 g_signal_new ("changed", G_TYPE_SETTINGS,
611 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
612 G_STRUCT_OFFSET (GSettingsClass, changed),
613 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
614 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
617 * GSettings::change-event:
618 * @settings: the object on which the signal was emitted
619 * @keys: (array length=n_keys) (element-type GQuark) (allow-none):
620 * an array of #GQuark<!-- -->s for the changed keys, or %NULL
621 * @n_keys: the length of the @keys array, or 0
622 * @returns: %TRUE to stop other handlers from being invoked for the
623 * event. FALSE to propagate the event further.
625 * The "change-event" signal is emitted once per change event that
626 * affects this settings object. You should connect to this signal
627 * only if you are interested in viewing groups of changes before they
628 * are split out into multiple emissions of the "changed" signal.
629 * For most use cases it is more appropriate to use the "changed" signal.
631 * In the event that the change event applies to one or more specified
632 * keys, @keys will be an array of #GQuark of length @n_keys. In the
633 * event that the change event applies to the #GSettings object as a
634 * whole (ie: potentially every key has been changed) then @keys will
635 * be %NULL and @n_keys will be 0.
637 * The default handler for this signal invokes the "changed" signal
638 * for each affected key. If any other connected handler returns
639 * %TRUE then this default functionality will be suppressed.
641 g_settings_signals[SIGNAL_CHANGE_EVENT] =
642 g_signal_new ("change-event", G_TYPE_SETTINGS,
644 G_STRUCT_OFFSET (GSettingsClass, change_event),
645 g_signal_accumulator_true_handled, NULL,
647 G_TYPE_BOOLEAN, 2, G_TYPE_POINTER, G_TYPE_INT);
650 * GSettings::writable-changed:
651 * @settings: the object on which the signal was emitted
654 * The "writable-changed" signal is emitted when the writability of a
655 * key has potentially changed. You should call
656 * g_settings_is_writable() in order to determine the new status.
658 * This signal supports detailed connections. You can connect to the
659 * detailed signal "writable-changed::x" in order to only receive
660 * callbacks when the writability of "x" changes.
662 g_settings_signals[SIGNAL_WRITABLE_CHANGED] =
663 g_signal_new ("writable-changed", G_TYPE_SETTINGS,
664 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
665 G_STRUCT_OFFSET (GSettingsClass, writable_changed),
666 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
667 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
670 * GSettings::writable-change-event:
671 * @settings: the object on which the signal was emitted
672 * @key: the quark of the key, or 0
673 * @returns: %TRUE to stop other handlers from being invoked for the
674 * event. FALSE to propagate the event further.
676 * The "writable-change-event" signal is emitted once per writability
677 * change event that affects this settings object. You should connect
678 * to this signal if you are interested in viewing groups of changes
679 * before they are split out into multiple emissions of the
680 * "writable-changed" signal. For most use cases it is more
681 * appropriate to use the "writable-changed" signal.
683 * In the event that the writability change applies only to a single
684 * key, @key will be set to the #GQuark for that key. In the event
685 * that the writability change affects the entire settings object,
688 * The default handler for this signal invokes the "writable-changed"
689 * and "changed" signals for each affected key. This is done because
690 * changes in writability might also imply changes in value (if for
691 * example, a new mandatory setting is introduced). If any other
692 * connected handler returns %TRUE then this default functionality
693 * will be suppressed.
695 g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT] =
696 g_signal_new ("writable-change-event", G_TYPE_SETTINGS,
698 G_STRUCT_OFFSET (GSettingsClass, writable_change_event),
699 g_signal_accumulator_true_handled, NULL,
700 NULL, G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
705 * The name of the context that the settings are stored in.
707 g_object_class_install_property (object_class, PROP_BACKEND,
708 g_param_spec_object ("backend",
709 P_("GSettingsBackend"),
710 P_("The GSettingsBackend for this settings object"),
711 G_TYPE_SETTINGS_BACKEND, G_PARAM_CONSTRUCT_ONLY |
712 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
717 * The name of the schema that describes the types of keys
718 * for this #GSettings object.
720 g_object_class_install_property (object_class, PROP_SCHEMA,
721 g_param_spec_string ("schema",
723 P_("The name of the schema for this settings object"),
725 G_PARAM_CONSTRUCT_ONLY |
726 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
731 * The path within the backend where the settings are stored.
733 g_object_class_install_property (object_class, PROP_PATH,
734 g_param_spec_string ("path",
736 P_("The path within the backend where the settings are"),
738 G_PARAM_CONSTRUCT_ONLY |
739 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
742 * GSettings:has-unapplied:
744 * If this property is %TRUE, the #GSettings object has outstanding
745 * changes that will be applied when g_settings_apply() is called.
747 g_object_class_install_property (object_class, PROP_HAS_UNAPPLIED,
748 g_param_spec_boolean ("has-unapplied",
749 P_("Has unapplied changes"),
750 P_("TRUE if there are outstanding changes to apply()"),
752 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
755 * GSettings:delay-apply:
757 * Whether the #GSettings object is in 'delay-apply' mode. See
758 * g_settings_delay() for details.
762 g_object_class_install_property (object_class, PROP_DELAY_APPLY,
763 g_param_spec_boolean ("delay-apply",
764 P_("Delay-apply mode"),
765 P_("Whether this settings object is in 'delay-apply' mode"),
767 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
770 /* Construction (new, new_with_path, etc.) {{{1 */
773 * @schema: the name of the schema
774 * @returns: a new #GSettings object
776 * Creates a new #GSettings object with a given schema.
778 * Signals on the newly created #GSettings object will be dispatched
779 * via the thread-default #GMainContext in effect at the time of the
780 * call to g_settings_new(). The new #GSettings will hold a reference
781 * on the context. See g_main_context_push_thread_default().
786 g_settings_new (const gchar *schema)
788 g_return_val_if_fail (schema != NULL, NULL);
790 return g_object_new (G_TYPE_SETTINGS,
796 * g_settings_new_with_path:
797 * @schema: the name of the schema
798 * @path: the path to use
799 * @returns: a new #GSettings object
801 * Creates a new #GSettings object with a given schema and path.
803 * You only need to do this if you want to directly create a settings
804 * object with a schema that doesn't have a specified path of its own.
807 * It is a programmer error to call this function for a schema that
808 * has an explicitly specified path.
813 g_settings_new_with_path (const gchar *schema,
816 g_return_val_if_fail (schema != NULL, NULL);
817 g_return_val_if_fail (path != NULL, NULL);
819 return g_object_new (G_TYPE_SETTINGS,
826 * g_settings_new_with_backend:
827 * @schema: the name of the schema
828 * @backend: the #GSettingsBackend to use
829 * @returns: a new #GSettings object
831 * Creates a new #GSettings object with a given schema and backend.
833 * Creating a #GSettings object with a different backend allows accessing
834 * settings from a database other than the usual one. For example, it may make
835 * sense to pass a backend corresponding to the "defaults" settings database on
836 * the system to get a settings object that modifies the system default
837 * settings instead of the settings for this user.
842 g_settings_new_with_backend (const gchar *schema,
843 GSettingsBackend *backend)
845 g_return_val_if_fail (schema != NULL, NULL);
846 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
848 return g_object_new (G_TYPE_SETTINGS,
855 * g_settings_new_with_backend_and_path:
856 * @schema: the name of the schema
857 * @backend: the #GSettingsBackend to use
858 * @path: the path to use
859 * @returns: a new #GSettings object
861 * Creates a new #GSettings object with a given schema, backend and
864 * This is a mix of g_settings_new_with_backend() and
865 * g_settings_new_with_path().
870 g_settings_new_with_backend_and_path (const gchar *schema,
871 GSettingsBackend *backend,
874 g_return_val_if_fail (schema != NULL, NULL);
875 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
876 g_return_val_if_fail (path != NULL, NULL);
878 return g_object_new (G_TYPE_SETTINGS,
885 /* Internal read/write utilities, enum/flags conversion, validation {{{1 */
891 GSettingsSchema *schema;
896 const guint32 *strinfo;
897 gsize strinfo_length;
899 const gchar *unparsed;
902 const GVariantType *type;
903 GVariant *minimum, *maximum;
904 GVariant *default_value;
908 endian_fixup (GVariant **value)
910 #if G_BYTE_ORDER == G_BIG_ENDIAN
913 tmp = g_variant_byteswap (*value);
914 g_variant_unref (*value);
920 g_settings_get_key_info (GSettingsKeyInfo *info,
928 g_return_val_if_fail (settings->priv->schema != NULL, FALSE);
930 memset (info, 0, sizeof *info);
932 iter = g_settings_schema_get_value (settings->priv->schema, key);
934 info->default_value = g_variant_iter_next_value (iter);
935 endian_fixup (&info->default_value);
936 info->type = g_variant_get_type (info->default_value);
937 info->settings = g_object_ref (settings);
938 info->key = g_intern_string (key);
940 while (g_variant_iter_next (iter, "(y*)", &code, &data))
945 /* translation requested */
946 g_variant_get (data, "(y&s)", &info->lc_char, &info->unparsed);
950 /* enumerated types... */
951 info->is_enum = TRUE;
956 info->is_flags = TRUE;
960 /* ..., choices, aliases */
961 info->strinfo = g_variant_get_fixed_array (data,
962 &info->strinfo_length,
967 g_variant_get (data, "(**)", &info->minimum, &info->maximum);
968 endian_fixup (&info->minimum);
969 endian_fixup (&info->maximum);
973 g_warning ("unknown schema extension '%c'", code);
977 g_variant_unref (data);
980 g_variant_iter_free (iter);
986 g_settings_free_key_info (GSettingsKeyInfo *info)
989 g_variant_unref (info->minimum);
992 g_variant_unref (info->maximum);
994 g_variant_unref (info->default_value);
995 g_object_unref (info->settings);
999 g_settings_write_to_backend (GSettingsKeyInfo *info,
1005 path = g_strconcat (info->settings->priv->path, info->key, NULL);
1006 success = g_settings_backend_write (info->settings->priv->backend,
1014 g_settings_type_check (GSettingsKeyInfo *info,
1017 g_return_val_if_fail (value != NULL, FALSE);
1019 return g_variant_is_of_type (value, info->type);
1023 g_settings_key_info_range_check (GSettingsKeyInfo *info,
1026 if (info->minimum == NULL && info->strinfo == NULL)
1029 if (g_variant_is_container (value))
1035 g_variant_iter_init (&iter, value);
1036 while (ok && (child = g_variant_iter_next_value (&iter)))
1038 ok = g_settings_key_info_range_check (info, child);
1039 g_variant_unref (child);
1047 return g_variant_compare (info->minimum, value) <= 0 &&
1048 g_variant_compare (value, info->maximum) <= 0;
1051 return strinfo_is_string_valid (info->strinfo,
1052 info->strinfo_length,
1053 g_variant_get_string (value, NULL));
1057 g_settings_range_fixup (GSettingsKeyInfo *info,
1060 const gchar *target;
1062 if (g_settings_key_info_range_check (info, value))
1063 return g_variant_ref (value);
1065 if (info->strinfo == NULL)
1068 if (g_variant_is_container (value))
1070 GVariantBuilder builder;
1074 g_variant_iter_init (&iter, value);
1075 g_variant_builder_init (&builder, g_variant_get_type (value));
1077 while ((child = g_variant_iter_next_value (&iter)))
1081 fixed = g_settings_range_fixup (info, child);
1082 g_variant_unref (child);
1086 g_variant_builder_clear (&builder);
1090 g_variant_builder_add_value (&builder, fixed);
1091 g_variant_unref (fixed);
1094 return g_variant_ref_sink (g_variant_builder_end (&builder));
1097 target = strinfo_string_from_alias (info->strinfo, info->strinfo_length,
1098 g_variant_get_string (value, NULL));
1099 return target ? g_variant_ref_sink (g_variant_new_string (target)) : NULL;
1103 g_settings_read_from_backend (GSettingsKeyInfo *info)
1109 path = g_strconcat (info->settings->priv->path, info->key, NULL);
1110 value = g_settings_backend_read (info->settings->priv->backend,
1111 path, info->type, FALSE);
1116 fixup = g_settings_range_fixup (info, value);
1117 g_variant_unref (value);
1126 g_settings_get_translated_default (GSettingsKeyInfo *info)
1128 const gchar *translated;
1129 GError *error = NULL;
1130 const gchar *domain;
1133 if (info->lc_char == '\0')
1134 /* translation not requested for this key */
1137 domain = g_settings_schema_get_gettext_domain (info->settings->priv->schema);
1139 if (info->lc_char == 't')
1140 translated = g_dcgettext (domain, info->unparsed, LC_TIME);
1142 translated = g_dgettext (domain, info->unparsed);
1144 if (translated == info->unparsed)
1145 /* the default value was not translated */
1148 /* try to parse the translation of the unparsed default */
1149 value = g_variant_parse (info->type, translated, NULL, NULL, &error);
1153 g_warning ("Failed to parse translated string `%s' for "
1154 "key `%s' in schema `%s': %s", info->unparsed, info->key,
1155 info->settings->priv->schema_name, error->message);
1156 g_warning ("Using untranslated default instead.");
1157 g_error_free (error);
1160 else if (!g_settings_key_info_range_check (info, value))
1162 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
1163 "is outside of valid range", info->unparsed, info->key,
1164 info->settings->priv->schema_name);
1165 g_variant_unref (value);
1173 g_settings_to_enum (GSettingsKeyInfo *info,
1179 it_worked = strinfo_enum_from_string (info->strinfo, info->strinfo_length,
1180 g_variant_get_string (value, NULL),
1183 /* 'value' can only come from the backend after being filtered for validity,
1184 * from the translation after being filtered for validity, or from the schema
1185 * itself (which the schema compiler checks for validity). If this assertion
1186 * fails then it's really a bug in GSettings or the schema compiler...
1188 g_assert (it_worked);
1194 g_settings_from_enum (GSettingsKeyInfo *info,
1197 const gchar *string;
1199 string = strinfo_string_from_enum (info->strinfo,
1200 info->strinfo_length,
1206 return g_variant_new_string (string);
1210 g_settings_to_flags (GSettingsKeyInfo *info,
1218 g_variant_iter_init (&iter, value);
1219 while (g_variant_iter_next (&iter, "&s", &flag))
1224 it_worked = strinfo_enum_from_string (info->strinfo,
1225 info->strinfo_length,
1227 /* as in g_settings_to_enum() */
1228 g_assert (it_worked);
1230 result |= flag_value;
1237 g_settings_from_flags (GSettingsKeyInfo *info,
1240 GVariantBuilder builder;
1243 g_variant_builder_init (&builder, G_VARIANT_TYPE ("as"));
1245 for (i = 0; i < 32; i++)
1246 if (value & (1u << i))
1248 const gchar *string;
1250 string = strinfo_string_from_enum (info->strinfo,
1251 info->strinfo_length,
1256 g_variant_builder_clear (&builder);
1260 g_variant_builder_add (&builder, "s", string);
1263 return g_variant_builder_end (&builder);
1266 /* Public Get/Set API {{{1 (get, get_value, set, set_value, get_mapped) */
1268 * g_settings_get_value:
1269 * @settings: a #GSettings object
1270 * @key: the key to get the value for
1271 * @returns: a new #GVariant
1273 * Gets the value that is stored in @settings for @key.
1275 * It is a programmer error to give a @key that isn't contained in the
1276 * schema for @settings.
1281 g_settings_get_value (GSettings *settings,
1284 GSettingsKeyInfo info;
1287 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1288 g_return_val_if_fail (key != NULL, NULL);
1290 if (!g_settings_get_key_info (&info, settings, key))
1293 value = g_settings_read_from_backend (&info);
1296 value = g_settings_get_translated_default (&info);
1299 value = g_variant_ref (info.default_value);
1301 g_settings_free_key_info (&info);
1307 * g_settings_get_enum:
1308 * @settings: a #GSettings object
1309 * @key: the key to get the value for
1310 * @returns: the enum value
1312 * Gets the value that is stored in @settings for @key and converts it
1313 * to the enum value that it represents.
1315 * In order to use this function the type of the value must be a string
1316 * and it must be marked in the schema file as an enumerated type.
1318 * It is a programmer error to give a @key that isn't contained in the
1319 * schema for @settings or is not marked as an enumerated type.
1321 * If the value stored in the configuration database is not a valid
1322 * value for the enumerated type then this function will return the
1328 g_settings_get_enum (GSettings *settings,
1331 GSettingsKeyInfo info;
1335 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1336 g_return_val_if_fail (key != NULL, -1);
1338 if (!g_settings_get_key_info (&info, settings, key))
1343 g_critical ("g_settings_get_enum() called on key `%s' which is not "
1344 "associated with an enumerated type", info.key);
1345 g_settings_free_key_info (&info);
1349 value = g_settings_read_from_backend (&info);
1352 value = g_settings_get_translated_default (&info);
1355 value = g_variant_ref (info.default_value);
1357 result = g_settings_to_enum (&info, value);
1358 g_settings_free_key_info (&info);
1359 g_variant_unref (value);
1365 * g_settings_set_enum:
1366 * @settings: a #GSettings object
1367 * @key: a key, within @settings
1368 * @value: an enumerated value
1369 * @returns: %TRUE, if the set succeeds
1371 * Looks up the enumerated type nick for @value and writes it to @key,
1374 * It is a programmer error to give a @key that isn't contained in the
1375 * schema for @settings or is not marked as an enumerated type, or for
1376 * @value not to be a valid value for the named type.
1378 * After performing the write, accessing @key directly with
1379 * g_settings_get_string() will return the 'nick' associated with
1383 g_settings_set_enum (GSettings *settings,
1387 GSettingsKeyInfo info;
1391 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1392 g_return_val_if_fail (key != NULL, FALSE);
1394 if (!g_settings_get_key_info (&info, settings, key))
1399 g_critical ("g_settings_set_enum() called on key `%s' which is not "
1400 "associated with an enumerated type", info.key);
1404 if (!(variant = g_settings_from_enum (&info, value)))
1406 g_critical ("g_settings_set_enum(): invalid enum value %d for key `%s' "
1407 "in schema `%s'. Doing nothing.", value, info.key,
1408 info.settings->priv->schema_name);
1409 g_settings_free_key_info (&info);
1413 success = g_settings_write_to_backend (&info, variant);
1414 g_settings_free_key_info (&info);
1420 * g_settings_get_flags:
1421 * @settings: a #GSettings object
1422 * @key: the key to get the value for
1423 * @returns: the flags value
1425 * Gets the value that is stored in @settings for @key and converts it
1426 * to the flags value that it represents.
1428 * In order to use this function the type of the value must be an array
1429 * of strings and it must be marked in the schema file as an flags type.
1431 * It is a programmer error to give a @key that isn't contained in the
1432 * schema for @settings or is not marked as a flags type.
1434 * If the value stored in the configuration database is not a valid
1435 * value for the flags type then this function will return the default
1441 g_settings_get_flags (GSettings *settings,
1444 GSettingsKeyInfo info;
1448 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1449 g_return_val_if_fail (key != NULL, -1);
1451 if (!g_settings_get_key_info (&info, settings, key))
1456 g_critical ("g_settings_get_flags() called on key `%s' which is not "
1457 "associated with a flags type", info.key);
1458 g_settings_free_key_info (&info);
1462 value = g_settings_read_from_backend (&info);
1465 value = g_settings_get_translated_default (&info);
1468 value = g_variant_ref (info.default_value);
1470 result = g_settings_to_flags (&info, value);
1471 g_settings_free_key_info (&info);
1472 g_variant_unref (value);
1478 * g_settings_set_flags:
1479 * @settings: a #GSettings object
1480 * @key: a key, within @settings
1481 * @value: a flags value
1482 * @returns: %TRUE, if the set succeeds
1484 * Looks up the flags type nicks for the bits specified by @value, puts
1485 * them in an array of strings and writes the array to @key, within
1488 * It is a programmer error to give a @key that isn't contained in the
1489 * schema for @settings or is not marked as a flags type, or for @value
1490 * to contain any bits that are not value for the named type.
1492 * After performing the write, accessing @key directly with
1493 * g_settings_get_strv() will return an array of 'nicks'; one for each
1497 g_settings_set_flags (GSettings *settings,
1501 GSettingsKeyInfo info;
1505 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1506 g_return_val_if_fail (key != NULL, FALSE);
1508 if (!g_settings_get_key_info (&info, settings, key))
1513 g_critical ("g_settings_set_flags() called on key `%s' which is not "
1514 "associated with a flags type", info.key);
1518 if (!(variant = g_settings_from_flags (&info, value)))
1520 g_critical ("g_settings_set_flags(): invalid flags value 0x%08x "
1521 "for key `%s' in schema `%s'. Doing nothing.",
1522 value, info.key, info.settings->priv->schema_name);
1523 g_settings_free_key_info (&info);
1527 success = g_settings_write_to_backend (&info, variant);
1528 g_settings_free_key_info (&info);
1534 * g_settings_set_value:
1535 * @settings: a #GSettings object
1536 * @key: the name of the key to set
1537 * @value: a #GVariant of the correct type
1538 * @returns: %TRUE if setting the key succeeded,
1539 * %FALSE if the key was not writable
1541 * Sets @key in @settings to @value.
1543 * It is a programmer error to give a @key that isn't contained in the
1544 * schema for @settings or for @value to have the incorrect type, per
1547 * If @value is floating then this function consumes the reference.
1552 g_settings_set_value (GSettings *settings,
1556 GSettingsKeyInfo info;
1558 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1559 g_return_val_if_fail (key != NULL, FALSE);
1561 if (!g_settings_get_key_info (&info, settings, key))
1564 if (!g_settings_type_check (&info, value))
1566 g_critical ("g_settings_set_value: key '%s' in '%s' expects type '%s', but a GVariant of type '%s' was given",
1568 settings->priv->schema_name,
1569 g_variant_type_peek_string (info.type),
1570 g_variant_get_type_string (value));
1575 if (!g_settings_key_info_range_check (&info, value))
1577 g_warning ("g_settings_set_value: value for key '%s' in schema '%s' "
1578 "is outside of valid range",
1580 settings->priv->schema_name);
1585 g_settings_free_key_info (&info);
1587 return g_settings_write_to_backend (&info, value);
1592 * @settings: a #GSettings object
1593 * @key: the key to get the value for
1594 * @format: a #GVariant format string
1595 * @...: arguments as per @format
1597 * Gets the value that is stored at @key in @settings.
1599 * A convenience function that combines g_settings_get_value() with
1602 * It is a programmer error to give a @key that isn't contained in the
1603 * schema for @settings or for the #GVariantType of @format to mismatch
1604 * the type given in the schema.
1609 g_settings_get (GSettings *settings,
1611 const gchar *format,
1617 value = g_settings_get_value (settings, key);
1619 va_start (ap, format);
1620 g_variant_get_va (value, format, NULL, &ap);
1623 g_variant_unref (value);
1628 * @settings: a #GSettings object
1629 * @key: the name of the key to set
1630 * @format: a #GVariant format string
1631 * @...: arguments as per @format
1632 * @returns: %TRUE if setting the key succeeded,
1633 * %FALSE if the key was not writable
1635 * Sets @key in @settings to @value.
1637 * A convenience function that combines g_settings_set_value() with
1640 * It is a programmer error to give a @key that isn't contained in the
1641 * schema for @settings or for the #GVariantType of @format to mismatch
1642 * the type given in the schema.
1647 g_settings_set (GSettings *settings,
1649 const gchar *format,
1655 va_start (ap, format);
1656 value = g_variant_new_va (format, NULL, &ap);
1659 return g_settings_set_value (settings, key, value);
1663 * g_settings_get_mapped:
1664 * @settings: a #GSettings object
1665 * @key: the key to get the value for
1666 * @mapping: (scope call): the function to map the value in the
1667 * settings database to the value used by the application
1668 * @user_data: user data for @mapping
1669 * @returns: (transfer full): the result, which may be %NULL
1671 * Gets the value that is stored at @key in @settings, subject to
1672 * application-level validation/mapping.
1674 * You should use this function when the application needs to perform
1675 * some processing on the value of the key (for example, parsing). The
1676 * @mapping function performs that processing. If the function
1677 * indicates that the processing was unsuccessful (due to a parse error,
1678 * for example) then the mapping is tried again with another value.
1680 * This allows a robust 'fall back to defaults' behaviour to be
1681 * implemented somewhat automatically.
1683 * The first value that is tried is the user's setting for the key. If
1684 * the mapping function fails to map this value, other values may be
1685 * tried in an unspecified order (system or site defaults, translated
1686 * schema default values, untranslated schema default values, etc).
1688 * If the mapping function fails for all possible values, one additional
1689 * attempt is made: the mapping function is called with a %NULL value.
1690 * If the mapping function still indicates failure at this point then
1691 * the application will be aborted.
1693 * The result parameter for the @mapping function is pointed to a
1694 * #gpointer which is initially set to %NULL. The same pointer is given
1695 * to each invocation of @mapping. The final value of that #gpointer is
1696 * what is returned by this function. %NULL is valid; it is returned
1697 * just as any other value would be.
1700 g_settings_get_mapped (GSettings *settings,
1702 GSettingsGetMapping mapping,
1705 gpointer result = NULL;
1706 GSettingsKeyInfo info;
1710 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1711 g_return_val_if_fail (key != NULL, NULL);
1712 g_return_val_if_fail (mapping != NULL, NULL);
1714 if (!g_settings_get_key_info (&info, settings, key))
1717 if ((value = g_settings_read_from_backend (&info)))
1719 okay = mapping (value, &result, user_data);
1720 g_variant_unref (value);
1721 if (okay) goto okay;
1724 if ((value = g_settings_get_translated_default (&info)))
1726 okay = mapping (value, &result, user_data);
1727 g_variant_unref (value);
1728 if (okay) goto okay;
1731 if (mapping (info.default_value, &result, user_data))
1734 if (!mapping (NULL, &result, user_data))
1735 g_error ("The mapping function given to g_settings_get_mapped() for key "
1736 "`%s' in schema `%s' returned FALSE when given a NULL value.",
1737 key, settings->priv->schema_name);
1740 g_settings_free_key_info (&info);
1745 /* Convenience API (get, set_string, int, double, boolean, strv) {{{1 */
1747 * g_settings_get_string:
1748 * @settings: a #GSettings object
1749 * @key: the key to get the value for
1750 * @returns: a newly-allocated string
1752 * Gets the value that is stored at @key in @settings.
1754 * A convenience variant of g_settings_get() for strings.
1756 * It is a programmer error to give a @key that isn't specified as
1757 * having a string type in the schema for @settings.
1762 g_settings_get_string (GSettings *settings,
1768 value = g_settings_get_value (settings, key);
1769 result = g_variant_dup_string (value, NULL);
1770 g_variant_unref (value);
1776 * g_settings_set_string:
1777 * @settings: a #GSettings object
1778 * @key: the name of the key to set
1779 * @value: the value to set it to
1780 * @returns: %TRUE if setting the key succeeded,
1781 * %FALSE if the key was not writable
1783 * Sets @key in @settings to @value.
1785 * A convenience variant of g_settings_set() for strings.
1787 * It is a programmer error to give a @key that isn't specified as
1788 * having a string type in the schema for @settings.
1793 g_settings_set_string (GSettings *settings,
1797 return g_settings_set_value (settings, key, g_variant_new_string (value));
1801 * g_settings_get_int:
1802 * @settings: a #GSettings object
1803 * @key: the key to get the value for
1804 * @returns: an integer
1806 * Gets the value that is stored at @key in @settings.
1808 * A convenience variant of g_settings_get() for 32-bit integers.
1810 * It is a programmer error to give a @key that isn't specified as
1811 * having a int32 type in the schema for @settings.
1816 g_settings_get_int (GSettings *settings,
1822 value = g_settings_get_value (settings, key);
1823 result = g_variant_get_int32 (value);
1824 g_variant_unref (value);
1830 * g_settings_set_int:
1831 * @settings: a #GSettings object
1832 * @key: the name of the key to set
1833 * @value: the value to set it to
1834 * @returns: %TRUE if setting the key succeeded,
1835 * %FALSE if the key was not writable
1837 * Sets @key in @settings to @value.
1839 * A convenience variant of g_settings_set() for 32-bit integers.
1841 * It is a programmer error to give a @key that isn't specified as
1842 * having a int32 type in the schema for @settings.
1847 g_settings_set_int (GSettings *settings,
1851 return g_settings_set_value (settings, key, g_variant_new_int32 (value));
1855 * g_settings_get_uint:
1856 * @settings: a #GSettings object
1857 * @key: the key to get the value for
1858 * @returns: an unsigned integer
1860 * Gets the value that is stored at @key in @settings.
1862 * A convenience variant of g_settings_get() for 32-bit unsigned
1865 * It is a programmer error to give a @key that isn't specified as
1866 * having a uint32 type in the schema for @settings.
1871 g_settings_get_uint (GSettings *settings,
1877 value = g_settings_get_value (settings, key);
1878 result = g_variant_get_uint32 (value);
1879 g_variant_unref (value);
1885 * g_settings_set_uint:
1886 * @settings: a #GSettings object
1887 * @key: the name of the key to set
1888 * @value: the value to set it to
1889 * @returns: %TRUE if setting the key succeeded,
1890 * %FALSE if the key was not writable
1892 * Sets @key in @settings to @value.
1894 * A convenience variant of g_settings_set() for 32-bit unsigned
1897 * It is a programmer error to give a @key that isn't specified as
1898 * having a uint32 type in the schema for @settings.
1903 g_settings_set_uint (GSettings *settings,
1907 return g_settings_set_value (settings, key, g_variant_new_uint32 (value));
1911 * g_settings_get_double:
1912 * @settings: a #GSettings object
1913 * @key: the key to get the value for
1914 * @returns: a double
1916 * Gets the value that is stored at @key in @settings.
1918 * A convenience variant of g_settings_get() for doubles.
1920 * It is a programmer error to give a @key that isn't specified as
1921 * having a 'double' type in the schema for @settings.
1926 g_settings_get_double (GSettings *settings,
1932 value = g_settings_get_value (settings, key);
1933 result = g_variant_get_double (value);
1934 g_variant_unref (value);
1940 * g_settings_set_double:
1941 * @settings: a #GSettings object
1942 * @key: the name of the key to set
1943 * @value: the value to set it to
1944 * @returns: %TRUE if setting the key succeeded,
1945 * %FALSE if the key was not writable
1947 * Sets @key in @settings to @value.
1949 * A convenience variant of g_settings_set() for doubles.
1951 * It is a programmer error to give a @key that isn't specified as
1952 * having a 'double' type in the schema for @settings.
1957 g_settings_set_double (GSettings *settings,
1961 return g_settings_set_value (settings, key, g_variant_new_double (value));
1965 * g_settings_get_boolean:
1966 * @settings: a #GSettings object
1967 * @key: the key to get the value for
1968 * @returns: a boolean
1970 * Gets the value that is stored at @key in @settings.
1972 * A convenience variant of g_settings_get() for booleans.
1974 * It is a programmer error to give a @key that isn't specified as
1975 * having a boolean type in the schema for @settings.
1980 g_settings_get_boolean (GSettings *settings,
1986 value = g_settings_get_value (settings, key);
1987 result = g_variant_get_boolean (value);
1988 g_variant_unref (value);
1994 * g_settings_set_boolean:
1995 * @settings: a #GSettings object
1996 * @key: the name of the key to set
1997 * @value: the value to set it to
1998 * @returns: %TRUE if setting the key succeeded,
1999 * %FALSE if the key was not writable
2001 * Sets @key in @settings to @value.
2003 * A convenience variant of g_settings_set() for booleans.
2005 * It is a programmer error to give a @key that isn't specified as
2006 * having a boolean type in the schema for @settings.
2011 g_settings_set_boolean (GSettings *settings,
2015 return g_settings_set_value (settings, key, g_variant_new_boolean (value));
2019 * g_settings_get_strv:
2020 * @settings: a #GSettings object
2021 * @key: the key to get the value for
2022 * @returns: (array zero-terminated=1) (transfer full): a
2023 * newly-allocated, %NULL-terminated array of strings, the value that
2024 * is stored at @key in @settings.
2026 * A convenience variant of g_settings_get() for string arrays.
2028 * It is a programmer error to give a @key that isn't specified as
2029 * having an array of strings type in the schema for @settings.
2034 g_settings_get_strv (GSettings *settings,
2040 value = g_settings_get_value (settings, key);
2041 result = g_variant_dup_strv (value, NULL);
2042 g_variant_unref (value);
2048 * g_settings_set_strv:
2049 * @settings: a #GSettings object
2050 * @key: the name of the key to set
2051 * @value: (allow-none) (array zero-terminated=1): the value to set it to, or %NULL
2052 * @returns: %TRUE if setting the key succeeded,
2053 * %FALSE if the key was not writable
2055 * Sets @key in @settings to @value.
2057 * A convenience variant of g_settings_set() for string arrays. If
2058 * @value is %NULL, then @key is set to be the empty array.
2060 * It is a programmer error to give a @key that isn't specified as
2061 * having an array of strings type in the schema for @settings.
2066 g_settings_set_strv (GSettings *settings,
2068 const gchar * const *value)
2073 array = g_variant_new_strv (value, -1);
2075 array = g_variant_new_strv (NULL, 0);
2077 return g_settings_set_value (settings, key, array);
2080 /* Delayed apply (delay, apply, revert, get_has_unapplied) {{{1 */
2083 * @settings: a #GSettings object
2085 * Changes the #GSettings object into 'delay-apply' mode. In this
2086 * mode, changes to @settings are not immediately propagated to the
2087 * backend, but kept locally until g_settings_apply() is called.
2092 g_settings_delay (GSettings *settings)
2094 g_return_if_fail (G_IS_SETTINGS (settings));
2096 if (settings->priv->delayed)
2099 settings->priv->delayed =
2100 g_delayed_settings_backend_new (settings->priv->backend,
2102 settings->priv->main_context);
2103 g_settings_backend_unwatch (settings->priv->backend, G_OBJECT (settings));
2104 g_object_unref (settings->priv->backend);
2106 settings->priv->backend = G_SETTINGS_BACKEND (settings->priv->delayed);
2107 g_settings_backend_watch (settings->priv->backend,
2108 &listener_vtable, G_OBJECT (settings),
2109 settings->priv->main_context);
2111 g_object_notify (G_OBJECT (settings), "delay-apply");
2116 * @settings: a #GSettings instance
2118 * Applies any changes that have been made to the settings. This
2119 * function does nothing unless @settings is in 'delay-apply' mode;
2120 * see g_settings_delay(). In the normal case settings are always
2121 * applied immediately.
2124 g_settings_apply (GSettings *settings)
2126 if (settings->priv->delayed)
2128 GDelayedSettingsBackend *delayed;
2130 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
2131 g_delayed_settings_backend_apply (delayed);
2136 * g_settings_revert:
2137 * @settings: a #GSettings instance
2139 * Reverts all non-applied changes to the settings. This function
2140 * does nothing unless @settings is in 'delay-apply' mode; see
2141 * g_settings_delay(). In the normal case settings are always applied
2144 * Change notifications will be emitted for affected keys.
2147 g_settings_revert (GSettings *settings)
2149 if (settings->priv->delayed)
2151 GDelayedSettingsBackend *delayed;
2153 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
2154 g_delayed_settings_backend_revert (delayed);
2159 * g_settings_get_has_unapplied:
2160 * @settings: a #GSettings object
2161 * @returns: %TRUE if @settings has unapplied changes
2163 * Returns whether the #GSettings object has any unapplied
2164 * changes. This can only be the case if it is in 'delayed-apply' mode.
2169 g_settings_get_has_unapplied (GSettings *settings)
2171 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
2173 return settings->priv->delayed &&
2174 g_delayed_settings_backend_get_has_unapplied (
2175 G_DELAYED_SETTINGS_BACKEND (settings->priv->backend));
2178 /* Extra API (reset, sync, get_child, is_writable, list_*, ranges) {{{1 */
2181 * @settings: a #GSettings object
2182 * @key: the name of a key
2184 * Resets @key to its default value.
2186 * This call resets the key, as much as possible, to its default value.
2187 * That might the value specified in the schema or the one set by the
2191 g_settings_reset (GSettings *settings,
2196 path = g_strconcat (settings->priv->path, key, NULL);
2197 g_settings_backend_reset (settings->priv->backend, path, NULL);
2204 * Ensures that all pending operations for the given are complete for
2205 * the default backend.
2207 * Writes made to a #GSettings are handled asynchronously. For this
2208 * reason, it is very unlikely that the changes have it to disk by the
2209 * time g_settings_set() returns.
2211 * This call will block until all of the writes have made it to the
2212 * backend. Since the mainloop is not running, no change notifications
2213 * will be dispatched during this call (but some may be queued by the
2214 * time the call is done).
2217 g_settings_sync (void)
2219 g_settings_backend_sync_default ();
2223 * g_settings_is_writable:
2224 * @settings: a #GSettings object
2225 * @name: the name of a key
2226 * @returns: %TRUE if the key @name is writable
2228 * Finds out if a key can be written or not
2233 g_settings_is_writable (GSettings *settings,
2239 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
2241 path = g_strconcat (settings->priv->path, name, NULL);
2242 writable = g_settings_backend_get_writable (settings->priv->backend, path);
2249 * g_settings_get_child:
2250 * @settings: a #GSettings object
2251 * @name: the name of the 'child' schema
2252 * @returns: (transfer full): a 'child' settings object
2254 * Creates a 'child' settings object which has a base path of
2255 * <replaceable>base-path</replaceable>/@name, where
2256 * <replaceable>base-path</replaceable> is the base path of @settings.
2258 * The schema for the child settings object must have been declared
2259 * in the schema of @settings using a <tag class="starttag">child</tag> element.
2264 g_settings_get_child (GSettings *settings,
2267 const gchar *child_schema;
2272 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
2274 child_name = g_strconcat (name, "/", NULL);
2275 child_schema = g_settings_schema_get_string (settings->priv->schema,
2277 if (child_schema == NULL)
2278 g_error ("Schema '%s' has no child '%s'",
2279 settings->priv->schema_name, name);
2281 child_path = g_strconcat (settings->priv->path, child_name, NULL);
2282 child = g_object_new (G_TYPE_SETTINGS,
2283 "schema", child_schema,
2286 g_free (child_path);
2287 g_free (child_name);
2293 * g_settings_list_keys:
2294 * @settings: a #GSettings object
2295 * @returns: (transfer full) (element-type utf8): a list of the keys on @settings
2297 * Introspects the list of keys on @settings.
2299 * You should probably not be calling this function from "normal" code
2300 * (since you should already know what keys are in your schema). This
2301 * function is intended for introspection reasons.
2303 * You should free the return value with g_strfreev() when you are done
2307 g_settings_list_keys (GSettings *settings)
2314 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2315 strv = g_new (gchar *, n_keys + 1);
2316 for (i = j = 0; i < n_keys; i++)
2318 const gchar *key = g_quark_to_string (keys[i]);
2320 if (!g_str_has_suffix (key, "/"))
2321 strv[j++] = g_strdup (key);
2329 * g_settings_list_children:
2330 * @settings: a #GSettings object
2331 * @returns: (transfer full) (element-type utf8): a list of the children on @settings
2333 * Gets the list of children on @settings.
2335 * The list is exactly the list of strings for which it is not an error
2336 * to call g_settings_get_child().
2338 * For GSettings objects that are lists, this value can change at any
2339 * time and you should connect to the "children-changed" signal to watch
2340 * for those changes. Note that there is a race condition here: you may
2341 * request a child after listing it only for it to have been destroyed
2342 * in the meantime. For this reason, g_settings_get_child() may return
2343 * %NULL even for a child that was listed by this function.
2345 * For GSettings objects that are not lists, you should probably not be
2346 * calling this function from "normal" code (since you should already
2347 * know what children are in your schema). This function may still be
2348 * useful there for introspection reasons, however.
2350 * You should free the return value with g_strfreev() when you are done
2354 g_settings_list_children (GSettings *settings)
2361 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2362 strv = g_new (gchar *, n_keys + 1);
2363 for (i = j = 0; i < n_keys; i++)
2365 const gchar *key = g_quark_to_string (keys[i]);
2367 if (g_str_has_suffix (key, "/"))
2369 gint length = strlen (key);
2371 strv[j] = g_memdup (key, length);
2372 strv[j][length - 1] = '\0';
2382 * g_settings_get_range:
2383 * @settings: a #GSettings
2384 * @key: the key to query the range of
2385 * @returns: a #GVariant describing the range
2387 * Queries the range of a key.
2389 * This function will return a #GVariant that fully describes the range
2390 * of values that are valid for @key.
2392 * The type of #GVariant returned is <literal>(sv)</literal>. The
2393 * string describes the type of range restriction in effect. The type
2394 * and meaning of the value contained in the variant depends on the
2397 * If the string is <literal>'type'</literal> then the variant contains
2398 * an empty array. The element type of that empty array is the expected
2399 * type of value and all values of that type are valid.
2401 * If the string is <literal>'enum'</literal> then the variant contains
2402 * an array enumerating the possible values. Each item in the array is
2403 * a possible valid value and no other values are valid.
2405 * If the string is <literal>'flags'</literal> then the variant contains
2406 * an array. Each item in the array is a value that may appear zero or
2407 * one times in an array to be used as the value for this key. For
2408 * example, if the variant contained the array <literal>['x',
2409 * 'y']</literal> then the valid values for the key would be
2410 * <literal>[]</literal>, <literal>['x']</literal>,
2411 * <literal>['y']</literal>, <literal>['x', 'y']</literal> and
2412 * <literal>['y', 'x']</literal>.
2414 * Finally, if the string is <literal>'range'</literal> then the variant
2415 * contains a pair of like-typed values -- the minimum and maximum
2416 * permissible values for this key.
2418 * This information should not be used by normal programs. It is
2419 * considered to be a hint for introspection purposes. Normal programs
2420 * should already know what is permitted by their own schema. The
2421 * format may change in any way in the future -- but particularly, new
2422 * forms may be added to the possibilities described above.
2424 * It is a programmer error to give a @key that isn't contained in the
2425 * schema for @settings.
2427 * You should free the returned value with g_variant_unref() when it is
2433 g_settings_get_range (GSettings *settings,
2436 GSettingsKeyInfo info;
2440 if (!g_settings_get_key_info (&info, settings, key))
2445 range = g_variant_new ("(**)", info.minimum, info.maximum);
2448 else if (info.strinfo)
2450 range = strinfo_enumerate (info.strinfo, info.strinfo_length);
2451 type = info.is_flags ? "flags" : "enum";
2455 range = g_variant_new_array (info.type, NULL, 0);
2459 g_settings_free_key_info (&info);
2461 return g_variant_ref_sink (g_variant_new ("(sv)", type, range));
2465 * g_settings_range_check:
2466 * @settings: a #GSettings
2467 * @key: the key to check
2468 * @value: the value to check
2469 * @returns: %TRUE if @value is valid for @key
2471 * Checks if the given @value is of the correct type and within the
2472 * permitted range for @key.
2474 * This API is not intended to be used by normal programs -- they should
2475 * already know what is permitted by their own schemas. This API is
2476 * meant to be used by programs such as editors or commandline tools.
2478 * It is a programmer error to give a @key that isn't contained in the
2479 * schema for @settings.
2484 g_settings_range_check (GSettings *settings,
2488 GSettingsKeyInfo info;
2491 if (!g_settings_get_key_info (&info, settings, key))
2494 good = g_settings_type_check (&info, value) &&
2495 g_settings_key_info_range_check (&info, value);
2496 g_settings_free_key_info (&info);
2504 GSettingsKeyInfo info;
2507 GSettingsBindGetMapping get_mapping;
2508 GSettingsBindSetMapping set_mapping;
2510 GDestroyNotify destroy;
2512 guint writable_handler_id;
2513 guint property_handler_id;
2514 const GParamSpec *property;
2515 guint key_handler_id;
2517 /* prevent recursion */
2522 g_settings_binding_free (gpointer data)
2524 GSettingsBinding *binding = data;
2526 g_assert (!binding->running);
2528 if (binding->writable_handler_id)
2529 g_signal_handler_disconnect (binding->info.settings,
2530 binding->writable_handler_id);
2532 if (binding->key_handler_id)
2533 g_signal_handler_disconnect (binding->info.settings,
2534 binding->key_handler_id);
2536 if (g_signal_handler_is_connected (binding->object,
2537 binding->property_handler_id))
2538 g_signal_handler_disconnect (binding->object,
2539 binding->property_handler_id);
2541 g_settings_free_key_info (&binding->info);
2543 if (binding->destroy)
2544 binding->destroy (binding->user_data);
2546 g_slice_free (GSettingsBinding, binding);
2550 g_settings_binding_quark (const char *property)
2555 tmp = g_strdup_printf ("gsettingsbinding-%s", property);
2556 quark = g_quark_from_string (tmp);
2563 g_settings_binding_key_changed (GSettings *settings,
2567 GSettingsBinding *binding = user_data;
2568 GValue value = { 0, };
2571 g_assert (settings == binding->info.settings);
2572 g_assert (key == binding->info.key);
2574 if (binding->running)
2577 binding->running = TRUE;
2579 g_value_init (&value, binding->property->value_type);
2581 variant = g_settings_read_from_backend (&binding->info);
2582 if (variant && !binding->get_mapping (&value, variant, binding->user_data))
2584 /* silently ignore errors in the user's config database */
2585 g_variant_unref (variant);
2589 if (variant == NULL)
2591 variant = g_settings_get_translated_default (&binding->info);
2593 !binding->get_mapping (&value, variant, binding->user_data))
2595 /* flag translation errors with a warning */
2596 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
2597 "was rejected by the binding mapping function",
2598 binding->info.unparsed, binding->info.key,
2599 binding->info.settings->priv->schema_name);
2600 g_variant_unref (variant);
2605 if (variant == NULL)
2607 variant = g_variant_ref (binding->info.default_value);
2608 if (!binding->get_mapping (&value, variant, binding->user_data))
2609 g_error ("The schema default value for key `%s' in schema `%s' "
2610 "was rejected by the binding mapping function.",
2612 binding->info.settings->priv->schema_name);
2615 g_object_set_property (binding->object, binding->property->name, &value);
2616 g_variant_unref (variant);
2617 g_value_unset (&value);
2619 binding->running = FALSE;
2623 g_settings_binding_property_changed (GObject *object,
2624 const GParamSpec *pspec,
2627 GSettingsBinding *binding = user_data;
2628 GValue value = { 0, };
2631 g_assert (object == binding->object);
2632 g_assert (pspec == binding->property);
2634 if (binding->running)
2637 binding->running = TRUE;
2639 g_value_init (&value, pspec->value_type);
2640 g_object_get_property (object, pspec->name, &value);
2641 if ((variant = binding->set_mapping (&value, binding->info.type,
2642 binding->user_data)))
2644 g_variant_take_ref (variant);
2646 if (!g_settings_type_check (&binding->info, variant))
2648 g_critical ("binding mapping function for key `%s' returned "
2649 "GVariant of type `%s' when type `%s' was requested",
2650 binding->info.key, g_variant_get_type_string (variant),
2651 g_variant_type_dup_string (binding->info.type));
2655 if (!g_settings_key_info_range_check (&binding->info, variant))
2657 g_critical ("GObject property `%s' on a `%s' object is out of "
2658 "schema-specified range for key `%s' of `%s': %s",
2659 binding->property->name,
2660 g_type_name (binding->property->owner_type),
2662 binding->info.settings->priv->schema_name,
2663 g_variant_print (variant, TRUE));
2667 g_settings_write_to_backend (&binding->info, variant);
2668 g_variant_unref (variant);
2670 g_value_unset (&value);
2672 binding->running = FALSE;
2676 g_settings_bind_invert_boolean_get_mapping (GValue *value,
2680 g_value_set_boolean (value, !g_variant_get_boolean (variant));
2685 g_settings_bind_invert_boolean_set_mapping (const GValue *value,
2686 const GVariantType *expected_type,
2689 return g_variant_new_boolean (!g_value_get_boolean (value));
2694 * @settings: a #GSettings object
2695 * @key: the key to bind
2696 * @object: (type GObject.Object): a #GObject
2697 * @property: the name of the property to bind
2698 * @flags: flags for the binding
2700 * Create a binding between the @key in the @settings object
2701 * and the property @property of @object.
2703 * The binding uses the default GIO mapping functions to map
2704 * between the settings and property values. These functions
2705 * handle booleans, numeric types and string types in a
2706 * straightforward way. Use g_settings_bind_with_mapping() if
2707 * you need a custom mapping, or map between types that are not
2708 * supported by the default mapping functions.
2710 * Unless the @flags include %G_SETTINGS_BIND_NO_SENSITIVITY, this
2711 * function also establishes a binding between the writability of
2712 * @key and the "sensitive" property of @object (if @object has
2713 * a boolean property by that name). See g_settings_bind_writable()
2714 * for more details about writable bindings.
2716 * Note that the lifecycle of the binding is tied to the object,
2717 * and that you can have only one binding per object property.
2718 * If you bind the same property twice on the same object, the second
2719 * binding overrides the first one.
2724 g_settings_bind (GSettings *settings,
2727 const gchar *property,
2728 GSettingsBindFlags flags)
2730 GSettingsBindGetMapping get_mapping = NULL;
2731 GSettingsBindSetMapping set_mapping = NULL;
2733 if (flags & G_SETTINGS_BIND_INVERT_BOOLEAN)
2735 get_mapping = g_settings_bind_invert_boolean_get_mapping;
2736 set_mapping = g_settings_bind_invert_boolean_set_mapping;
2738 /* can't pass this flag to g_settings_bind_with_mapping() */
2739 flags &= ~G_SETTINGS_BIND_INVERT_BOOLEAN;
2742 g_settings_bind_with_mapping (settings, key, object, property, flags,
2743 get_mapping, set_mapping, NULL, NULL);
2747 * g_settings_bind_with_mapping: (skip)
2748 * @settings: a #GSettings object
2749 * @key: the key to bind
2750 * @object: (type GObject.Object): a #GObject
2751 * @property: the name of the property to bind
2752 * @flags: flags for the binding
2753 * @get_mapping: a function that gets called to convert values
2754 * from @settings to @object, or %NULL to use the default GIO mapping
2755 * @set_mapping: a function that gets called to convert values
2756 * from @object to @settings, or %NULL to use the default GIO mapping
2757 * @user_data: data that gets passed to @get_mapping and @set_mapping
2758 * @destroy: #GDestroyNotify function for @user_data
2760 * Create a binding between the @key in the @settings object
2761 * and the property @property of @object.
2763 * The binding uses the provided mapping functions to map between
2764 * settings and property values.
2766 * Note that the lifecycle of the binding is tied to the object,
2767 * and that you can have only one binding per object property.
2768 * If you bind the same property twice on the same object, the second
2769 * binding overrides the first one.
2774 g_settings_bind_with_mapping (GSettings *settings,
2777 const gchar *property,
2778 GSettingsBindFlags flags,
2779 GSettingsBindGetMapping get_mapping,
2780 GSettingsBindSetMapping set_mapping,
2782 GDestroyNotify destroy)
2784 GSettingsBinding *binding;
2785 GObjectClass *objectclass;
2786 gchar *detailed_signal;
2787 GQuark binding_quark;
2789 g_return_if_fail (G_IS_SETTINGS (settings));
2790 g_return_if_fail (key != NULL);
2791 g_return_if_fail (G_IS_OBJECT (object));
2792 g_return_if_fail (property != NULL);
2793 g_return_if_fail (~flags & G_SETTINGS_BIND_INVERT_BOOLEAN);
2795 objectclass = G_OBJECT_GET_CLASS (object);
2797 binding = g_slice_new0 (GSettingsBinding);
2798 if (!g_settings_get_key_info (&binding->info, settings, key))
2801 (* destroy) (user_data);
2802 g_slice_free (GSettingsBinding, binding);
2806 binding->object = object;
2807 binding->property = g_object_class_find_property (objectclass, property);
2808 binding->user_data = user_data;
2809 binding->destroy = destroy;
2810 binding->get_mapping = get_mapping ? get_mapping : g_settings_get_mapping;
2811 binding->set_mapping = set_mapping ? set_mapping : g_settings_set_mapping;
2813 if (!(flags & (G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET)))
2814 flags |= G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET;
2816 if (binding->property == NULL)
2818 g_critical ("g_settings_bind: no property '%s' on class '%s'",
2819 property, G_OBJECT_TYPE_NAME (object));
2823 if ((flags & G_SETTINGS_BIND_GET) &&
2824 (binding->property->flags & G_PARAM_WRITABLE) == 0)
2826 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2827 "writable", property, G_OBJECT_TYPE_NAME (object));
2830 if ((flags & G_SETTINGS_BIND_SET) &&
2831 (binding->property->flags & G_PARAM_READABLE) == 0)
2833 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2834 "readable", property, G_OBJECT_TYPE_NAME (object));
2838 if (get_mapping == g_settings_bind_invert_boolean_get_mapping)
2840 /* g_settings_bind_invert_boolean_get_mapping() is a private
2841 * function, so if we are here it means that g_settings_bind() was
2842 * called with G_SETTINGS_BIND_INVERT_BOOLEAN.
2844 * Ensure that both sides are boolean.
2847 if (binding->property->value_type != G_TYPE_BOOLEAN)
2849 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2850 "was specified, but property `%s' on type `%s' has "
2851 "type `%s'", property, G_OBJECT_TYPE_NAME (object),
2852 g_type_name ((binding->property->value_type)));
2856 if (!g_variant_type_equal (binding->info.type, G_VARIANT_TYPE_BOOLEAN))
2858 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2859 "was specified, but key `%s' on schema `%s' has "
2860 "type `%s'", key, settings->priv->schema_name,
2861 g_variant_type_dup_string (binding->info.type));
2867 else if (((get_mapping == NULL && (flags & G_SETTINGS_BIND_GET)) ||
2868 (set_mapping == NULL && (flags & G_SETTINGS_BIND_SET))) &&
2869 !g_settings_mapping_is_compatible (binding->property->value_type,
2870 binding->info.type))
2872 g_critical ("g_settings_bind: property '%s' on class '%s' has type "
2873 "'%s' which is not compatible with type '%s' of key '%s' "
2874 "on schema '%s'", property, G_OBJECT_TYPE_NAME (object),
2875 g_type_name (binding->property->value_type),
2876 g_variant_type_dup_string (binding->info.type), key,
2877 settings->priv->schema_name);
2881 if ((flags & G_SETTINGS_BIND_SET) &&
2882 (~flags & G_SETTINGS_BIND_NO_SENSITIVITY))
2884 GParamSpec *sensitive;
2886 sensitive = g_object_class_find_property (objectclass, "sensitive");
2888 if (sensitive && sensitive->value_type == G_TYPE_BOOLEAN &&
2889 (sensitive->flags & G_PARAM_WRITABLE))
2890 g_settings_bind_writable (settings, binding->info.key,
2891 object, "sensitive", FALSE);
2894 if (flags & G_SETTINGS_BIND_SET)
2896 detailed_signal = g_strdup_printf ("notify::%s", property);
2897 binding->property_handler_id =
2898 g_signal_connect (object, detailed_signal,
2899 G_CALLBACK (g_settings_binding_property_changed),
2901 g_free (detailed_signal);
2903 if (~flags & G_SETTINGS_BIND_GET)
2904 g_settings_binding_property_changed (object,
2909 if (flags & G_SETTINGS_BIND_GET)
2911 if (~flags & G_SETTINGS_BIND_GET_NO_CHANGES)
2913 detailed_signal = g_strdup_printf ("changed::%s", key);
2914 binding->key_handler_id =
2915 g_signal_connect (settings, detailed_signal,
2916 G_CALLBACK (g_settings_binding_key_changed),
2918 g_free (detailed_signal);
2921 g_settings_binding_key_changed (settings, binding->info.key, binding);
2924 binding_quark = g_settings_binding_quark (property);
2925 g_object_set_qdata_full (object, binding_quark,
2926 binding, g_settings_binding_free);
2929 /* Writability binding {{{1 */
2932 GSettings *settings;
2935 const gchar *property;
2938 } GSettingsWritableBinding;
2941 g_settings_writable_binding_free (gpointer data)
2943 GSettingsWritableBinding *binding = data;
2945 g_signal_handler_disconnect (binding->settings, binding->handler_id);
2946 g_object_unref (binding->settings);
2947 g_slice_free (GSettingsWritableBinding, binding);
2951 g_settings_binding_writable_changed (GSettings *settings,
2955 GSettingsWritableBinding *binding = user_data;
2958 g_assert (settings == binding->settings);
2959 g_assert (key == binding->key);
2961 writable = g_settings_is_writable (settings, key);
2963 if (binding->inverted)
2964 writable = !writable;
2966 g_object_set (binding->object, binding->property, writable, NULL);
2970 * g_settings_bind_writable:
2971 * @settings: a #GSettings object
2972 * @key: the key to bind
2973 * @object: (type GObject.Object):a #GObject
2974 * @property: the name of a boolean property to bind
2975 * @inverted: whether to 'invert' the value
2977 * Create a binding between the writability of @key in the
2978 * @settings object and the property @property of @object.
2979 * The property must be boolean; "sensitive" or "visible"
2980 * properties of widgets are the most likely candidates.
2982 * Writable bindings are always uni-directional; changes of the
2983 * writability of the setting will be propagated to the object
2984 * property, not the other way.
2986 * When the @inverted argument is %TRUE, the binding inverts the
2987 * value as it passes from the setting to the object, i.e. @property
2988 * will be set to %TRUE if the key is <emphasis>not</emphasis>
2991 * Note that the lifecycle of the binding is tied to the object,
2992 * and that you can have only one binding per object property.
2993 * If you bind the same property twice on the same object, the second
2994 * binding overrides the first one.
2999 g_settings_bind_writable (GSettings *settings,
3002 const gchar *property,
3005 GSettingsWritableBinding *binding;
3006 gchar *detailed_signal;
3009 g_return_if_fail (G_IS_SETTINGS (settings));
3011 pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
3014 g_critical ("g_settings_bind_writable: no property '%s' on class '%s'",
3015 property, G_OBJECT_TYPE_NAME (object));
3018 if ((pspec->flags & G_PARAM_WRITABLE) == 0)
3020 g_critical ("g_settings_bind_writable: property '%s' on class '%s' is not writable",
3021 property, G_OBJECT_TYPE_NAME (object));
3025 binding = g_slice_new (GSettingsWritableBinding);
3026 binding->settings = g_object_ref (settings);
3027 binding->object = object;
3028 binding->key = g_intern_string (key);
3029 binding->property = g_intern_string (property);
3030 binding->inverted = inverted;
3032 detailed_signal = g_strdup_printf ("writable-changed::%s", key);
3033 binding->handler_id =
3034 g_signal_connect (settings, detailed_signal,
3035 G_CALLBACK (g_settings_binding_writable_changed),
3037 g_free (detailed_signal);
3039 g_object_set_qdata_full (object, g_settings_binding_quark (property),
3040 binding, g_settings_writable_binding_free);
3042 g_settings_binding_writable_changed (settings, binding->key, binding);
3046 * g_settings_unbind:
3047 * @object: the object
3048 * @property: the property whose binding is removed
3050 * Removes an existing binding for @property on @object.
3052 * Note that bindings are automatically removed when the
3053 * object is finalized, so it is rarely necessary to call this
3059 g_settings_unbind (gpointer object,
3060 const gchar *property)
3062 GQuark binding_quark;
3064 binding_quark = g_settings_binding_quark (property);
3065 g_object_set_qdata (object, binding_quark, NULL);
3070 /* vim:set foldmethod=marker: */