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-internal.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);
501 schema_path = g_settings_schema_get_path (settings->priv->schema);
503 if (settings->priv->path && schema_path && strcmp (settings->priv->path, schema_path) != 0)
504 g_error ("settings object created with schema '%s' and path '%s', but "
505 "path '%s' is specified by schema",
506 settings->priv->schema_name, settings->priv->path, schema_path);
508 if (settings->priv->path == NULL)
510 if (schema_path == NULL)
511 g_error ("attempting to create schema '%s' without a path",
512 settings->priv->schema_name);
514 settings->priv->path = g_strdup (schema_path);
517 if (settings->priv->backend == NULL)
518 settings->priv->backend = g_settings_backend_get_default ();
520 g_settings_backend_watch (settings->priv->backend,
521 &listener_vtable, G_OBJECT (settings),
522 settings->priv->main_context);
523 g_settings_backend_subscribe (settings->priv->backend,
524 settings->priv->path);
528 g_settings_finalize (GObject *object)
530 GSettings *settings = G_SETTINGS (object);
532 g_settings_backend_unsubscribe (settings->priv->backend,
533 settings->priv->path);
534 g_main_context_unref (settings->priv->main_context);
535 g_object_unref (settings->priv->backend);
536 g_settings_schema_unref (settings->priv->schema);
537 g_free (settings->priv->schema_name);
538 g_free (settings->priv->path);
540 G_OBJECT_CLASS (g_settings_parent_class)->finalize (object);
544 g_settings_init (GSettings *settings)
546 settings->priv = G_TYPE_INSTANCE_GET_PRIVATE (settings,
550 settings->priv->main_context = g_main_context_ref_thread_default ();
554 g_settings_class_init (GSettingsClass *class)
556 GObjectClass *object_class = G_OBJECT_CLASS (class);
558 class->writable_change_event = g_settings_real_writable_change_event;
559 class->change_event = g_settings_real_change_event;
561 object_class->set_property = g_settings_set_property;
562 object_class->get_property = g_settings_get_property;
563 object_class->constructed = g_settings_constructed;
564 object_class->finalize = g_settings_finalize;
566 g_type_class_add_private (object_class, sizeof (GSettingsPrivate));
569 * GSettings::changed:
570 * @settings: the object on which the signal was emitted
571 * @key: the name of the key that changed
573 * The "changed" signal is emitted when a key has potentially changed.
574 * You should call one of the g_settings_get() calls to check the new
577 * This signal supports detailed connections. You can connect to the
578 * detailed signal "changed::x" in order to only receive callbacks
579 * when key "x" changes.
581 g_settings_signals[SIGNAL_CHANGED] =
582 g_signal_new ("changed", G_TYPE_SETTINGS,
583 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
584 G_STRUCT_OFFSET (GSettingsClass, changed),
585 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
586 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
589 * GSettings::change-event:
590 * @settings: the object on which the signal was emitted
591 * @keys: (array length=n_keys) (element-type GQuark) (allow-none):
592 * an array of #GQuark<!-- -->s for the changed keys, or %NULL
593 * @n_keys: the length of the @keys array, or 0
594 * @returns: %TRUE to stop other handlers from being invoked for the
595 * event. FALSE to propagate the event further.
597 * The "change-event" signal is emitted once per change event that
598 * affects this settings object. You should connect to this signal
599 * only if you are interested in viewing groups of changes before they
600 * are split out into multiple emissions of the "changed" signal.
601 * For most use cases it is more appropriate to use the "changed" signal.
603 * In the event that the change event applies to one or more specified
604 * keys, @keys will be an array of #GQuark of length @n_keys. In the
605 * event that the change event applies to the #GSettings object as a
606 * whole (ie: potentially every key has been changed) then @keys will
607 * be %NULL and @n_keys will be 0.
609 * The default handler for this signal invokes the "changed" signal
610 * for each affected key. If any other connected handler returns
611 * %TRUE then this default functionality will be suppressed.
613 g_settings_signals[SIGNAL_CHANGE_EVENT] =
614 g_signal_new ("change-event", G_TYPE_SETTINGS,
616 G_STRUCT_OFFSET (GSettingsClass, change_event),
617 g_signal_accumulator_true_handled, NULL,
619 G_TYPE_BOOLEAN, 2, G_TYPE_POINTER, G_TYPE_INT);
622 * GSettings::writable-changed:
623 * @settings: the object on which the signal was emitted
626 * The "writable-changed" signal is emitted when the writability of a
627 * key has potentially changed. You should call
628 * g_settings_is_writable() in order to determine the new status.
630 * This signal supports detailed connections. You can connect to the
631 * detailed signal "writable-changed::x" in order to only receive
632 * callbacks when the writability of "x" changes.
634 g_settings_signals[SIGNAL_WRITABLE_CHANGED] =
635 g_signal_new ("writable-changed", G_TYPE_SETTINGS,
636 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
637 G_STRUCT_OFFSET (GSettingsClass, writable_changed),
638 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
639 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
642 * GSettings::writable-change-event:
643 * @settings: the object on which the signal was emitted
644 * @key: the quark of the key, or 0
645 * @returns: %TRUE to stop other handlers from being invoked for the
646 * event. FALSE to propagate the event further.
648 * The "writable-change-event" signal is emitted once per writability
649 * change event that affects this settings object. You should connect
650 * to this signal if you are interested in viewing groups of changes
651 * before they are split out into multiple emissions of the
652 * "writable-changed" signal. For most use cases it is more
653 * appropriate to use the "writable-changed" signal.
655 * In the event that the writability change applies only to a single
656 * key, @key will be set to the #GQuark for that key. In the event
657 * that the writability change affects the entire settings object,
660 * The default handler for this signal invokes the "writable-changed"
661 * and "changed" signals for each affected key. This is done because
662 * changes in writability might also imply changes in value (if for
663 * example, a new mandatory setting is introduced). If any other
664 * connected handler returns %TRUE then this default functionality
665 * will be suppressed.
667 g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT] =
668 g_signal_new ("writable-change-event", G_TYPE_SETTINGS,
670 G_STRUCT_OFFSET (GSettingsClass, writable_change_event),
671 g_signal_accumulator_true_handled, NULL,
672 NULL, G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
677 * The name of the context that the settings are stored in.
679 g_object_class_install_property (object_class, PROP_BACKEND,
680 g_param_spec_object ("backend",
681 P_("GSettingsBackend"),
682 P_("The GSettingsBackend for this settings object"),
683 G_TYPE_SETTINGS_BACKEND, G_PARAM_CONSTRUCT_ONLY |
684 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
689 * The name of the schema that describes the types of keys
690 * for this #GSettings object.
692 g_object_class_install_property (object_class, PROP_SCHEMA,
693 g_param_spec_string ("schema",
695 P_("The name of the schema for this settings object"),
697 G_PARAM_CONSTRUCT_ONLY |
698 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
703 * The path within the backend where the settings are stored.
705 g_object_class_install_property (object_class, PROP_PATH,
706 g_param_spec_string ("path",
708 P_("The path within the backend where the settings are"),
710 G_PARAM_CONSTRUCT_ONLY |
711 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
714 * GSettings:has-unapplied:
716 * If this property is %TRUE, the #GSettings object has outstanding
717 * changes that will be applied when g_settings_apply() is called.
719 g_object_class_install_property (object_class, PROP_HAS_UNAPPLIED,
720 g_param_spec_boolean ("has-unapplied",
721 P_("Has unapplied changes"),
722 P_("TRUE if there are outstanding changes to apply()"),
724 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
727 * GSettings:delay-apply:
729 * Whether the #GSettings object is in 'delay-apply' mode. See
730 * g_settings_delay() for details.
734 g_object_class_install_property (object_class, PROP_DELAY_APPLY,
735 g_param_spec_boolean ("delay-apply",
736 P_("Delay-apply mode"),
737 P_("Whether this settings object is in 'delay-apply' mode"),
739 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
742 /* Construction (new, new_with_path, etc.) {{{1 */
745 * @schema: the name of the schema
746 * @returns: a new #GSettings object
748 * Creates a new #GSettings object with a given schema.
750 * Signals on the newly created #GSettings object will be dispatched
751 * via the thread-default #GMainContext in effect at the time of the
752 * call to g_settings_new(). The new #GSettings will hold a reference
753 * on the context. See g_main_context_push_thread_default().
758 g_settings_new (const gchar *schema)
760 g_return_val_if_fail (schema != NULL, NULL);
762 return g_object_new (G_TYPE_SETTINGS,
768 * g_settings_new_with_path:
769 * @schema: the name of the schema
770 * @path: the path to use
771 * @returns: a new #GSettings object
773 * Creates a new #GSettings object with a given schema and path.
775 * You only need to do this if you want to directly create a settings
776 * object with a schema that doesn't have a specified path of its own.
779 * It is a programmer error to call this function for a schema that
780 * has an explicitly specified path.
785 g_settings_new_with_path (const gchar *schema,
788 g_return_val_if_fail (schema != NULL, NULL);
789 g_return_val_if_fail (path != NULL, NULL);
791 return g_object_new (G_TYPE_SETTINGS,
798 * g_settings_new_with_backend:
799 * @schema: the name of the schema
800 * @backend: the #GSettingsBackend to use
801 * @returns: a new #GSettings object
803 * Creates a new #GSettings object with a given schema and backend.
805 * Creating a #GSettings object with a different backend allows accessing
806 * settings from a database other than the usual one. For example, it may make
807 * sense to pass a backend corresponding to the "defaults" settings database on
808 * the system to get a settings object that modifies the system default
809 * settings instead of the settings for this user.
814 g_settings_new_with_backend (const gchar *schema,
815 GSettingsBackend *backend)
817 g_return_val_if_fail (schema != NULL, NULL);
818 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
820 return g_object_new (G_TYPE_SETTINGS,
827 * g_settings_new_with_backend_and_path:
828 * @schema: the name of the schema
829 * @backend: the #GSettingsBackend to use
830 * @path: the path to use
831 * @returns: a new #GSettings object
833 * Creates a new #GSettings object with a given schema, backend and
836 * This is a mix of g_settings_new_with_backend() and
837 * g_settings_new_with_path().
842 g_settings_new_with_backend_and_path (const gchar *schema,
843 GSettingsBackend *backend,
846 g_return_val_if_fail (schema != NULL, NULL);
847 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
848 g_return_val_if_fail (path != NULL, NULL);
850 return g_object_new (G_TYPE_SETTINGS,
857 /* Internal read/write utilities, enum/flags conversion, validation {{{1 */
860 const gchar *schema_name;
861 const gchar *gettext_domain;
867 const guint32 *strinfo;
868 gsize strinfo_length;
870 const gchar *unparsed;
873 const GVariantType *type;
874 GVariant *minimum, *maximum;
875 GVariant *default_value;
879 endian_fixup (GVariant **value)
881 #if G_BYTE_ORDER == G_BIG_ENDIAN
884 tmp = g_variant_byteswap (*value);
885 g_variant_unref (*value);
891 g_settings_get_key_info (GSettingsKeyInfo *info,
899 memset (info, 0, sizeof *info);
901 iter = g_settings_schema_get_value (settings->priv->schema, key);
903 info->gettext_domain = g_settings_schema_get_gettext_domain (settings->priv->schema);
904 info->schema_name = settings->priv->schema_name;
905 info->default_value = g_variant_iter_next_value (iter);
906 endian_fixup (&info->default_value);
907 info->type = g_variant_get_type (info->default_value);
908 info->key = g_intern_string (key);
910 while (g_variant_iter_next (iter, "(y*)", &code, &data))
915 /* translation requested */
916 g_variant_get (data, "(y&s)", &info->lc_char, &info->unparsed);
920 /* enumerated types... */
921 info->is_enum = TRUE;
926 info->is_flags = TRUE;
930 /* ..., choices, aliases */
931 info->strinfo = g_variant_get_fixed_array (data,
932 &info->strinfo_length,
937 g_variant_get (data, "(**)", &info->minimum, &info->maximum);
938 endian_fixup (&info->minimum);
939 endian_fixup (&info->maximum);
943 g_warning ("unknown schema extension '%c'", code);
947 g_variant_unref (data);
950 g_variant_iter_free (iter);
954 g_settings_free_key_info (GSettingsKeyInfo *info)
957 g_variant_unref (info->minimum);
960 g_variant_unref (info->maximum);
962 g_variant_unref (info->default_value);
966 g_settings_write_to_backend (GSettings *settings,
967 GSettingsKeyInfo *info,
973 path = g_strconcat (settings->priv->path, info->key, NULL);
974 success = g_settings_backend_write (settings->priv->backend, path, value, NULL);
981 g_settings_type_check (GSettingsKeyInfo *info,
984 g_return_val_if_fail (value != NULL, FALSE);
986 return g_variant_is_of_type (value, info->type);
990 g_settings_key_info_range_check (GSettingsKeyInfo *info,
993 if (info->minimum == NULL && info->strinfo == NULL)
996 if (g_variant_is_container (value))
1002 g_variant_iter_init (&iter, value);
1003 while (ok && (child = g_variant_iter_next_value (&iter)))
1005 ok = g_settings_key_info_range_check (info, child);
1006 g_variant_unref (child);
1014 return g_variant_compare (info->minimum, value) <= 0 &&
1015 g_variant_compare (value, info->maximum) <= 0;
1018 return strinfo_is_string_valid (info->strinfo,
1019 info->strinfo_length,
1020 g_variant_get_string (value, NULL));
1024 g_settings_range_fixup (GSettingsKeyInfo *info,
1027 const gchar *target;
1029 if (g_settings_key_info_range_check (info, value))
1030 return g_variant_ref (value);
1032 if (info->strinfo == NULL)
1035 if (g_variant_is_container (value))
1037 GVariantBuilder builder;
1041 g_variant_iter_init (&iter, value);
1042 g_variant_builder_init (&builder, g_variant_get_type (value));
1044 while ((child = g_variant_iter_next_value (&iter)))
1048 fixed = g_settings_range_fixup (info, child);
1049 g_variant_unref (child);
1053 g_variant_builder_clear (&builder);
1057 g_variant_builder_add_value (&builder, fixed);
1058 g_variant_unref (fixed);
1061 return g_variant_ref_sink (g_variant_builder_end (&builder));
1064 target = strinfo_string_from_alias (info->strinfo, info->strinfo_length,
1065 g_variant_get_string (value, NULL));
1066 return target ? g_variant_ref_sink (g_variant_new_string (target)) : NULL;
1070 g_settings_read_from_backend (GSettings *settings,
1071 GSettingsKeyInfo *info)
1077 path = g_strconcat (settings->priv->path, info->key, NULL);
1078 value = g_settings_backend_read (settings->priv->backend, path, info->type, FALSE);
1083 fixup = g_settings_range_fixup (info, value);
1084 g_variant_unref (value);
1093 g_settings_get_translated_default (GSettingsKeyInfo *info)
1095 const gchar *translated;
1096 GError *error = NULL;
1099 if (info->lc_char == '\0')
1100 /* translation not requested for this key */
1103 if (info->lc_char == 't')
1104 translated = g_dcgettext (info->gettext_domain, info->unparsed, LC_TIME);
1106 translated = g_dgettext (info->gettext_domain, info->unparsed);
1108 if (translated == info->unparsed)
1109 /* the default value was not translated */
1112 /* try to parse the translation of the unparsed default */
1113 value = g_variant_parse (info->type, translated, NULL, NULL, &error);
1117 g_warning ("Failed to parse translated string `%s' for "
1118 "key `%s' in schema `%s': %s", info->unparsed, info->key,
1119 info->schema_name, error->message);
1120 g_warning ("Using untranslated default instead.");
1121 g_error_free (error);
1124 else if (!g_settings_key_info_range_check (info, value))
1126 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
1127 "is outside of valid range", info->unparsed, info->key,
1129 g_variant_unref (value);
1137 g_settings_to_enum (GSettingsKeyInfo *info,
1143 it_worked = strinfo_enum_from_string (info->strinfo, info->strinfo_length,
1144 g_variant_get_string (value, NULL),
1147 /* 'value' can only come from the backend after being filtered for validity,
1148 * from the translation after being filtered for validity, or from the schema
1149 * itself (which the schema compiler checks for validity). If this assertion
1150 * fails then it's really a bug in GSettings or the schema compiler...
1152 g_assert (it_worked);
1158 g_settings_from_enum (GSettingsKeyInfo *info,
1161 const gchar *string;
1163 string = strinfo_string_from_enum (info->strinfo,
1164 info->strinfo_length,
1170 return g_variant_new_string (string);
1174 g_settings_to_flags (GSettingsKeyInfo *info,
1182 g_variant_iter_init (&iter, value);
1183 while (g_variant_iter_next (&iter, "&s", &flag))
1188 it_worked = strinfo_enum_from_string (info->strinfo,
1189 info->strinfo_length,
1191 /* as in g_settings_to_enum() */
1192 g_assert (it_worked);
1194 result |= flag_value;
1201 g_settings_from_flags (GSettingsKeyInfo *info,
1204 GVariantBuilder builder;
1207 g_variant_builder_init (&builder, G_VARIANT_TYPE ("as"));
1209 for (i = 0; i < 32; i++)
1210 if (value & (1u << i))
1212 const gchar *string;
1214 string = strinfo_string_from_enum (info->strinfo,
1215 info->strinfo_length,
1220 g_variant_builder_clear (&builder);
1224 g_variant_builder_add (&builder, "s", string);
1227 return g_variant_builder_end (&builder);
1230 /* Public Get/Set API {{{1 (get, get_value, set, set_value, get_mapped) */
1232 * g_settings_get_value:
1233 * @settings: a #GSettings object
1234 * @key: the key to get the value for
1235 * @returns: a new #GVariant
1237 * Gets the value that is stored in @settings for @key.
1239 * It is a programmer error to give a @key that isn't contained in the
1240 * schema for @settings.
1245 g_settings_get_value (GSettings *settings,
1248 GSettingsKeyInfo info;
1251 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1252 g_return_val_if_fail (key != NULL, NULL);
1254 g_settings_get_key_info (&info, settings, key);
1255 value = g_settings_read_from_backend (settings, &info);
1258 value = g_settings_get_translated_default (&info);
1261 value = g_variant_ref (info.default_value);
1263 g_settings_free_key_info (&info);
1269 * g_settings_get_enum:
1270 * @settings: a #GSettings object
1271 * @key: the key to get the value for
1272 * @returns: the enum value
1274 * Gets the value that is stored in @settings for @key and converts it
1275 * to the enum value that it represents.
1277 * In order to use this function the type of the value must be a string
1278 * and it must be marked in the schema file as an enumerated type.
1280 * It is a programmer error to give a @key that isn't contained in the
1281 * schema for @settings or is not marked as an enumerated type.
1283 * If the value stored in the configuration database is not a valid
1284 * value for the enumerated type then this function will return the
1290 g_settings_get_enum (GSettings *settings,
1293 GSettingsKeyInfo info;
1297 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1298 g_return_val_if_fail (key != NULL, -1);
1300 g_settings_get_key_info (&info, settings, key);
1304 g_critical ("g_settings_get_enum() called on key `%s' which is not "
1305 "associated with an enumerated type", info.key);
1306 g_settings_free_key_info (&info);
1310 value = g_settings_read_from_backend (settings, &info);
1313 value = g_settings_get_translated_default (&info);
1316 value = g_variant_ref (info.default_value);
1318 result = g_settings_to_enum (&info, value);
1319 g_settings_free_key_info (&info);
1320 g_variant_unref (value);
1326 * g_settings_set_enum:
1327 * @settings: a #GSettings object
1328 * @key: a key, within @settings
1329 * @value: an enumerated value
1330 * @returns: %TRUE, if the set succeeds
1332 * Looks up the enumerated type nick for @value and writes it to @key,
1335 * It is a programmer error to give a @key that isn't contained in the
1336 * schema for @settings or is not marked as an enumerated type, or for
1337 * @value not to be a valid value for the named type.
1339 * After performing the write, accessing @key directly with
1340 * g_settings_get_string() will return the 'nick' associated with
1344 g_settings_set_enum (GSettings *settings,
1348 GSettingsKeyInfo info;
1352 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1353 g_return_val_if_fail (key != NULL, FALSE);
1355 g_settings_get_key_info (&info, settings, key);
1359 g_critical ("g_settings_set_enum() called on key `%s' which is not "
1360 "associated with an enumerated type", info.key);
1364 if (!(variant = g_settings_from_enum (&info, value)))
1366 g_critical ("g_settings_set_enum(): invalid enum value %d for key `%s' "
1367 "in schema `%s'. Doing nothing.", value, info.key,
1369 g_settings_free_key_info (&info);
1373 success = g_settings_write_to_backend (settings, &info, variant);
1374 g_settings_free_key_info (&info);
1380 * g_settings_get_flags:
1381 * @settings: a #GSettings object
1382 * @key: the key to get the value for
1383 * @returns: the flags value
1385 * Gets the value that is stored in @settings for @key and converts it
1386 * to the flags value that it represents.
1388 * In order to use this function the type of the value must be an array
1389 * of strings and it must be marked in the schema file as an flags type.
1391 * It is a programmer error to give a @key that isn't contained in the
1392 * schema for @settings or is not marked as a flags type.
1394 * If the value stored in the configuration database is not a valid
1395 * value for the flags type then this function will return the default
1401 g_settings_get_flags (GSettings *settings,
1404 GSettingsKeyInfo info;
1408 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1409 g_return_val_if_fail (key != NULL, -1);
1411 g_settings_get_key_info (&info, settings, key);
1415 g_critical ("g_settings_get_flags() called on key `%s' which is not "
1416 "associated with a flags type", info.key);
1417 g_settings_free_key_info (&info);
1421 value = g_settings_read_from_backend (settings, &info);
1424 value = g_settings_get_translated_default (&info);
1427 value = g_variant_ref (info.default_value);
1429 result = g_settings_to_flags (&info, value);
1430 g_settings_free_key_info (&info);
1431 g_variant_unref (value);
1437 * g_settings_set_flags:
1438 * @settings: a #GSettings object
1439 * @key: a key, within @settings
1440 * @value: a flags value
1441 * @returns: %TRUE, if the set succeeds
1443 * Looks up the flags type nicks for the bits specified by @value, puts
1444 * them in an array of strings and writes the array to @key, within
1447 * It is a programmer error to give a @key that isn't contained in the
1448 * schema for @settings or is not marked as a flags type, or for @value
1449 * to contain any bits that are not value for the named type.
1451 * After performing the write, accessing @key directly with
1452 * g_settings_get_strv() will return an array of 'nicks'; one for each
1456 g_settings_set_flags (GSettings *settings,
1460 GSettingsKeyInfo info;
1464 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1465 g_return_val_if_fail (key != NULL, FALSE);
1467 g_settings_get_key_info (&info, settings, key);
1471 g_critical ("g_settings_set_flags() called on key `%s' which is not "
1472 "associated with a flags type", info.key);
1476 if (!(variant = g_settings_from_flags (&info, value)))
1478 g_critical ("g_settings_set_flags(): invalid flags value 0x%08x "
1479 "for key `%s' in schema `%s'. Doing nothing.",
1480 value, info.key, info.schema_name);
1481 g_settings_free_key_info (&info);
1485 success = g_settings_write_to_backend (settings, &info, variant);
1486 g_settings_free_key_info (&info);
1492 * g_settings_set_value:
1493 * @settings: a #GSettings object
1494 * @key: the name of the key to set
1495 * @value: a #GVariant of the correct type
1496 * @returns: %TRUE if setting the key succeeded,
1497 * %FALSE if the key was not writable
1499 * Sets @key in @settings to @value.
1501 * It is a programmer error to give a @key that isn't contained in the
1502 * schema for @settings or for @value to have the incorrect type, per
1505 * If @value is floating then this function consumes the reference.
1510 g_settings_set_value (GSettings *settings,
1514 GSettingsKeyInfo info;
1516 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1517 g_return_val_if_fail (key != NULL, FALSE);
1519 g_settings_get_key_info (&info, settings, key);
1521 if (!g_settings_type_check (&info, value))
1523 g_critical ("g_settings_set_value: key '%s' in '%s' expects type '%s', but a GVariant of type '%s' was given",
1525 settings->priv->schema_name,
1526 g_variant_type_peek_string (info.type),
1527 g_variant_get_type_string (value));
1532 if (!g_settings_key_info_range_check (&info, value))
1534 g_warning ("g_settings_set_value: value for key '%s' in schema '%s' "
1535 "is outside of valid range",
1537 settings->priv->schema_name);
1542 g_settings_free_key_info (&info);
1544 return g_settings_write_to_backend (settings, &info, value);
1549 * @settings: a #GSettings object
1550 * @key: the key to get the value for
1551 * @format: a #GVariant format string
1552 * @...: arguments as per @format
1554 * Gets the value that is stored at @key in @settings.
1556 * A convenience function that combines g_settings_get_value() with
1559 * It is a programmer error to give a @key that isn't contained in the
1560 * schema for @settings or for the #GVariantType of @format to mismatch
1561 * the type given in the schema.
1566 g_settings_get (GSettings *settings,
1568 const gchar *format,
1574 value = g_settings_get_value (settings, key);
1576 va_start (ap, format);
1577 g_variant_get_va (value, format, NULL, &ap);
1580 g_variant_unref (value);
1585 * @settings: a #GSettings object
1586 * @key: the name of the key to set
1587 * @format: a #GVariant format string
1588 * @...: arguments as per @format
1589 * @returns: %TRUE if setting the key succeeded,
1590 * %FALSE if the key was not writable
1592 * Sets @key in @settings to @value.
1594 * A convenience function that combines g_settings_set_value() with
1597 * It is a programmer error to give a @key that isn't contained in the
1598 * schema for @settings or for the #GVariantType of @format to mismatch
1599 * the type given in the schema.
1604 g_settings_set (GSettings *settings,
1606 const gchar *format,
1612 va_start (ap, format);
1613 value = g_variant_new_va (format, NULL, &ap);
1616 return g_settings_set_value (settings, key, value);
1620 * g_settings_get_mapped:
1621 * @settings: a #GSettings object
1622 * @key: the key to get the value for
1623 * @mapping: (scope call): the function to map the value in the
1624 * settings database to the value used by the application
1625 * @user_data: user data for @mapping
1626 * @returns: (transfer full): the result, which may be %NULL
1628 * Gets the value that is stored at @key in @settings, subject to
1629 * application-level validation/mapping.
1631 * You should use this function when the application needs to perform
1632 * some processing on the value of the key (for example, parsing). The
1633 * @mapping function performs that processing. If the function
1634 * indicates that the processing was unsuccessful (due to a parse error,
1635 * for example) then the mapping is tried again with another value.
1637 * This allows a robust 'fall back to defaults' behaviour to be
1638 * implemented somewhat automatically.
1640 * The first value that is tried is the user's setting for the key. If
1641 * the mapping function fails to map this value, other values may be
1642 * tried in an unspecified order (system or site defaults, translated
1643 * schema default values, untranslated schema default values, etc).
1645 * If the mapping function fails for all possible values, one additional
1646 * attempt is made: the mapping function is called with a %NULL value.
1647 * If the mapping function still indicates failure at this point then
1648 * the application will be aborted.
1650 * The result parameter for the @mapping function is pointed to a
1651 * #gpointer which is initially set to %NULL. The same pointer is given
1652 * to each invocation of @mapping. The final value of that #gpointer is
1653 * what is returned by this function. %NULL is valid; it is returned
1654 * just as any other value would be.
1657 g_settings_get_mapped (GSettings *settings,
1659 GSettingsGetMapping mapping,
1662 gpointer result = NULL;
1663 GSettingsKeyInfo info;
1667 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1668 g_return_val_if_fail (key != NULL, NULL);
1669 g_return_val_if_fail (mapping != NULL, NULL);
1671 g_settings_get_key_info (&info, settings, key);
1673 if ((value = g_settings_read_from_backend (settings, &info)))
1675 okay = mapping (value, &result, user_data);
1676 g_variant_unref (value);
1677 if (okay) goto okay;
1680 if ((value = g_settings_get_translated_default (&info)))
1682 okay = mapping (value, &result, user_data);
1683 g_variant_unref (value);
1684 if (okay) goto okay;
1687 if (mapping (info.default_value, &result, user_data))
1690 if (!mapping (NULL, &result, user_data))
1691 g_error ("The mapping function given to g_settings_get_mapped() for key "
1692 "`%s' in schema `%s' returned FALSE when given a NULL value.",
1693 key, settings->priv->schema_name);
1696 g_settings_free_key_info (&info);
1701 /* Convenience API (get, set_string, int, double, boolean, strv) {{{1 */
1703 * g_settings_get_string:
1704 * @settings: a #GSettings object
1705 * @key: the key to get the value for
1706 * @returns: a newly-allocated string
1708 * Gets the value that is stored at @key in @settings.
1710 * A convenience variant of g_settings_get() for strings.
1712 * It is a programmer error to give a @key that isn't specified as
1713 * having a string type in the schema for @settings.
1718 g_settings_get_string (GSettings *settings,
1724 value = g_settings_get_value (settings, key);
1725 result = g_variant_dup_string (value, NULL);
1726 g_variant_unref (value);
1732 * g_settings_set_string:
1733 * @settings: a #GSettings object
1734 * @key: the name of the key to set
1735 * @value: the value to set it to
1736 * @returns: %TRUE if setting the key succeeded,
1737 * %FALSE if the key was not writable
1739 * Sets @key in @settings to @value.
1741 * A convenience variant of g_settings_set() for strings.
1743 * It is a programmer error to give a @key that isn't specified as
1744 * having a string type in the schema for @settings.
1749 g_settings_set_string (GSettings *settings,
1753 return g_settings_set_value (settings, key, g_variant_new_string (value));
1757 * g_settings_get_int:
1758 * @settings: a #GSettings object
1759 * @key: the key to get the value for
1760 * @returns: an integer
1762 * Gets the value that is stored at @key in @settings.
1764 * A convenience variant of g_settings_get() for 32-bit integers.
1766 * It is a programmer error to give a @key that isn't specified as
1767 * having a int32 type in the schema for @settings.
1772 g_settings_get_int (GSettings *settings,
1778 value = g_settings_get_value (settings, key);
1779 result = g_variant_get_int32 (value);
1780 g_variant_unref (value);
1786 * g_settings_set_int:
1787 * @settings: a #GSettings object
1788 * @key: the name of the key to set
1789 * @value: the value to set it to
1790 * @returns: %TRUE if setting the key succeeded,
1791 * %FALSE if the key was not writable
1793 * Sets @key in @settings to @value.
1795 * A convenience variant of g_settings_set() for 32-bit integers.
1797 * It is a programmer error to give a @key that isn't specified as
1798 * having a int32 type in the schema for @settings.
1803 g_settings_set_int (GSettings *settings,
1807 return g_settings_set_value (settings, key, g_variant_new_int32 (value));
1811 * g_settings_get_uint:
1812 * @settings: a #GSettings object
1813 * @key: the key to get the value for
1814 * @returns: an unsigned integer
1816 * Gets the value that is stored at @key in @settings.
1818 * A convenience variant of g_settings_get() for 32-bit unsigned
1821 * It is a programmer error to give a @key that isn't specified as
1822 * having a uint32 type in the schema for @settings.
1827 g_settings_get_uint (GSettings *settings,
1833 value = g_settings_get_value (settings, key);
1834 result = g_variant_get_uint32 (value);
1835 g_variant_unref (value);
1841 * g_settings_set_uint:
1842 * @settings: a #GSettings object
1843 * @key: the name of the key to set
1844 * @value: the value to set it to
1845 * @returns: %TRUE if setting the key succeeded,
1846 * %FALSE if the key was not writable
1848 * Sets @key in @settings to @value.
1850 * A convenience variant of g_settings_set() for 32-bit unsigned
1853 * It is a programmer error to give a @key that isn't specified as
1854 * having a uint32 type in the schema for @settings.
1859 g_settings_set_uint (GSettings *settings,
1863 return g_settings_set_value (settings, key, g_variant_new_uint32 (value));
1867 * g_settings_get_double:
1868 * @settings: a #GSettings object
1869 * @key: the key to get the value for
1870 * @returns: a double
1872 * Gets the value that is stored at @key in @settings.
1874 * A convenience variant of g_settings_get() for doubles.
1876 * It is a programmer error to give a @key that isn't specified as
1877 * having a 'double' type in the schema for @settings.
1882 g_settings_get_double (GSettings *settings,
1888 value = g_settings_get_value (settings, key);
1889 result = g_variant_get_double (value);
1890 g_variant_unref (value);
1896 * g_settings_set_double:
1897 * @settings: a #GSettings object
1898 * @key: the name of the key to set
1899 * @value: the value to set it to
1900 * @returns: %TRUE if setting the key succeeded,
1901 * %FALSE if the key was not writable
1903 * Sets @key in @settings to @value.
1905 * A convenience variant of g_settings_set() for doubles.
1907 * It is a programmer error to give a @key that isn't specified as
1908 * having a 'double' type in the schema for @settings.
1913 g_settings_set_double (GSettings *settings,
1917 return g_settings_set_value (settings, key, g_variant_new_double (value));
1921 * g_settings_get_boolean:
1922 * @settings: a #GSettings object
1923 * @key: the key to get the value for
1924 * @returns: a boolean
1926 * Gets the value that is stored at @key in @settings.
1928 * A convenience variant of g_settings_get() for booleans.
1930 * It is a programmer error to give a @key that isn't specified as
1931 * having a boolean type in the schema for @settings.
1936 g_settings_get_boolean (GSettings *settings,
1942 value = g_settings_get_value (settings, key);
1943 result = g_variant_get_boolean (value);
1944 g_variant_unref (value);
1950 * g_settings_set_boolean:
1951 * @settings: a #GSettings object
1952 * @key: the name of the key to set
1953 * @value: the value to set it to
1954 * @returns: %TRUE if setting the key succeeded,
1955 * %FALSE if the key was not writable
1957 * Sets @key in @settings to @value.
1959 * A convenience variant of g_settings_set() for booleans.
1961 * It is a programmer error to give a @key that isn't specified as
1962 * having a boolean type in the schema for @settings.
1967 g_settings_set_boolean (GSettings *settings,
1971 return g_settings_set_value (settings, key, g_variant_new_boolean (value));
1975 * g_settings_get_strv:
1976 * @settings: a #GSettings object
1977 * @key: the key to get the value for
1978 * @returns: (array zero-terminated=1) (transfer full): a
1979 * newly-allocated, %NULL-terminated array of strings, the value that
1980 * is stored at @key in @settings.
1982 * A convenience variant of g_settings_get() for string arrays.
1984 * It is a programmer error to give a @key that isn't specified as
1985 * having an array of strings type in the schema for @settings.
1990 g_settings_get_strv (GSettings *settings,
1996 value = g_settings_get_value (settings, key);
1997 result = g_variant_dup_strv (value, NULL);
1998 g_variant_unref (value);
2004 * g_settings_set_strv:
2005 * @settings: a #GSettings object
2006 * @key: the name of the key to set
2007 * @value: (allow-none) (array zero-terminated=1): the value to set it to, or %NULL
2008 * @returns: %TRUE if setting the key succeeded,
2009 * %FALSE if the key was not writable
2011 * Sets @key in @settings to @value.
2013 * A convenience variant of g_settings_set() for string arrays. If
2014 * @value is %NULL, then @key is set to be the empty array.
2016 * It is a programmer error to give a @key that isn't specified as
2017 * having an array of strings type in the schema for @settings.
2022 g_settings_set_strv (GSettings *settings,
2024 const gchar * const *value)
2029 array = g_variant_new_strv (value, -1);
2031 array = g_variant_new_strv (NULL, 0);
2033 return g_settings_set_value (settings, key, array);
2036 /* Delayed apply (delay, apply, revert, get_has_unapplied) {{{1 */
2039 * @settings: a #GSettings object
2041 * Changes the #GSettings object into 'delay-apply' mode. In this
2042 * mode, changes to @settings are not immediately propagated to the
2043 * backend, but kept locally until g_settings_apply() is called.
2048 g_settings_delay (GSettings *settings)
2050 g_return_if_fail (G_IS_SETTINGS (settings));
2052 if (settings->priv->delayed)
2055 settings->priv->delayed =
2056 g_delayed_settings_backend_new (settings->priv->backend,
2058 settings->priv->main_context);
2059 g_settings_backend_unwatch (settings->priv->backend, G_OBJECT (settings));
2060 g_object_unref (settings->priv->backend);
2062 settings->priv->backend = G_SETTINGS_BACKEND (settings->priv->delayed);
2063 g_settings_backend_watch (settings->priv->backend,
2064 &listener_vtable, G_OBJECT (settings),
2065 settings->priv->main_context);
2067 g_object_notify (G_OBJECT (settings), "delay-apply");
2072 * @settings: a #GSettings instance
2074 * Applies any changes that have been made to the settings. This
2075 * function does nothing unless @settings is in 'delay-apply' mode;
2076 * see g_settings_delay(). In the normal case settings are always
2077 * applied immediately.
2080 g_settings_apply (GSettings *settings)
2082 if (settings->priv->delayed)
2084 GDelayedSettingsBackend *delayed;
2086 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
2087 g_delayed_settings_backend_apply (delayed);
2092 * g_settings_revert:
2093 * @settings: a #GSettings instance
2095 * Reverts all non-applied changes to the settings. This function
2096 * does nothing unless @settings is in 'delay-apply' mode; see
2097 * g_settings_delay(). In the normal case settings are always applied
2100 * Change notifications will be emitted for affected keys.
2103 g_settings_revert (GSettings *settings)
2105 if (settings->priv->delayed)
2107 GDelayedSettingsBackend *delayed;
2109 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
2110 g_delayed_settings_backend_revert (delayed);
2115 * g_settings_get_has_unapplied:
2116 * @settings: a #GSettings object
2117 * @returns: %TRUE if @settings has unapplied changes
2119 * Returns whether the #GSettings object has any unapplied
2120 * changes. This can only be the case if it is in 'delayed-apply' mode.
2125 g_settings_get_has_unapplied (GSettings *settings)
2127 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
2129 return settings->priv->delayed &&
2130 g_delayed_settings_backend_get_has_unapplied (
2131 G_DELAYED_SETTINGS_BACKEND (settings->priv->backend));
2134 /* Extra API (reset, sync, get_child, is_writable, list_*, ranges) {{{1 */
2137 * @settings: a #GSettings object
2138 * @key: the name of a key
2140 * Resets @key to its default value.
2142 * This call resets the key, as much as possible, to its default value.
2143 * That might the value specified in the schema or the one set by the
2147 g_settings_reset (GSettings *settings,
2152 path = g_strconcat (settings->priv->path, key, NULL);
2153 g_settings_backend_reset (settings->priv->backend, path, NULL);
2160 * Ensures that all pending operations for the given are complete for
2161 * the default backend.
2163 * Writes made to a #GSettings are handled asynchronously. For this
2164 * reason, it is very unlikely that the changes have it to disk by the
2165 * time g_settings_set() returns.
2167 * This call will block until all of the writes have made it to the
2168 * backend. Since the mainloop is not running, no change notifications
2169 * will be dispatched during this call (but some may be queued by the
2170 * time the call is done).
2173 g_settings_sync (void)
2175 g_settings_backend_sync_default ();
2179 * g_settings_is_writable:
2180 * @settings: a #GSettings object
2181 * @name: the name of a key
2182 * @returns: %TRUE if the key @name is writable
2184 * Finds out if a key can be written or not
2189 g_settings_is_writable (GSettings *settings,
2195 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
2197 path = g_strconcat (settings->priv->path, name, NULL);
2198 writable = g_settings_backend_get_writable (settings->priv->backend, path);
2205 * g_settings_get_child:
2206 * @settings: a #GSettings object
2207 * @name: the name of the 'child' schema
2208 * @returns: (transfer full): a 'child' settings object
2210 * Creates a 'child' settings object which has a base path of
2211 * <replaceable>base-path</replaceable>/@name, where
2212 * <replaceable>base-path</replaceable> is the base path of @settings.
2214 * The schema for the child settings object must have been declared
2215 * in the schema of @settings using a <tag class="starttag">child</tag> element.
2220 g_settings_get_child (GSettings *settings,
2223 const gchar *child_schema;
2228 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
2230 child_name = g_strconcat (name, "/", NULL);
2231 child_schema = g_settings_schema_get_string (settings->priv->schema,
2233 if (child_schema == NULL)
2234 g_error ("Schema '%s' has no child '%s'",
2235 settings->priv->schema_name, name);
2237 child_path = g_strconcat (settings->priv->path, child_name, NULL);
2238 child = g_object_new (G_TYPE_SETTINGS,
2239 "schema", child_schema,
2242 g_free (child_path);
2243 g_free (child_name);
2249 * g_settings_list_keys:
2250 * @settings: a #GSettings object
2251 * @returns: (transfer full) (element-type utf8): a list of the keys on @settings
2253 * Introspects the list of keys on @settings.
2255 * You should probably not be calling this function from "normal" code
2256 * (since you should already know what keys are in your schema). This
2257 * function is intended for introspection reasons.
2259 * You should free the return value with g_strfreev() when you are done
2263 g_settings_list_keys (GSettings *settings)
2270 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2271 strv = g_new (gchar *, n_keys + 1);
2272 for (i = j = 0; i < n_keys; i++)
2274 const gchar *key = g_quark_to_string (keys[i]);
2276 if (!g_str_has_suffix (key, "/"))
2277 strv[j++] = g_strdup (key);
2285 * g_settings_list_children:
2286 * @settings: a #GSettings object
2287 * @returns: (transfer full) (element-type utf8): a list of the children on @settings
2289 * Gets the list of children on @settings.
2291 * The list is exactly the list of strings for which it is not an error
2292 * to call g_settings_get_child().
2294 * For GSettings objects that are lists, this value can change at any
2295 * time and you should connect to the "children-changed" signal to watch
2296 * for those changes. Note that there is a race condition here: you may
2297 * request a child after listing it only for it to have been destroyed
2298 * in the meantime. For this reason, g_settings_get_child() may return
2299 * %NULL even for a child that was listed by this function.
2301 * For GSettings objects that are not lists, you should probably not be
2302 * calling this function from "normal" code (since you should already
2303 * know what children are in your schema). This function may still be
2304 * useful there for introspection reasons, however.
2306 * You should free the return value with g_strfreev() when you are done
2310 g_settings_list_children (GSettings *settings)
2317 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2318 strv = g_new (gchar *, n_keys + 1);
2319 for (i = j = 0; i < n_keys; i++)
2321 const gchar *key = g_quark_to_string (keys[i]);
2323 if (g_str_has_suffix (key, "/"))
2325 gint length = strlen (key);
2327 strv[j] = g_memdup (key, length);
2328 strv[j][length - 1] = '\0';
2338 * g_settings_get_range:
2339 * @settings: a #GSettings
2340 * @key: the key to query the range of
2341 * @returns: a #GVariant describing the range
2343 * Queries the range of a key.
2345 * This function will return a #GVariant that fully describes the range
2346 * of values that are valid for @key.
2348 * The type of #GVariant returned is <literal>(sv)</literal>. The
2349 * string describes the type of range restriction in effect. The type
2350 * and meaning of the value contained in the variant depends on the
2353 * If the string is <literal>'type'</literal> then the variant contains
2354 * an empty array. The element type of that empty array is the expected
2355 * type of value and all values of that type are valid.
2357 * If the string is <literal>'enum'</literal> then the variant contains
2358 * an array enumerating the possible values. Each item in the array is
2359 * a possible valid value and no other values are valid.
2361 * If the string is <literal>'flags'</literal> then the variant contains
2362 * an array. Each item in the array is a value that may appear zero or
2363 * one times in an array to be used as the value for this key. For
2364 * example, if the variant contained the array <literal>['x',
2365 * 'y']</literal> then the valid values for the key would be
2366 * <literal>[]</literal>, <literal>['x']</literal>,
2367 * <literal>['y']</literal>, <literal>['x', 'y']</literal> and
2368 * <literal>['y', 'x']</literal>.
2370 * Finally, if the string is <literal>'range'</literal> then the variant
2371 * contains a pair of like-typed values -- the minimum and maximum
2372 * permissible values for this key.
2374 * This information should not be used by normal programs. It is
2375 * considered to be a hint for introspection purposes. Normal programs
2376 * should already know what is permitted by their own schema. The
2377 * format may change in any way in the future -- but particularly, new
2378 * forms may be added to the possibilities described above.
2380 * It is a programmer error to give a @key that isn't contained in the
2381 * schema for @settings.
2383 * You should free the returned value with g_variant_unref() when it is
2389 g_settings_get_range (GSettings *settings,
2392 GSettingsKeyInfo info;
2396 g_settings_get_key_info (&info, settings, key);
2400 range = g_variant_new ("(**)", info.minimum, info.maximum);
2403 else if (info.strinfo)
2405 range = strinfo_enumerate (info.strinfo, info.strinfo_length);
2406 type = info.is_flags ? "flags" : "enum";
2410 range = g_variant_new_array (info.type, NULL, 0);
2414 g_settings_free_key_info (&info);
2416 return g_variant_ref_sink (g_variant_new ("(sv)", type, range));
2420 * g_settings_range_check:
2421 * @settings: a #GSettings
2422 * @key: the key to check
2423 * @value: the value to check
2424 * @returns: %TRUE if @value is valid for @key
2426 * Checks if the given @value is of the correct type and within the
2427 * permitted range for @key.
2429 * This API is not intended to be used by normal programs -- they should
2430 * already know what is permitted by their own schemas. This API is
2431 * meant to be used by programs such as editors or commandline tools.
2433 * It is a programmer error to give a @key that isn't contained in the
2434 * schema for @settings.
2439 g_settings_range_check (GSettings *settings,
2443 GSettingsKeyInfo info;
2446 g_settings_get_key_info (&info, settings, key);
2447 good = g_settings_type_check (&info, value) &&
2448 g_settings_key_info_range_check (&info, value);
2449 g_settings_free_key_info (&info);
2457 GSettingsKeyInfo info;
2458 GSettings *settings;
2461 GSettingsBindGetMapping get_mapping;
2462 GSettingsBindSetMapping set_mapping;
2464 GDestroyNotify destroy;
2466 guint writable_handler_id;
2467 guint property_handler_id;
2468 const GParamSpec *property;
2469 guint key_handler_id;
2471 /* prevent recursion */
2476 g_settings_binding_free (gpointer data)
2478 GSettingsBinding *binding = data;
2480 g_assert (!binding->running);
2482 if (binding->writable_handler_id)
2483 g_signal_handler_disconnect (binding->settings,
2484 binding->writable_handler_id);
2486 if (binding->key_handler_id)
2487 g_signal_handler_disconnect (binding->settings,
2488 binding->key_handler_id);
2490 if (g_signal_handler_is_connected (binding->object,
2491 binding->property_handler_id))
2492 g_signal_handler_disconnect (binding->object,
2493 binding->property_handler_id);
2495 g_settings_free_key_info (&binding->info);
2497 if (binding->destroy)
2498 binding->destroy (binding->user_data);
2500 g_object_unref (binding->settings);
2502 g_slice_free (GSettingsBinding, binding);
2506 g_settings_binding_quark (const char *property)
2511 tmp = g_strdup_printf ("gsettingsbinding-%s", property);
2512 quark = g_quark_from_string (tmp);
2519 g_settings_binding_key_changed (GSettings *settings,
2523 GSettingsBinding *binding = user_data;
2524 GValue value = G_VALUE_INIT;
2527 g_assert (settings == binding->settings);
2528 g_assert (key == binding->info.key);
2530 if (binding->running)
2533 binding->running = TRUE;
2535 g_value_init (&value, binding->property->value_type);
2537 variant = g_settings_read_from_backend (binding->settings, &binding->info);
2538 if (variant && !binding->get_mapping (&value, variant, binding->user_data))
2540 /* silently ignore errors in the user's config database */
2541 g_variant_unref (variant);
2545 if (variant == NULL)
2547 variant = g_settings_get_translated_default (&binding->info);
2549 !binding->get_mapping (&value, variant, binding->user_data))
2551 /* flag translation errors with a warning */
2552 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
2553 "was rejected by the binding mapping function",
2554 binding->info.unparsed, binding->info.key,
2555 binding->info.schema_name);
2556 g_variant_unref (variant);
2561 if (variant == NULL)
2563 variant = g_variant_ref (binding->info.default_value);
2564 if (!binding->get_mapping (&value, variant, binding->user_data))
2565 g_error ("The schema default value for key `%s' in schema `%s' "
2566 "was rejected by the binding mapping function.",
2568 binding->info.schema_name);
2571 g_object_set_property (binding->object, binding->property->name, &value);
2572 g_variant_unref (variant);
2573 g_value_unset (&value);
2575 binding->running = FALSE;
2579 g_settings_binding_property_changed (GObject *object,
2580 const GParamSpec *pspec,
2583 GSettingsBinding *binding = user_data;
2584 GValue value = G_VALUE_INIT;
2587 g_assert (object == binding->object);
2588 g_assert (pspec == binding->property);
2590 if (binding->running)
2593 binding->running = TRUE;
2595 g_value_init (&value, pspec->value_type);
2596 g_object_get_property (object, pspec->name, &value);
2597 if ((variant = binding->set_mapping (&value, binding->info.type,
2598 binding->user_data)))
2600 g_variant_take_ref (variant);
2602 if (!g_settings_type_check (&binding->info, variant))
2604 g_critical ("binding mapping function for key `%s' returned "
2605 "GVariant of type `%s' when type `%s' was requested",
2606 binding->info.key, g_variant_get_type_string (variant),
2607 g_variant_type_dup_string (binding->info.type));
2611 if (!g_settings_key_info_range_check (&binding->info, variant))
2613 g_critical ("GObject property `%s' on a `%s' object is out of "
2614 "schema-specified range for key `%s' of `%s': %s",
2615 binding->property->name,
2616 g_type_name (binding->property->owner_type),
2617 binding->info.key, binding->info.schema_name,
2618 g_variant_print (variant, TRUE));
2622 g_settings_write_to_backend (binding->settings, &binding->info, variant);
2623 g_variant_unref (variant);
2625 g_value_unset (&value);
2627 binding->running = FALSE;
2631 g_settings_bind_invert_boolean_get_mapping (GValue *value,
2635 g_value_set_boolean (value, !g_variant_get_boolean (variant));
2640 g_settings_bind_invert_boolean_set_mapping (const GValue *value,
2641 const GVariantType *expected_type,
2644 return g_variant_new_boolean (!g_value_get_boolean (value));
2649 * @settings: a #GSettings object
2650 * @key: the key to bind
2651 * @object: (type GObject.Object): a #GObject
2652 * @property: the name of the property to bind
2653 * @flags: flags for the binding
2655 * Create a binding between the @key in the @settings object
2656 * and the property @property of @object.
2658 * The binding uses the default GIO mapping functions to map
2659 * between the settings and property values. These functions
2660 * handle booleans, numeric types and string types in a
2661 * straightforward way. Use g_settings_bind_with_mapping() if
2662 * you need a custom mapping, or map between types that are not
2663 * supported by the default mapping functions.
2665 * Unless the @flags include %G_SETTINGS_BIND_NO_SENSITIVITY, this
2666 * function also establishes a binding between the writability of
2667 * @key and the "sensitive" property of @object (if @object has
2668 * a boolean property by that name). See g_settings_bind_writable()
2669 * for more details about writable bindings.
2671 * Note that the lifecycle of the binding is tied to the object,
2672 * and that you can have only one binding per object property.
2673 * If you bind the same property twice on the same object, the second
2674 * binding overrides the first one.
2679 g_settings_bind (GSettings *settings,
2682 const gchar *property,
2683 GSettingsBindFlags flags)
2685 GSettingsBindGetMapping get_mapping = NULL;
2686 GSettingsBindSetMapping set_mapping = NULL;
2688 if (flags & G_SETTINGS_BIND_INVERT_BOOLEAN)
2690 get_mapping = g_settings_bind_invert_boolean_get_mapping;
2691 set_mapping = g_settings_bind_invert_boolean_set_mapping;
2693 /* can't pass this flag to g_settings_bind_with_mapping() */
2694 flags &= ~G_SETTINGS_BIND_INVERT_BOOLEAN;
2697 g_settings_bind_with_mapping (settings, key, object, property, flags,
2698 get_mapping, set_mapping, NULL, NULL);
2702 * g_settings_bind_with_mapping: (skip)
2703 * @settings: a #GSettings object
2704 * @key: the key to bind
2705 * @object: (type GObject.Object): a #GObject
2706 * @property: the name of the property to bind
2707 * @flags: flags for the binding
2708 * @get_mapping: a function that gets called to convert values
2709 * from @settings to @object, or %NULL to use the default GIO mapping
2710 * @set_mapping: a function that gets called to convert values
2711 * from @object to @settings, or %NULL to use the default GIO mapping
2712 * @user_data: data that gets passed to @get_mapping and @set_mapping
2713 * @destroy: #GDestroyNotify function for @user_data
2715 * Create a binding between the @key in the @settings object
2716 * and the property @property of @object.
2718 * The binding uses the provided mapping functions to map between
2719 * settings and property values.
2721 * Note that the lifecycle of the binding is tied to the object,
2722 * and that you can have only one binding per object property.
2723 * If you bind the same property twice on the same object, the second
2724 * binding overrides the first one.
2729 g_settings_bind_with_mapping (GSettings *settings,
2732 const gchar *property,
2733 GSettingsBindFlags flags,
2734 GSettingsBindGetMapping get_mapping,
2735 GSettingsBindSetMapping set_mapping,
2737 GDestroyNotify destroy)
2739 GSettingsBinding *binding;
2740 GObjectClass *objectclass;
2741 gchar *detailed_signal;
2742 GQuark binding_quark;
2744 g_return_if_fail (G_IS_SETTINGS (settings));
2745 g_return_if_fail (key != NULL);
2746 g_return_if_fail (G_IS_OBJECT (object));
2747 g_return_if_fail (property != NULL);
2748 g_return_if_fail (~flags & G_SETTINGS_BIND_INVERT_BOOLEAN);
2750 objectclass = G_OBJECT_GET_CLASS (object);
2752 binding = g_slice_new0 (GSettingsBinding);
2753 g_settings_get_key_info (&binding->info, settings, key);
2754 binding->settings = g_object_ref (settings);
2755 binding->object = object;
2756 binding->property = g_object_class_find_property (objectclass, property);
2757 binding->user_data = user_data;
2758 binding->destroy = destroy;
2759 binding->get_mapping = get_mapping ? get_mapping : g_settings_get_mapping;
2760 binding->set_mapping = set_mapping ? set_mapping : g_settings_set_mapping;
2762 if (!(flags & (G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET)))
2763 flags |= G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET;
2765 if (binding->property == NULL)
2767 g_critical ("g_settings_bind: no property '%s' on class '%s'",
2768 property, G_OBJECT_TYPE_NAME (object));
2772 if ((flags & G_SETTINGS_BIND_GET) &&
2773 (binding->property->flags & G_PARAM_WRITABLE) == 0)
2775 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2776 "writable", property, G_OBJECT_TYPE_NAME (object));
2779 if ((flags & G_SETTINGS_BIND_SET) &&
2780 (binding->property->flags & G_PARAM_READABLE) == 0)
2782 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2783 "readable", property, G_OBJECT_TYPE_NAME (object));
2787 if (get_mapping == g_settings_bind_invert_boolean_get_mapping)
2789 /* g_settings_bind_invert_boolean_get_mapping() is a private
2790 * function, so if we are here it means that g_settings_bind() was
2791 * called with G_SETTINGS_BIND_INVERT_BOOLEAN.
2793 * Ensure that both sides are boolean.
2796 if (binding->property->value_type != G_TYPE_BOOLEAN)
2798 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2799 "was specified, but property `%s' on type `%s' has "
2800 "type `%s'", property, G_OBJECT_TYPE_NAME (object),
2801 g_type_name ((binding->property->value_type)));
2805 if (!g_variant_type_equal (binding->info.type, G_VARIANT_TYPE_BOOLEAN))
2807 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2808 "was specified, but key `%s' on schema `%s' has "
2809 "type `%s'", key, settings->priv->schema_name,
2810 g_variant_type_dup_string (binding->info.type));
2816 else if (((get_mapping == NULL && (flags & G_SETTINGS_BIND_GET)) ||
2817 (set_mapping == NULL && (flags & G_SETTINGS_BIND_SET))) &&
2818 !g_settings_mapping_is_compatible (binding->property->value_type,
2819 binding->info.type))
2821 g_critical ("g_settings_bind: property '%s' on class '%s' has type "
2822 "'%s' which is not compatible with type '%s' of key '%s' "
2823 "on schema '%s'", property, G_OBJECT_TYPE_NAME (object),
2824 g_type_name (binding->property->value_type),
2825 g_variant_type_dup_string (binding->info.type), key,
2826 settings->priv->schema_name);
2830 if ((flags & G_SETTINGS_BIND_SET) &&
2831 (~flags & G_SETTINGS_BIND_NO_SENSITIVITY))
2833 GParamSpec *sensitive;
2835 sensitive = g_object_class_find_property (objectclass, "sensitive");
2837 if (sensitive && sensitive->value_type == G_TYPE_BOOLEAN &&
2838 (sensitive->flags & G_PARAM_WRITABLE))
2839 g_settings_bind_writable (settings, binding->info.key,
2840 object, "sensitive", FALSE);
2843 if (flags & G_SETTINGS_BIND_SET)
2845 detailed_signal = g_strdup_printf ("notify::%s", property);
2846 binding->property_handler_id =
2847 g_signal_connect (object, detailed_signal,
2848 G_CALLBACK (g_settings_binding_property_changed),
2850 g_free (detailed_signal);
2852 if (~flags & G_SETTINGS_BIND_GET)
2853 g_settings_binding_property_changed (object,
2858 if (flags & G_SETTINGS_BIND_GET)
2860 if (~flags & G_SETTINGS_BIND_GET_NO_CHANGES)
2862 detailed_signal = g_strdup_printf ("changed::%s", key);
2863 binding->key_handler_id =
2864 g_signal_connect (settings, detailed_signal,
2865 G_CALLBACK (g_settings_binding_key_changed),
2867 g_free (detailed_signal);
2870 g_settings_binding_key_changed (settings, binding->info.key, binding);
2873 binding_quark = g_settings_binding_quark (property);
2874 g_object_set_qdata_full (object, binding_quark,
2875 binding, g_settings_binding_free);
2878 /* Writability binding {{{1 */
2881 GSettings *settings;
2884 const gchar *property;
2887 } GSettingsWritableBinding;
2890 g_settings_writable_binding_free (gpointer data)
2892 GSettingsWritableBinding *binding = data;
2894 g_signal_handler_disconnect (binding->settings, binding->handler_id);
2895 g_object_unref (binding->settings);
2896 g_slice_free (GSettingsWritableBinding, binding);
2900 g_settings_binding_writable_changed (GSettings *settings,
2904 GSettingsWritableBinding *binding = user_data;
2907 g_assert (settings == binding->settings);
2908 g_assert (key == binding->key);
2910 writable = g_settings_is_writable (settings, key);
2912 if (binding->inverted)
2913 writable = !writable;
2915 g_object_set (binding->object, binding->property, writable, NULL);
2919 * g_settings_bind_writable:
2920 * @settings: a #GSettings object
2921 * @key: the key to bind
2922 * @object: (type GObject.Object):a #GObject
2923 * @property: the name of a boolean property to bind
2924 * @inverted: whether to 'invert' the value
2926 * Create a binding between the writability of @key in the
2927 * @settings object and the property @property of @object.
2928 * The property must be boolean; "sensitive" or "visible"
2929 * properties of widgets are the most likely candidates.
2931 * Writable bindings are always uni-directional; changes of the
2932 * writability of the setting will be propagated to the object
2933 * property, not the other way.
2935 * When the @inverted argument is %TRUE, the binding inverts the
2936 * value as it passes from the setting to the object, i.e. @property
2937 * will be set to %TRUE if the key is <emphasis>not</emphasis>
2940 * Note that the lifecycle of the binding is tied to the object,
2941 * and that you can have only one binding per object property.
2942 * If you bind the same property twice on the same object, the second
2943 * binding overrides the first one.
2948 g_settings_bind_writable (GSettings *settings,
2951 const gchar *property,
2954 GSettingsWritableBinding *binding;
2955 gchar *detailed_signal;
2958 g_return_if_fail (G_IS_SETTINGS (settings));
2960 pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
2963 g_critical ("g_settings_bind_writable: no property '%s' on class '%s'",
2964 property, G_OBJECT_TYPE_NAME (object));
2967 if ((pspec->flags & G_PARAM_WRITABLE) == 0)
2969 g_critical ("g_settings_bind_writable: property '%s' on class '%s' is not writable",
2970 property, G_OBJECT_TYPE_NAME (object));
2974 binding = g_slice_new (GSettingsWritableBinding);
2975 binding->settings = g_object_ref (settings);
2976 binding->object = object;
2977 binding->key = g_intern_string (key);
2978 binding->property = g_intern_string (property);
2979 binding->inverted = inverted;
2981 detailed_signal = g_strdup_printf ("writable-changed::%s", key);
2982 binding->handler_id =
2983 g_signal_connect (settings, detailed_signal,
2984 G_CALLBACK (g_settings_binding_writable_changed),
2986 g_free (detailed_signal);
2988 g_object_set_qdata_full (object, g_settings_binding_quark (property),
2989 binding, g_settings_writable_binding_free);
2991 g_settings_binding_writable_changed (settings, binding->key, binding);
2995 * g_settings_unbind:
2996 * @object: the object
2997 * @property: the property whose binding is removed
2999 * Removes an existing binding for @property on @object.
3001 * Note that bindings are automatically removed when the
3002 * object is finalized, so it is rarely necessary to call this
3008 g_settings_unbind (gpointer object,
3009 const gchar *property)
3011 GQuark binding_quark;
3013 binding_quark = g_settings_binding_quark (property);
3014 g_object_set_qdata (object, binding_quark, NULL);
3019 /* vim:set foldmethod=marker: */