2 * Copyright © 2009, 2010 Codethink Limited
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the licence, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Author: Ryan Lortie <desrt@desrt.ca>
30 #include "gsettings.h"
32 #include "gdelayedsettingsbackend.h"
33 #include "gsettingsbackendinternal.h"
34 #include "gsettings-mapping.h"
35 #include "gio-marshal.h"
36 #include "gsettingsschema.h"
46 * @short_description: a high-level API for application settings
48 * The #GSettings class provides a convenient API for storing and retrieving
49 * application settings.
51 * When creating a GSettings instance, you have to specify a schema
52 * that describes the keys in your settings and their types and default
53 * values, as well as some other information.
55 * Normally, a schema has as fixed path that determines where the settings
56 * are stored in the conceptual global tree of settings. However, schemas
57 * can also be 'relocatable', i.e. not equipped with a fixed path. This is
58 * useful e.g. when the schema describes an 'account', and you want to be
59 * able to store a arbitrary number of accounts.
61 * Unlike other configuration systems (like GConf), GSettings does not
62 * restrict keys to basic types like strings and numbers. GSettings stores
63 * values as #GVariant, and allows any #GVariantType for keys. Key names
64 * are restricted to lowercase characters, numbers and '-'. Furthermore,
65 * the names must begin with a lowercase character, must not end
66 * with a '-', and must not contain consecutive dashes. Key names can
67 * be up to 32 characters long.
69 * Similar to GConf, the default values in GSettings schemas can be
70 * localized, but the localized values are stored in gettext catalogs
71 * and looked up with the domain that is specified in the
72 * <tag class="attribute">gettext-domain</tag> attribute of the
73 * <tag class="starttag">schemalist</tag> or <tag class="starttag">schema</tag>
74 * elements and the category that is specified in the l10n attribute of the
75 * <tag class="starttag">key</tag> element.
77 * GSettings uses schemas in a compact binary form that is created
78 * by the <link linkend="glib-compile-schemas">glib-compile-schemas</link>
79 * utility. The input is a schema description in an XML format that can be
80 * described by the following DTD:
82 * <!ELEMENT schemalist (schema|enum)* >
83 * <!ATTLIST schemalist gettext-domain #IMPLIED >
85 * <!ELEMENT schema (key|child)* >
86 * <!ATTLIST schema id CDATA #REQUIRED
88 * gettext-domain CDATA #IMPLIED >
90 * <!-- defines an enumerated type -->
91 * <!-- each value element maps a nick to a numeric value -->
92 * <!ELEMENT enum (value*) >
93 * <!ATTLIST enum id CDATA #REQUIRED >
94 * <!ELEMENT value EMPTY >
95 * <!-- nick must be at least 2 characters long -->
96 * <!-- value must be parsable as a 32-bit integer -->
97 * <!ELEMENT value nick #REQUIRED
100 * <!ELEMENT key (default|summary?|description?|range?|choices?|aliases?) >
101 * <!-- name can only contain lowercase letters, numbers and '-' -->
102 * <!-- type must be a GVariant type string -->
103 * <!-- enum must be the id of an enum that has been defined earlier -->
104 * <!-- exactly one of enum or type must be given -->
105 * <!ATTLIST key name CDATA #REQUIRED
106 * type CDATA #IMPLIED
107 * enum CDATA #IMPLIED >
109 * <!-- the default value is specified a a serialized GVariant,
110 * i.e. you have to include the quotes when specifying a string -->
111 * <!ELEMENT default (#PCDATA) >
112 * <!-- the presence of the l10n attribute marks a default value for
113 * translation, its value is the gettext category to use -->
114 * <!-- if context is present, it specifies msgctxt to use -->
115 * <!ATTLIST default l10n (messages|time) #IMPLIED
116 * context CDATA #IMPLIED >
118 * <!ELEMENT summary (#PCDATA) >
119 * <!ELEMENT description (#PCDATA) >
121 * <!-- range is only allowed for keys with numeric type -->
122 * <!ELEMENT range EMPTY >
123 * <!-- min and max must be parseable as values of the key type and min < max -->
124 * <!ATTLIST range min CDATA #REQUIRED
125 * max CDATA #REQUIRED >
127 * <!-- choices is only allowed for keys with string or string array type -->
128 * <!ELEMENT choices (choice+) >
129 * <!-- each choice element specifies one possible value -->
130 * <!ELEMENT choice EMPTY >
131 * <!ATTLIST choice value CDATA #REQUIRED >
133 * <!-- aliases is only allowed for keys with enumerated type or with choices -->
134 * <!ELEMENT aliases (alias+) >
135 * <!-- each alias element specifies an alias for one of the possible values -->
136 * <!ELEMENT alias EMPTY >
137 * <!ATTLIST alias value CDATA #REQUIRED
138 * target CDATA #REQUIRED >
140 * <!ELEMENT child EMPTY >
141 * <!ATTLIST child name CDATA #REQUIRED
142 * schema CDATA #REQUIRED >
146 * At runtime, schemas are identified by their id (as specified
147 * in the <tag class="attribute">id</tag> attribute of the
148 * <tag class="starttag">schema</tag> element). The
149 * convention for schema ids is to use a dotted name, similar in
150 * style to a DBus bus name, e.g. "org.gnome.font-rendering".
152 * <example><title>Default values</title>
153 * <programlisting><![CDATA[
155 * <schema id="org.gtk.test" path="/tests/" gettext-domain="test">
157 * <key name="greeting" type="s">
158 * <default l10n="messages">"Hello, earthlings"</default>
159 * <summary>A greeting</summary>
161 * Greeting of the invading martians
165 * <key name="box" type="(ii)">
166 * <default>(20,30)</default>
171 * ]]></programlisting></example>
173 * <example><title>Ranges, choices and enumerated types</title>
174 * <programlisting><![CDATA[
178 * <value nick="first" value="1"/>
179 * <value nick="second" value="2"/>
182 * <schema id="org.gtk.test">
184 * <key name="key-with-range" type="i">
185 * <range min="1" max="100"/>
186 * <default>10</default>
189 * <key name="key-with-choices" type="s">
191 * <choice value='Elisabeth'/>
192 * <choice value='Annabeth'/>
193 * <choice value='Joe'/>
196 * <alias value='Anna' target='Annabeth'/>
197 * <alias value='Beth' target='Elisabeth'/>
199 * <default>'Joe'</default>
202 * <key name='enumerated-key' enum='myenum'>
203 * <default>'first'</default>
208 * ]]></programlisting></example>
211 * <title>Binding</title>
213 * A very convenient feature of GSettings lets you bind #GObject properties
214 * directly to settings, using g_settings_bind(). Once a GObject property
215 * has been bound to a setting, changes on either side are automatically
216 * propagated to the other side. GSettings handles details like
217 * mapping between GObject and GVariant types, and preventing infinite
221 * This makes it very easy to hook up a preferences dialog to the
222 * underlying settings. To make this even more convenient, GSettings
223 * looks for a boolean property with the name "sensitivity" and
224 * automatically binds it to the writability of the bound setting.
225 * If this 'magic' gets in the way, it can be suppressed with the
226 * #G_SETTINGS_BIND_NO_SENSITIVITY flag.
231 struct _GSettingsPrivate
233 /* where the signals go... */
234 GMainContext *main_context;
236 GSettingsBackend *backend;
237 GSettingsSchema *schema;
241 GDelayedSettingsBackend *delayed;
255 SIGNAL_WRITABLE_CHANGE_EVENT,
256 SIGNAL_WRITABLE_CHANGED,
262 static guint g_settings_signals[N_SIGNALS];
264 G_DEFINE_TYPE (GSettings, g_settings, G_TYPE_OBJECT)
268 g_settings_real_change_event (GSettings *settings,
275 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
277 for (i = 0; i < n_keys; i++)
278 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGED],
279 keys[i], g_quark_to_string (keys[i]));
285 g_settings_real_writable_change_event (GSettings *settings,
288 const GQuark *keys = &key;
293 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
295 for (i = 0; i < n_keys; i++)
297 const gchar *string = g_quark_to_string (keys[i]);
299 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGED],
301 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGED],
309 settings_backend_changed (GSettingsBackend *backend,
314 GSettings *settings = G_SETTINGS (target);
315 gboolean ignore_this;
318 g_assert (settings->priv->backend == backend);
320 for (i = 0; key[i] == settings->priv->path[i]; i++);
322 if (settings->priv->path[i] == '\0' &&
323 g_settings_schema_has_key (settings->priv->schema, key + i))
327 quark = g_quark_from_string (key + i);
328 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
329 0, &quark, 1, &ignore_this);
334 settings_backend_path_changed (GSettingsBackend *backend,
339 GSettings *settings = G_SETTINGS (target);
340 gboolean ignore_this;
342 g_assert (settings->priv->backend == backend);
344 if (g_str_has_prefix (settings->priv->path, path))
345 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
346 0, NULL, 0, &ignore_this);
350 settings_backend_keys_changed (GSettingsBackend *backend,
353 const gchar * const *items,
356 GSettings *settings = G_SETTINGS (target);
357 gboolean ignore_this;
360 g_assert (settings->priv->backend == backend);
362 for (i = 0; settings->priv->path[i] &&
363 settings->priv->path[i] == path[i]; i++);
370 for (j = 0; items[j]; j++)
372 const gchar *item = items[j];
375 for (k = 0; item[k] == settings->priv->path[i + k]; k++);
377 if (settings->priv->path[i + k] == '\0' &&
378 g_settings_schema_has_key (settings->priv->schema, item + k))
379 quarks[l++] = g_quark_from_string (item + k);
381 /* "256 quarks ought to be enough for anybody!"
382 * If this bites you, I'm sorry. Please file a bug.
388 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
389 0, quarks, l, &ignore_this);
394 settings_backend_writable_changed (GSettingsBackend *backend,
398 GSettings *settings = G_SETTINGS (target);
399 gboolean ignore_this;
402 g_assert (settings->priv->backend == backend);
404 for (i = 0; key[i] == settings->priv->path[i]; i++);
406 if (settings->priv->path[i] == '\0' &&
407 g_settings_schema_has_key (settings->priv->schema, key + i))
408 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
409 0, g_quark_from_string (key + i), &ignore_this);
413 settings_backend_path_writable_changed (GSettingsBackend *backend,
417 GSettings *settings = G_SETTINGS (target);
418 gboolean ignore_this;
420 g_assert (settings->priv->backend == backend);
422 if (g_str_has_prefix (settings->priv->path, path))
423 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
424 0, (GQuark) 0, &ignore_this);
427 /* Properties, Construction, Destruction {{{1 */
429 g_settings_set_property (GObject *object,
434 GSettings *settings = G_SETTINGS (object);
439 g_assert (settings->priv->schema_name == NULL);
440 settings->priv->schema_name = g_value_dup_string (value);
444 settings->priv->path = g_value_dup_string (value);
448 settings->priv->backend = g_value_dup_object (value);
452 g_assert_not_reached ();
457 g_settings_get_property (GObject *object,
462 GSettings *settings = G_SETTINGS (object);
467 g_value_set_object (value, settings->priv->schema);
470 case PROP_HAS_UNAPPLIED:
471 g_value_set_boolean (value, g_settings_get_has_unapplied (settings));
475 g_assert_not_reached ();
480 g_settings_constructed (GObject *object)
482 GSettings *settings = G_SETTINGS (object);
483 const gchar *schema_path;
485 settings->priv->schema = g_settings_schema_new (settings->priv->schema_name);
486 schema_path = g_settings_schema_get_path (settings->priv->schema);
488 if (settings->priv->path && schema_path && strcmp (settings->priv->path, schema_path) != 0)
489 g_error ("settings object created with schema '%s' and path '%s', but "
490 "path '%s' is specified by schema",
491 settings->priv->schema_name, settings->priv->path, schema_path);
493 if (settings->priv->path == NULL)
495 if (schema_path == NULL)
496 g_error ("attempting to create schema '%s' without a path",
497 settings->priv->schema_name);
499 settings->priv->path = g_strdup (schema_path);
502 if (settings->priv->backend == NULL)
503 settings->priv->backend = g_settings_backend_get_default ();
505 g_settings_backend_watch (settings->priv->backend, G_OBJECT (settings),
506 settings->priv->main_context,
507 settings_backend_changed,
508 settings_backend_path_changed,
509 settings_backend_keys_changed,
510 settings_backend_writable_changed,
511 settings_backend_path_writable_changed);
512 g_settings_backend_subscribe (settings->priv->backend,
513 settings->priv->path);
517 g_settings_finalize (GObject *object)
519 GSettings *settings = G_SETTINGS (object);
521 g_settings_backend_unsubscribe (settings->priv->backend,
522 settings->priv->path);
523 g_main_context_unref (settings->priv->main_context);
524 g_object_unref (settings->priv->backend);
525 g_object_unref (settings->priv->schema);
526 g_free (settings->priv->schema_name);
527 g_free (settings->priv->path);
531 g_settings_init (GSettings *settings)
533 settings->priv = G_TYPE_INSTANCE_GET_PRIVATE (settings,
537 settings->priv->main_context = g_main_context_get_thread_default ();
539 if (settings->priv->main_context == NULL)
540 settings->priv->main_context = g_main_context_default ();
542 g_main_context_ref (settings->priv->main_context);
546 g_settings_class_init (GSettingsClass *class)
548 GObjectClass *object_class = G_OBJECT_CLASS (class);
550 class->writable_change_event = g_settings_real_writable_change_event;
551 class->change_event = g_settings_real_change_event;
553 object_class->set_property = g_settings_set_property;
554 object_class->get_property = g_settings_get_property;
555 object_class->constructed = g_settings_constructed;
556 object_class->finalize = g_settings_finalize;
558 g_type_class_add_private (object_class, sizeof (GSettingsPrivate));
561 * GSettings::changed:
562 * @settings: the object on which the signal was emitted
563 * @key: the name of the key that changed
565 * The "changed" signal is emitted when a key has potentially changed.
566 * You should call one of the g_settings_get() calls to check the new
569 * This signal supports detailed connections. You can connect to the
570 * detailed signal "changed::x" in order to only receive callbacks
571 * when key "x" changes.
573 g_settings_signals[SIGNAL_CHANGED] =
574 g_signal_new ("changed", G_TYPE_SETTINGS,
575 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
576 G_STRUCT_OFFSET (GSettingsClass, changed),
577 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
578 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
581 * GSettings::change-event:
582 * @settings: the object on which the signal was emitted
583 * @keys: an array of #GQuark<!-- -->s for the changed keys, or %NULL
584 * @n_keys: the length of the @keys array, or 0
585 * @returns: %TRUE to stop other handlers from being invoked for the
586 * event. FALSE to propagate the event further.
588 * The "change-event" signal is emitted once per change event that
589 * affects this settings object. You should connect to this signal
590 * only if you are interested in viewing groups of changes before they
591 * are split out into multiple emissions of the "changed" signal.
592 * For most use cases it is more appropriate to use the "changed" signal.
594 * In the event that the change event applies to one or more specified
595 * keys, @keys will be an array of #GQuark of length @n_keys. In the
596 * event that the change event applies to the #GSettings object as a
597 * whole (ie: potentially every key has been changed) then @keys will
598 * be %NULL and @n_keys will be 0.
600 * The default handler for this signal invokes the "changed" signal
601 * for each affected key. If any other connected handler returns
602 * %TRUE then this default functionality will be supressed.
604 g_settings_signals[SIGNAL_CHANGE_EVENT] =
605 g_signal_new ("change-event", G_TYPE_SETTINGS,
607 G_STRUCT_OFFSET (GSettingsClass, change_event),
608 g_signal_accumulator_true_handled, NULL,
609 _gio_marshal_BOOL__POINTER_INT,
610 G_TYPE_BOOLEAN, 2, G_TYPE_POINTER, G_TYPE_INT);
613 * GSettings::writable-changed:
614 * @settings: the object on which the signal was emitted
617 * The "writable-changed" signal is emitted when the writability of a
618 * key has potentially changed. You should call
619 * g_settings_is_writable() in order to determine the new status.
621 * This signal supports detailed connections. You can connect to the
622 * detailed signal "writable-changed::x" in order to only receive
623 * callbacks when the writability of "x" changes.
625 g_settings_signals[SIGNAL_WRITABLE_CHANGED] =
626 g_signal_new ("writable-changed", G_TYPE_SETTINGS,
627 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
628 G_STRUCT_OFFSET (GSettingsClass, changed),
629 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
630 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
633 * GSettings::writable-change-event:
634 * @settings: the object on which the signal was emitted
635 * @key: the quark of the key, or 0
636 * @returns: %TRUE to stop other handlers from being invoked for the
637 * event. FALSE to propagate the event further.
639 * The "writable-change-event" signal is emitted once per writability
640 * change event that affects this settings object. You should connect
641 * to this signal if you are interested in viewing groups of changes
642 * before they are split out into multiple emissions of the
643 * "writable-changed" signal. For most use cases it is more
644 * appropriate to use the "writable-changed" signal.
646 * In the event that the writability change applies only to a single
647 * key, @key will be set to the #GQuark for that key. In the event
648 * that the writability change affects the entire settings object,
651 * The default handler for this signal invokes the "writable-changed"
652 * and "changed" signals for each affected key. This is done because
653 * changes in writability might also imply changes in value (if for
654 * example, a new mandatory setting is introduced). If any other
655 * connected handler returns %TRUE then this default functionality
658 g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT] =
659 g_signal_new ("writable-change-event", G_TYPE_SETTINGS,
661 G_STRUCT_OFFSET (GSettingsClass, writable_change_event),
662 g_signal_accumulator_true_handled, NULL,
663 _gio_marshal_BOOLEAN__UINT, G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
668 * The name of the context that the settings are stored in.
670 g_object_class_install_property (object_class, PROP_BACKEND,
671 g_param_spec_object ("backend",
672 P_("GSettingsBackend"),
673 P_("The GSettingsBackend for this settings object"),
674 G_TYPE_SETTINGS_BACKEND, G_PARAM_CONSTRUCT_ONLY |
675 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
680 * The name of the schema that describes the types of keys
681 * for this #GSettings object.
683 g_object_class_install_property (object_class, PROP_SCHEMA,
684 g_param_spec_string ("schema",
686 P_("The name of the schema for this settings object"),
688 G_PARAM_CONSTRUCT_ONLY |
689 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
694 * The path within the backend where the settings are stored.
696 g_object_class_install_property (object_class, PROP_PATH,
697 g_param_spec_string ("path",
699 P_("The path within the backend where the settings are"),
701 G_PARAM_CONSTRUCT_ONLY |
702 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
705 * GSettings:has-unapplied:
707 * If this property is %TRUE, the #GSettings object has outstanding
708 * changes that will be applied when g_settings_apply() is called.
710 g_object_class_install_property (object_class, PROP_HAS_UNAPPLIED,
711 g_param_spec_boolean ("has-unapplied",
712 P_("Has unapplied changes"),
713 P_("TRUE if there are outstanding changes to apply()"),
715 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
719 /* Construction (new, new_with_path, etc.) {{{1 */
722 * @schema: the name of the schema
723 * @returns: a new #GSettings object
725 * Creates a new #GSettings object with a given schema.
727 * Signals on the newly created #GSettings object will be dispatched
728 * via the thread-default #GMainContext in effect at the time of the
729 * call to g_settings_new(). The new #GSettings will hold a reference
730 * on the context. See g_main_context_push_thread_default().
735 g_settings_new (const gchar *schema)
737 g_return_val_if_fail (schema != NULL, NULL);
739 return g_object_new (G_TYPE_SETTINGS,
745 * g_settings_new_with_path:
746 * @schema: the name of the schema
747 * @path: the path to use
748 * @returns: a new #GSettings object
750 * Creates a new #GSettings object with a given schema and path.
752 * You only need to do this if you want to directly create a settings
753 * object with a schema that doesn't have a specified path of its own.
756 * It is a programmer error to call this function for a schema that
757 * has an explicitly specified path.
762 g_settings_new_with_path (const gchar *schema,
765 g_return_val_if_fail (schema != NULL, NULL);
766 g_return_val_if_fail (path != NULL, NULL);
768 return g_object_new (G_TYPE_SETTINGS,
775 * g_settings_new_with_backend:
776 * @schema: the name of the schema
777 * @backend: the #GSettingsBackend to use
778 * @returns: a new #GSettings object
780 * Creates a new #GSettings object with a given schema and backend.
782 * Creating settings objects with an different backend allows accessing settings
783 * from a database other than the usual one. For example, it may make
784 * sense to pass a backend corresponding to the "defaults" settings database on
785 * the system to get a settings object that modifies the system default
786 * settings instead of the settings for this user.
791 g_settings_new_with_backend (const gchar *schema,
792 GSettingsBackend *backend)
794 g_return_val_if_fail (schema != NULL, NULL);
795 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
797 return g_object_new (G_TYPE_SETTINGS,
804 * g_settings_new_with_backend_and_path:
805 * @schema: the name of the schema
806 * @backend: the #GSettingsBackend to use
807 * @path: the path to use
808 * @returns: a new #GSettings object
810 * Creates a new #GSettings object with a given schema, backend and
813 * This is a mix of g_settings_new_with_backend() and
814 * g_settings_new_with_path().
819 g_settings_new_with_backend_and_path (const gchar *schema,
820 GSettingsBackend *backend,
823 g_return_val_if_fail (schema != NULL, NULL);
824 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
825 g_return_val_if_fail (path != NULL, NULL);
827 return g_object_new (G_TYPE_SETTINGS,
834 /* Internal read/write utilities, enum conversion, validation {{{1 */
840 GSettingsSchema *schema;
843 const guint32 *strinfo;
844 gsize strinfo_length;
846 const gchar *unparsed;
849 const GVariantType *type;
850 GVariant *minimum, *maximum;
851 GVariant *default_value;
855 g_settings_get_key_info (GSettingsKeyInfo *info,
863 memset (info, 0, sizeof *info);
865 iter = g_settings_schema_get_value (settings->priv->schema, key);
867 info->default_value = g_variant_iter_next_value (iter);
868 info->type = g_variant_get_type (info->default_value);
869 info->schema = settings->priv->schema;
870 info->settings = settings;
873 while (g_variant_iter_next (iter, "(y*)", &code, &data))
878 /* translation requested */
879 g_variant_get (data, "(y&s)", &info->lc_char, &info->unparsed);
883 /* enumerated types, ... */
884 info->is_enum = TRUE;
886 /* ..., choices, aliases */
887 info->strinfo = g_variant_get_fixed_array (data,
888 &info->strinfo_length,
893 g_variant_get (data, "(**)", &info->minimum, &info->maximum);
897 g_warning ("unknown schema extension '%c'", code);
901 g_variant_unref (data);
904 g_variant_iter_free (iter);
908 g_settings_free_key_info (GSettingsKeyInfo *info)
911 g_variant_unref (info->minimum);
914 g_variant_unref (info->maximum);
916 g_variant_unref (info->default_value);
920 g_settings_write_to_backend (GSettingsKeyInfo *info,
926 path = g_strconcat (info->settings->priv->path, info->key, NULL);
927 success = g_settings_backend_write (info->settings->priv->backend,
935 g_settings_type_check (GSettingsKeyInfo *info,
938 g_return_val_if_fail (value != NULL, FALSE);
940 return g_variant_is_of_type (value, info->type);
944 g_settings_range_check (GSettingsKeyInfo *info,
947 if (info->minimum == NULL && info->strinfo == NULL)
950 if (g_variant_is_container (value))
956 g_variant_iter_init (&iter, value);
957 while (ok && (child = g_variant_iter_next_value (&iter)))
959 ok = g_settings_range_check (info, value);
960 g_variant_unref (child);
968 return g_variant_compare (info->minimum, value) <= 0 &&
969 g_variant_compare (value, info->maximum) <= 0;
972 return strinfo_is_string_valid (info->strinfo,
973 info->strinfo_length,
974 g_variant_get_string (value, NULL));
978 g_settings_range_fixup (GSettingsKeyInfo *info,
983 if (g_settings_range_check (info, value))
984 return g_variant_ref (value);
986 if (info->strinfo == NULL)
989 if (g_variant_is_container (value))
991 GVariantBuilder builder;
995 g_variant_builder_init (&builder, g_variant_get_type (value));
997 while ((child = g_variant_iter_next_value (&iter)))
1001 fixed = g_settings_range_fixup (info, child);
1002 g_variant_unref (child);
1006 g_variant_builder_clear (&builder);
1010 g_variant_builder_add_value (&builder, fixed);
1011 g_variant_unref (fixed);
1014 return g_variant_ref_sink (g_variant_builder_end (&builder));
1017 target = strinfo_string_from_alias (info->strinfo, info->strinfo_length,
1018 g_variant_get_string (value, NULL));
1019 return target ? g_variant_ref_sink (g_variant_new_string (target)) : NULL;
1023 g_settings_read_from_backend (GSettingsKeyInfo *info)
1029 path = g_strconcat (info->settings->priv->path, info->key, NULL);
1030 value = g_settings_backend_read (info->settings->priv->backend,
1031 path, info->type, FALSE);
1036 fixup = g_settings_range_fixup (info, value);
1037 g_variant_unref (value);
1046 g_settings_get_translated_default (GSettingsKeyInfo *info)
1048 const gchar *translated;
1049 GError *error = NULL;
1050 const gchar *domain;
1053 if (info->lc_char == '\0')
1054 /* translation not requested for this key */
1057 domain = g_settings_schema_get_gettext_domain (info->schema);
1059 if (info->lc_char == 't')
1060 translated = g_dcgettext (domain, info->unparsed, LC_TIME);
1062 translated = g_dgettext (domain, info->unparsed);
1064 if (translated == info->unparsed)
1065 /* the default value was not translated */
1068 /* try to parse the translation of the unparsed default */
1069 value = g_variant_parse (info->type, translated, NULL, NULL, &error);
1073 g_warning ("Failed to parse translated string `%s' for "
1074 "key `%s' in schema `%s': %s", info->unparsed, info->key,
1075 info->settings->priv->schema_name, error->message);
1076 g_warning ("Using untranslated default instead.");
1077 g_error_free (error);
1080 else if (!g_settings_range_check (info, value))
1082 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
1083 "is outside of valid range", info->unparsed, info->key,
1084 info->settings->priv->schema_name);
1085 g_variant_unref (value);
1093 g_settings_to_enum (GSettingsKeyInfo *info,
1099 it_worked = strinfo_enum_from_string (info->strinfo, info->strinfo_length,
1100 g_variant_get_string (value, NULL),
1103 /* 'value' can only come from the backend after being filtered for validity,
1104 * from the translation after being filtered for validity, or from the schema
1105 * itself (which the schema compiler checks for validity). If this assertion
1106 * fails then it's really a bug in GSettings or the schema compiler...
1108 g_assert (it_worked);
1114 g_settings_from_enum (GSettingsKeyInfo *info,
1117 const gchar *string;
1119 string = strinfo_string_from_enum (info->strinfo,
1120 info->strinfo_length,
1126 return g_variant_ref_sink (g_variant_new_string (string));
1129 /* Public Get/Set API {{{1 (get, get_value, set, set_value) */
1131 * g_settings_get_value:
1132 * @settings: a #GSettings object
1133 * @key: the key to get the value for
1134 * @returns: a new #GVariant
1136 * Gets the value that is stored in @settings for @key.
1138 * It is a programmer error to give a @key that isn't valid for
1144 g_settings_get_value (GSettings *settings,
1147 GSettingsKeyInfo info;
1150 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1151 g_return_val_if_fail (key != NULL, NULL);
1153 g_settings_get_key_info (&info, settings, key);
1154 value = g_settings_read_from_backend (&info);
1157 value = g_settings_get_translated_default (&info);
1160 value = g_variant_ref (info.default_value);
1162 g_settings_free_key_info (&info);
1168 * g_settings_get_enum:
1169 * @settings: a #GSettings object
1170 * @key: the key to get the value for
1171 * @returns: the enum value
1173 * Gets the value that is stored in @settings for @key and converts it
1174 * to the enum value that it represents.
1176 * In order to use this function the type of the value must be a string
1177 * and it must be marked in the schema file as an enumerated type.
1179 * It is a programmer error to give a @key that isn't valid for
1180 * @settings, or is not marked as an enumerated type in the schema.
1182 * If the value stored in the configuration database is not a valid
1183 * value for the enumerated type then this function will return the
1189 g_settings_get_enum (GSettings *settings,
1192 GSettingsKeyInfo info;
1196 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1197 g_return_val_if_fail (key != NULL, -1);
1199 g_settings_get_key_info (&info, settings, key);
1203 g_critical ("g_settings_get_enum() called on key `%s' which is not "
1204 "associated with an enumerated type", info.key);
1205 g_settings_free_key_info (&info);
1209 value = g_settings_read_from_backend (&info);
1212 value = g_settings_get_translated_default (&info);
1215 value = g_variant_ref (info.default_value);
1217 result = g_settings_to_enum (&info, value);
1218 g_settings_free_key_info (&info);
1219 g_variant_unref (value);
1225 * g_settings_set_enum:
1226 * @settings: a #GSettings object
1227 * @key: a key, within @settings
1228 * @value: an enumerated value
1229 * @returns: %TRUE, if the set succeeds
1231 * Looks up the enumerated type nick for @value and writes it to @key,
1234 * It is a programmer error for @key to not be listed in the schema or
1235 * for it not to be tagged as an enumerated type, or for @value not to
1236 * be a valid value for the named type.
1238 * After performing the write, accessing @key directly
1239 * g_settings_get_string() will return the 'nick' associated with
1243 g_settings_set_enum (GSettings *settings,
1247 GSettingsKeyInfo info;
1251 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1252 g_return_val_if_fail (key != NULL, FALSE);
1254 g_settings_get_key_info (&info, settings, key);
1258 g_critical ("g_settings_set_enum() called on key `%s' which is not "
1259 "associated with an enumerated type", info.key);
1263 if (!(variant = g_settings_from_enum (&info, value)))
1265 g_critical ("g_settings_set_enum(): invalid enum value %d for key `%s' "
1266 "in schema `%s'. Doing nothing.", value, info.key,
1267 info.settings->priv->schema_name);
1268 g_settings_free_key_info (&info);
1272 success = g_settings_write_to_backend (&info, variant);
1273 g_settings_free_key_info (&info);
1274 g_variant_unref (variant);
1280 * g_settings_set_value:
1281 * @settings: a #GSettings object
1282 * @key: the name of the key to set
1283 * @value: a #GVariant of the correct type
1284 * @returns: %TRUE if setting the key succeeded,
1285 * %FALSE if the key was not writable
1287 * Sets @key in @settings to @value.
1289 * It is a programmer error to give a @key that isn't valid for
1290 * @settings. It is a programmer error to give a @value of the
1293 * If @value is floating then this function consumes the reference.
1298 g_settings_set_value (GSettings *settings,
1302 GSettingsKeyInfo info;
1304 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1305 g_return_val_if_fail (key != NULL, FALSE);
1307 g_settings_get_key_info (&info, settings, key);
1308 g_return_val_if_fail (g_settings_type_check (&info, value), FALSE);
1309 g_return_val_if_fail (g_settings_range_check (&info, value), FALSE);
1310 g_settings_free_key_info (&info);
1312 return g_settings_write_to_backend (&info, value);
1317 * @settings: a #GSettings object
1318 * @key: the key to get the value for
1319 * @format: a #GVariant format string
1320 * @...: arguments as per @format
1322 * Gets the value that is stored at @key in @settings.
1324 * A convenience function that combines g_settings_get_value() with
1327 * It is a programmer error to pass a @key that isn't valid for
1328 * @settings or a @format_string that doesn't match the type of @key according
1329 * to the schema of @settings.
1334 g_settings_get (GSettings *settings,
1336 const gchar *format,
1342 value = g_settings_get_value (settings, key);
1344 va_start (ap, format);
1345 g_variant_get_va (value, format, NULL, &ap);
1348 g_variant_unref (value);
1353 * @settings: a #GSettings object
1354 * @key: the name of the key to set
1355 * @format: a #GVariant format string
1356 * @...: arguments as per @format
1357 * @returns: %TRUE if setting the key succeeded,
1358 * %FALSE if the key was not writable
1360 * Sets @key in @settings to @value.
1362 * A convenience function that combines g_settings_set_value() with
1365 * It is a programmer error to pass a @key that isn't valid for
1366 * @settings or a @format that doesn't match the type of @key according
1367 * to the schema of @settings.
1372 g_settings_set (GSettings *settings,
1374 const gchar *format,
1380 va_start (ap, format);
1381 value = g_variant_new_va (format, NULL, &ap);
1384 return g_settings_set_value (settings, key, value);
1387 /* Convenience API (get, set_string, int, double, boolean, strv) {{{1 */
1389 * g_settings_get_string:
1390 * @settings: a #GSettings object
1391 * @key: the key to get the value for
1392 * @returns: a newly-allocated string
1394 * Gets the value that is stored at @key in @settings.
1396 * A convenience variant of g_settings_get() for strings.
1398 * It is a programmer error to pass a @key that isn't valid for
1399 * @settings or is not of type string.
1404 g_settings_get_string (GSettings *settings,
1410 value = g_settings_get_value (settings, key);
1411 result = g_variant_dup_string (value, NULL);
1412 g_variant_unref (value);
1418 * g_settings_set_string:
1419 * @settings: a #GSettings object
1420 * @key: the name of the key to set
1421 * @value: the value to set it to
1422 * @returns: %TRUE if setting the key succeeded,
1423 * %FALSE if the key was not writable
1425 * Sets @key in @settings to @value.
1427 * A convenience variant of g_settings_set() for strings.
1429 * It is a programmer error to pass a @key that isn't valid for
1430 * @settings or is not of type string.
1435 g_settings_set_string (GSettings *settings,
1439 return g_settings_set_value (settings, key, g_variant_new_string (value));
1443 * g_settings_get_int:
1444 * @settings: a #GSettings object
1445 * @key: the key to get the value for
1446 * @returns: an integer
1448 * Gets the value that is stored at @key in @settings.
1450 * A convenience variant of g_settings_get() for 32-bit integers.
1452 * It is a programmer error to pass a @key that isn't valid for
1453 * @settings or is not of type int32.
1458 g_settings_get_int (GSettings *settings,
1464 value = g_settings_get_value (settings, key);
1465 result = g_variant_get_int32 (value);
1466 g_variant_unref (value);
1472 * g_settings_set_int:
1473 * @settings: a #GSettings object
1474 * @key: the name of the key to set
1475 * @value: the value to set it to
1476 * @returns: %TRUE if setting the key succeeded,
1477 * %FALSE if the key was not writable
1479 * Sets @key in @settings to @value.
1481 * A convenience variant of g_settings_set() for 32-bit integers.
1483 * It is a programmer error to pass a @key that isn't valid for
1484 * @settings or is not of type int32.
1489 g_settings_set_int (GSettings *settings,
1493 return g_settings_set_value (settings, key, g_variant_new_int32 (value));
1497 * g_settings_get_double:
1498 * @settings: a #GSettings object
1499 * @key: the key to get the value for
1500 * @returns: a double
1502 * Gets the value that is stored at @key in @settings.
1504 * A convenience variant of g_settings_get() for doubles.
1506 * It is a programmer error to pass a @key that isn't valid for
1507 * @settings or is not of type double.
1512 g_settings_get_double (GSettings *settings,
1518 value = g_settings_get_value (settings, key);
1519 result = g_variant_get_double (value);
1520 g_variant_unref (value);
1526 * g_settings_set_double:
1527 * @settings: a #GSettings object
1528 * @key: the name of the key to set
1529 * @value: the value to set it to
1530 * @returns: %TRUE if setting the key succeeded,
1531 * %FALSE if the key was not writable
1533 * Sets @key in @settings to @value.
1535 * A convenience variant of g_settings_set() for doubles.
1537 * It is a programmer error to pass a @key that isn't valid for
1538 * @settings or is not of type double.
1543 g_settings_set_double (GSettings *settings,
1547 return g_settings_set_value (settings, key, g_variant_new_double (value));
1551 * g_settings_get_boolean:
1552 * @settings: a #GSettings object
1553 * @key: the key to get the value for
1554 * @returns: a boolean
1556 * Gets the value that is stored at @key in @settings.
1558 * A convenience variant of g_settings_get() for booleans.
1560 * It is a programmer error to pass a @key that isn't valid for
1561 * @settings or is not of type boolean.
1566 g_settings_get_boolean (GSettings *settings,
1572 value = g_settings_get_value (settings, key);
1573 result = g_variant_get_boolean (value);
1574 g_variant_unref (value);
1580 * g_settings_set_boolean:
1581 * @settings: a #GSettings object
1582 * @key: the name of the key to set
1583 * @value: the value to set it to
1584 * @returns: %TRUE if setting the key succeeded,
1585 * %FALSE if the key was not writable
1587 * Sets @key in @settings to @value.
1589 * A convenience variant of g_settings_set() for booleans.
1591 * It is a programmer error to pass a @key that isn't valid for
1592 * @settings or is not of type boolean.
1597 g_settings_set_boolean (GSettings *settings,
1601 return g_settings_set_value (settings, key, g_variant_new_boolean (value));
1605 * g_settings_get_strv:
1606 * @settings: a #GSettings object
1607 * @key: the key to get the value for
1608 * @returns: a newly-allocated, %NULL-terminated array of strings
1610 * Gets the value that is stored at @key in @settings.
1612 * A convenience variant of g_settings_get() for string arrays.
1614 * It is a programmer error to pass a @key that isn't valid for
1615 * @settings or is not of type 'string array'.
1620 g_settings_get_strv (GSettings *settings,
1626 value = g_settings_get_value (settings, key);
1627 result = g_variant_dup_strv (value, NULL);
1628 g_variant_unref (value);
1634 * g_settings_set_strv:
1635 * @settings: a #GSettings object
1636 * @key: the name of the key to set
1637 * @value: (allow-none): the value to set it to, or %NULL
1638 * @returns: %TRUE if setting the key succeeded,
1639 * %FALSE if the key was not writable
1641 * Sets @key in @settings to @value.
1643 * A convenience variant of g_settings_set() for string arrays. If
1644 * @value is %NULL, then @key is set to be the empty array.
1646 * It is a programmer error to pass a @key that isn't valid for
1647 * @settings or is not of type 'string array'.
1652 g_settings_set_strv (GSettings *settings,
1654 const gchar * const *value)
1659 array = g_variant_new_strv (value, -1);
1661 array = g_variant_new_strv (NULL, 0);
1663 return g_settings_set_value (settings, key, array);
1665 /* Delayed apply (delay, apply, revert, get_has_unapplied) {{{1 */
1668 * @settings: a #GSettings object
1670 * Changes the #GSettings object into 'delay-apply' mode. In this
1671 * mode, changes to @settings are not immediately propagated to the
1672 * backend, but kept locally until g_settings_apply() is called.
1677 g_settings_delay (GSettings *settings)
1679 g_return_if_fail (G_IS_SETTINGS (settings));
1681 if (settings->priv->delayed)
1684 settings->priv->delayed =
1685 g_delayed_settings_backend_new (settings->priv->backend,
1687 settings->priv->main_context);
1688 g_settings_backend_unwatch (settings->priv->backend, G_OBJECT (settings));
1689 g_object_unref (settings->priv->backend);
1691 settings->priv->backend = G_SETTINGS_BACKEND (settings->priv->delayed);
1692 g_settings_backend_watch (settings->priv->backend, G_OBJECT (settings),
1693 settings->priv->main_context,
1694 settings_backend_changed,
1695 settings_backend_path_changed,
1696 settings_backend_keys_changed,
1697 settings_backend_writable_changed,
1698 settings_backend_path_writable_changed);
1703 * @settings: a #GSettings instance
1705 * Applies any changes that have been made to the settings. This
1706 * function does nothing unless @settings is in 'delay-apply' mode;
1707 * see g_settings_set_delay_apply(). In the normal case settings are
1708 * always applied immediately.
1711 g_settings_apply (GSettings *settings)
1713 if (settings->priv->delayed)
1715 GDelayedSettingsBackend *delayed;
1717 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
1718 g_delayed_settings_backend_apply (delayed);
1723 * g_settings_revert:
1724 * @settings: a #GSettings instance
1726 * Reverts all non-applied changes to the settings. This function
1727 * does nothing unless @settings is in 'delay-apply' mode; see
1728 * g_settings_set_delay_apply(). In the normal case settings are
1729 * always applied immediately.
1731 * Change notifications will be emitted for affected keys.
1734 g_settings_revert (GSettings *settings)
1736 if (settings->priv->delayed)
1738 GDelayedSettingsBackend *delayed;
1740 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
1741 g_delayed_settings_backend_revert (delayed);
1746 * g_settings_get_has_unapplied:
1747 * @settings: a #GSettings object
1748 * @returns: %TRUE if @settings has unapplied changes
1750 * Returns whether the #GSettings object has any unapplied
1751 * changes. This can only be the case if it is in 'delayed-apply' mode.
1756 g_settings_get_has_unapplied (GSettings *settings)
1758 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1760 return settings->priv->delayed &&
1761 g_delayed_settings_backend_get_has_unapplied (
1762 G_DELAYED_SETTINGS_BACKEND (settings->priv->backend));
1765 /* Extra API (sync, get_child, is_writable) {{{1 */
1768 * @context: the context to sync, or %NULL
1770 * Ensures that all pending operations for the given context are
1773 * Writes made to a #GSettings are handled asynchronously. For this
1774 * reason, it is very unlikely that the changes have it to disk by the
1775 * time g_settings_set() returns.
1777 * This call will block until all of the writes have made it to the
1778 * backend. Since the mainloop is not running, no change notifications
1779 * will be dispatched during this call (but some may be queued by the
1780 * time the call is done).
1783 g_settings_sync (void)
1785 g_settings_backend_sync_default ();
1789 * g_settings_is_writable:
1790 * @settings: a #GSettings object
1791 * @name: the name of a key
1792 * @returns: %TRUE if the key @name is writable
1794 * Finds out if a key can be written or not
1799 g_settings_is_writable (GSettings *settings,
1805 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1807 path = g_strconcat (settings->priv->path, name, NULL);
1808 writable = g_settings_backend_get_writable (settings->priv->backend, path);
1815 * g_settings_get_child:
1816 * @settings: a #GSettings object
1817 * @name: the name of the 'child' schema
1818 * @returns: a 'child' settings object
1820 * Creates a 'child' settings object which has a base path of
1821 * <replaceable>base-path</replaceable>/@name", where
1822 * <replaceable>base-path</replaceable> is the base path of @settings.
1824 * The schema for the child settings object must have been declared
1825 * in the schema of @settings using a <tag class="starttag">child</tag> element.
1830 g_settings_get_child (GSettings *settings,
1833 const gchar *child_schema;
1838 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1840 child_name = g_strconcat (name, "/", NULL);
1841 child_schema = g_settings_schema_get_string (settings->priv->schema,
1843 if (child_schema == NULL)
1844 g_error ("Schema '%s' has no child '%s'",
1845 settings->priv->schema_name, name);
1847 child_path = g_strconcat (settings->priv->path, child_name, NULL);
1848 child = g_object_new (G_TYPE_SETTINGS,
1849 "schema", child_schema,
1852 g_free (child_path);
1853 g_free (child_name);
1861 GSettings *settings;
1864 GSettingsBindGetMapping get_mapping;
1865 GSettingsBindSetMapping set_mapping;
1867 GDestroyNotify destroy;
1869 guint writable_handler_id;
1870 guint property_handler_id;
1871 const GParamSpec *property;
1872 guint key_handler_id;
1876 /* prevent recursion */
1881 g_settings_binding_free (gpointer data)
1883 GSettingsBinding *binding = data;
1885 g_assert (!binding->running);
1887 if (binding->writable_handler_id)
1888 g_signal_handler_disconnect (binding->settings,
1889 binding->writable_handler_id);
1891 if (binding->key_handler_id)
1892 g_signal_handler_disconnect (binding->settings,
1893 binding->key_handler_id);
1895 if (g_signal_handler_is_connected (binding->object,
1896 binding->property_handler_id))
1897 g_signal_handler_disconnect (binding->object,
1898 binding->property_handler_id);
1900 g_variant_type_free (binding->type);
1901 g_object_unref (binding->settings);
1903 if (binding->destroy)
1904 binding->destroy (binding->user_data);
1906 g_slice_free (GSettingsBinding, binding);
1910 g_settings_binding_quark (const char *property)
1915 tmp = g_strdup_printf ("gsettingsbinding-%s", property);
1916 quark = g_quark_from_string (tmp);
1923 g_settings_binding_key_changed (GSettings *settings,
1927 GSettingsBinding *binding = user_data;
1928 GValue value = { 0, };
1931 g_assert (settings == binding->settings);
1932 g_assert (key == binding->key);
1934 if (binding->running)
1937 binding->running = TRUE;
1939 g_value_init (&value, binding->property->value_type);
1940 variant = g_settings_get_value (settings, key);
1941 if (binding->get_mapping (&value, variant, binding->user_data))
1942 g_object_set_property (binding->object,
1943 binding->property->name,
1945 g_variant_unref (variant);
1946 g_value_unset (&value);
1948 binding->running = FALSE;
1952 g_settings_binding_property_changed (GObject *object,
1953 const GParamSpec *pspec,
1956 GSettingsBinding *binding = user_data;
1957 GValue value = { 0, };
1960 g_assert (object == binding->object);
1961 g_assert (pspec == binding->property);
1963 if (binding->running)
1966 binding->running = TRUE;
1968 g_value_init (&value, pspec->value_type);
1969 g_object_get_property (object, pspec->name, &value);
1970 if ((variant = binding->set_mapping (&value, binding->type,
1971 binding->user_data)))
1973 g_settings_set_value (binding->settings,
1975 g_variant_ref_sink (variant));
1976 g_variant_unref (variant);
1978 g_value_unset (&value);
1980 binding->running = FALSE;
1985 * @settings: a #GSettings object
1986 * @key: the key to bind
1987 * @object: a #GObject
1988 * @property: the name of the property to bind
1989 * @flags: flags for the binding
1991 * Create a binding between the @key in the @settings object
1992 * and the property @property of @object.
1994 * The binding uses the default GIO mapping functions to map
1995 * between the settings and property values. These functions
1996 * handle booleans, numeric types and string types in a
1997 * straightforward way. Use g_settings_bind_with_mapping() if
1998 * you need a custom mapping, or map between types that are not
1999 * supported by the default mapping functions.
2001 * Unless the @flags include %G_SETTINGS_BIND_NO_SENSITIVITY, this
2002 * function also establishes a binding between the writability of
2003 * @key and the "sensitive" property of @object (if @object has
2004 * a boolean property by that name). See g_settings_bind_writable()
2005 * for more details about writable bindings.
2007 * Note that the lifecycle of the binding is tied to the object,
2008 * and that you can have only one binding per object property.
2009 * If you bind the same property twice on the same object, the second
2010 * binding overrides the first one.
2015 g_settings_bind (GSettings *settings,
2018 const gchar *property,
2019 GSettingsBindFlags flags)
2021 g_settings_bind_with_mapping (settings, key, object, property,
2022 flags, NULL, NULL, NULL, NULL);
2026 * g_settings_bind_with_mapping:
2027 * @settings: a #GSettings object
2028 * @key: the key to bind
2029 * @object: a #GObject
2030 * @property: the name of the property to bind
2031 * @flags: flags for the binding
2032 * @get_mapping: a function that gets called to convert values
2033 * from @settings to @object, or %NULL to use the default GIO mapping
2034 * @set_mapping: a function that gets called to convert values
2035 * from @object to @settings, or %NULL to use the default GIO mapping
2036 * @user_data: data that gets passed to @get_mapping and @set_mapping
2037 * @destroy: #GDestroyNotify function for @user_data
2039 * Create a binding between the @key in the @settings object
2040 * and the property @property of @object.
2042 * The binding uses the provided mapping functions to map between
2043 * settings and property values.
2045 * Note that the lifecycle of the binding is tied to the object,
2046 * and that you can have only one binding per object property.
2047 * If you bind the same property twice on the same object, the second
2048 * binding overrides the first one.
2053 g_settings_bind_with_mapping (GSettings *settings,
2056 const gchar *property,
2057 GSettingsBindFlags flags,
2058 GSettingsBindGetMapping get_mapping,
2059 GSettingsBindSetMapping set_mapping,
2061 GDestroyNotify destroy)
2063 GSettingsBinding *binding;
2064 GObjectClass *objectclass;
2065 gchar *detailed_signal;
2066 GQuark binding_quark;
2068 g_return_if_fail (G_IS_SETTINGS (settings));
2070 objectclass = G_OBJECT_GET_CLASS (object);
2072 binding = g_slice_new0 (GSettingsBinding);
2073 binding->settings = g_object_ref (settings);
2074 binding->object = object;
2075 binding->key = g_intern_string (key);
2076 binding->property = g_object_class_find_property (objectclass, property);
2077 binding->user_data = user_data;
2078 binding->destroy = destroy;
2079 binding->get_mapping = get_mapping ? get_mapping : g_settings_get_mapping;
2080 binding->set_mapping = set_mapping ? set_mapping : g_settings_set_mapping;
2082 if (!(flags & (G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET)))
2083 flags |= G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET;
2085 if (binding->property == NULL)
2087 g_critical ("g_settings_bind: no property '%s' on class '%s'",
2088 property, G_OBJECT_TYPE_NAME (object));
2092 if ((flags & G_SETTINGS_BIND_GET) && (binding->property->flags & G_PARAM_WRITABLE) == 0)
2094 g_critical ("g_settings_bind: property '%s' on class '%s' is not writable",
2095 property, G_OBJECT_TYPE_NAME (object));
2098 if ((flags & G_SETTINGS_BIND_SET) && (binding->property->flags & G_PARAM_READABLE) == 0)
2100 g_critical ("g_settings_bind: property '%s' on class '%s' is not readable",
2101 property, G_OBJECT_TYPE_NAME (object));
2109 iter = g_settings_schema_get_value (settings->priv->schema, key);
2110 value = g_variant_iter_next_value (iter);
2111 binding->type = g_variant_type_copy (g_variant_get_type (value));
2112 g_variant_iter_free (iter);
2113 g_variant_unref (value);
2116 if (binding->type == NULL)
2118 g_critical ("g_settings_bind: no key '%s' on schema '%s'",
2119 key, settings->priv->schema_name);
2123 if (((get_mapping == NULL && (flags & G_SETTINGS_BIND_GET)) ||
2124 (set_mapping == NULL && (flags & G_SETTINGS_BIND_SET))) &&
2125 !g_settings_mapping_is_compatible (binding->property->value_type,
2128 g_critical ("g_settings_bind: property '%s' on class '%s' has type "
2129 "'%s' which is not compatible with type '%s' of key '%s' "
2130 "on schema '%s'", property, G_OBJECT_TYPE_NAME (object),
2131 g_type_name (binding->property->value_type),
2132 g_variant_type_dup_string (binding->type), key,
2133 settings->priv->schema_name);
2137 if ((flags & G_SETTINGS_BIND_SET) &&
2138 (~flags & G_SETTINGS_BIND_NO_SENSITIVITY))
2140 GParamSpec *sensitive;
2142 sensitive = g_object_class_find_property (objectclass, "sensitive");
2144 if (sensitive && sensitive->value_type == G_TYPE_BOOLEAN &&
2145 (sensitive->flags & G_PARAM_WRITABLE))
2146 g_settings_bind_writable (settings, binding->key,
2147 object, "sensitive", FALSE);
2150 if (flags & G_SETTINGS_BIND_SET)
2152 detailed_signal = g_strdup_printf ("notify::%s", property);
2153 binding->property_handler_id =
2154 g_signal_connect (object, detailed_signal,
2155 G_CALLBACK (g_settings_binding_property_changed),
2157 g_free (detailed_signal);
2159 if (~flags & G_SETTINGS_BIND_GET)
2160 g_settings_binding_property_changed (object,
2165 if (flags & G_SETTINGS_BIND_GET)
2167 if (~flags & G_SETTINGS_BIND_GET_NO_CHANGES)
2169 detailed_signal = g_strdup_printf ("changed::%s", key);
2170 binding->key_handler_id =
2171 g_signal_connect (settings, detailed_signal,
2172 G_CALLBACK (g_settings_binding_key_changed),
2174 g_free (detailed_signal);
2177 g_settings_binding_key_changed (settings, binding->key, binding);
2180 binding_quark = g_settings_binding_quark (property);
2181 g_object_set_qdata_full (object, binding_quark,
2182 binding, g_settings_binding_free);
2185 /* Writability binding {{{1 */
2188 GSettings *settings;
2191 const gchar *property;
2194 } GSettingsWritableBinding;
2197 g_settings_writable_binding_free (gpointer data)
2199 GSettingsWritableBinding *binding = data;
2201 g_signal_handler_disconnect (binding->settings, binding->handler_id);
2202 g_object_unref (binding->settings);
2203 g_slice_free (GSettingsWritableBinding, binding);
2207 g_settings_binding_writable_changed (GSettings *settings,
2211 GSettingsWritableBinding *binding = user_data;
2214 g_assert (settings == binding->settings);
2215 g_assert (key == binding->key);
2217 writable = g_settings_is_writable (settings, key);
2219 if (binding->inverted)
2220 writable = !writable;
2222 g_object_set (binding->object, binding->property, writable, NULL);
2226 * g_settings_bind_writable:
2227 * @settings: a #GSettings object
2228 * @key: the key to bind
2229 * @object: a #GObject
2230 * @property: the name of a boolean property to bind
2231 * @inverted: whether to 'invert' the value
2233 * Create a binding between the writability of @key in the
2234 * @settings object and the property @property of @object.
2235 * The property must be boolean; "sensitive" or "visible"
2236 * properties of widgets are the most likely candidates.
2238 * Writable bindings are always uni-directional; changes of the
2239 * writability of the setting will be propagated to the object
2240 * property, not the other way.
2242 * When the @inverted argument is %TRUE, the binding inverts the
2243 * value as it passes from the setting to the object, i.e. @property
2244 * will be set to %TRUE if the key is <emphasis>not</emphasis>
2247 * Note that the lifecycle of the binding is tied to the object,
2248 * and that you can have only one binding per object property.
2249 * If you bind the same property twice on the same object, the second
2250 * binding overrides the first one.
2255 g_settings_bind_writable (GSettings *settings,
2258 const gchar *property,
2261 GSettingsWritableBinding *binding;
2262 gchar *detailed_signal;
2265 g_return_if_fail (G_IS_SETTINGS (settings));
2267 pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
2270 g_critical ("g_settings_bind_writable: no property '%s' on class '%s'",
2271 property, G_OBJECT_TYPE_NAME (object));
2274 if ((pspec->flags & G_PARAM_WRITABLE) == 0)
2276 g_critical ("g_settings_bind_writable: property '%s' on class '%s' is not writable",
2277 property, G_OBJECT_TYPE_NAME (object));
2281 binding = g_slice_new (GSettingsWritableBinding);
2282 binding->settings = g_object_ref (settings);
2283 binding->object = object;
2284 binding->key = g_intern_string (key);
2285 binding->property = g_intern_string (property);
2286 binding->inverted = inverted;
2288 detailed_signal = g_strdup_printf ("writable-changed::%s", key);
2289 binding->handler_id =
2290 g_signal_connect (settings, detailed_signal,
2291 G_CALLBACK (g_settings_binding_writable_changed),
2293 g_free (detailed_signal);
2295 g_object_set_qdata_full (object, g_settings_binding_quark (property),
2296 binding, g_settings_writable_binding_free);
2298 g_settings_binding_writable_changed (settings, binding->key, binding);
2302 * g_settings_unbind:
2303 * @object: the object
2304 * @property: the property whose binding is removed
2306 * Removes an existing binding for @property on @object.
2308 * Note that bindings are automatically removed when the
2309 * object is finalized, so it is rarely necessary to call this
2315 g_settings_unbind (gpointer object,
2316 const gchar *property)
2318 GQuark binding_quark;
2320 binding_quark = g_settings_binding_quark (property);
2321 g_object_set_qdata (object, binding_quark, NULL);
2325 #define __G_SETTINGS_C__
2326 #include "gioaliasdef.c"
2328 /* vim:set foldmethod=marker: */