2 * Copyright © 2009, 2010 Codethink Limited
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the licence, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Author: Ryan Lortie <desrt@desrt.ca>
29 #include "gsettings.h"
31 #include "gdelayedsettingsbackend.h"
32 #include "gsettingsbackendinternal.h"
33 #include "gsettings-mapping.h"
34 #include "gsettingsschema.h"
43 * @short_description: High-level API for application settings
45 * The #GSettings class provides a convenient API for storing and retrieving
46 * application settings.
48 * Reads and writes can be considered to be non-blocking. Reading
49 * settings with #GSettings is typically extremely fast: on
50 * approximately the same order of magnitude (but slower than) a
51 * #GHashTable lookup. Writing settings is also extremely fast in terms
52 * of time to return to your application, but can be extremely expensive
53 * for other threads and other processes. Many settings backends
54 * (including dconf) have lazy initialisation which means in the common
55 * case of the user using their computer without modifying any settings
56 * a lot of work can be avoided. For dconf, the D-Bus service doesn't
57 * even need to be started in this case. For this reason, you should
58 * only ever modify #GSettings keys in response to explicit user action.
59 * Particular care should be paid to ensure that modifications are not
60 * made during startup -- for example, when setting the initial value
61 * of preferences widgets. The built-in g_settings_bind() functionality
62 * is careful not to write settings in response to notify signals as a
63 * result of modifications that it makes to widgets.
65 * When creating a GSettings instance, you have to specify a schema
66 * that describes the keys in your settings and their types and default
67 * values, as well as some other information.
69 * Normally, a schema has as fixed path that determines where the settings
70 * are stored in the conceptual global tree of settings. However, schemas
71 * can also be 'relocatable', i.e. not equipped with a fixed path. This is
72 * useful e.g. when the schema describes an 'account', and you want to be
73 * able to store a arbitrary number of accounts.
75 * Unlike other configuration systems (like GConf), GSettings does not
76 * restrict keys to basic types like strings and numbers. GSettings stores
77 * values as #GVariant, and allows any #GVariantType for keys. Key names
78 * are restricted to lowercase characters, numbers and '-'. Furthermore,
79 * the names must begin with a lowercase character, must not end
80 * with a '-', and must not contain consecutive dashes.
82 * Similar to GConf, the default values in GSettings schemas can be
83 * localized, but the localized values are stored in gettext catalogs
84 * and looked up with the domain that is specified in the
85 * <tag class="attribute">gettext-domain</tag> attribute of the
86 * <tag class="starttag">schemalist</tag> or <tag class="starttag">schema</tag>
87 * elements and the category that is specified in the l10n attribute of the
88 * <tag class="starttag">key</tag> element.
90 * GSettings uses schemas in a compact binary form that is created
91 * by the <link linkend="glib-compile-schemas">glib-compile-schemas</link>
92 * utility. The input is a schema description in an XML format that can be
93 * described by the following DTD:
94 * |[<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/gschema.dtd"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include>]|
96 * glib-compile-schemas expects schema files to have the extension <filename>.gschema.xml</filename>
98 * At runtime, schemas are identified by their id (as specified
99 * in the <tag class="attribute">id</tag> attribute of the
100 * <tag class="starttag">schema</tag> element). The
101 * convention for schema ids is to use a dotted name, similar in
102 * style to a D-Bus bus name, e.g. "org.gnome.SessionManager". In particular,
103 * if the settings are for a specific service that owns a D-Bus bus name,
104 * the D-Bus bus name and schema id should match. For schemas which deal
105 * with settings not associated with one named application, the id should
106 * not use StudlyCaps, e.g. "org.gnome.font-rendering".
108 * In addition to #GVariant types, keys can have types that have enumerated
109 * types. These can be described by a <tag class="starttag">choice</tag>,
110 * <tag class="starttag">enum</tag> or <tag class="starttag">flags</tag> element, see
111 * <xref linkend="schema-enumerated"/>. The underlying type of
112 * such a key is string, but you can use g_settings_get_enum(),
113 * g_settings_set_enum(), g_settings_get_flags(), g_settings_set_flags()
114 * access the numeric values corresponding to the string value of enum
117 * <example id="schema-default-values"><title>Default values</title>
118 * <programlisting><![CDATA[
120 * <schema id="org.gtk.Test" path="/tests/" gettext-domain="test">
122 * <key name="greeting" type="s">
123 * <default l10n="messages">"Hello, earthlings"</default>
124 * <summary>A greeting</summary>
126 * Greeting of the invading martians
130 * <key name="box" type="(ii)">
131 * <default>(20,30)</default>
136 * ]]></programlisting></example>
138 * <example id="schema-enumerated"><title>Ranges, choices and enumerated types</title>
139 * <programlisting><![CDATA[
142 * <enum id="org.gtk.Test.myenum">
143 * <value nick="first" value="1"/>
144 * <value nick="second" value="2"/>
147 * <flags id="org.gtk.Test.myflags">
148 * <value nick="flag1" value="1"/>
149 * <value nick="flag2" value="2"/>
150 * <value nick="flag3" value="4"/>
153 * <schema id="org.gtk.Test">
155 * <key name="key-with-range" type="i">
156 * <range min="1" max="100"/>
157 * <default>10</default>
160 * <key name="key-with-choices" type="s">
162 * <choice value='Elisabeth'/>
163 * <choice value='Annabeth'/>
164 * <choice value='Joe'/>
167 * <alias value='Anna' target='Annabeth'/>
168 * <alias value='Beth' target='Elisabeth'/>
170 * <default>'Joe'</default>
173 * <key name='enumerated-key' enum='org.gtk.Test.myenum'>
174 * <default>'first'</default>
177 * <key name='flags-key' flags='org.gtk.Test.myflags'>
178 * <default>["flag1",flag2"]</default>
182 * ]]></programlisting></example>
185 * <title>Vendor overrides</title>
187 * Default values are defined in the schemas that get installed by
188 * an application. Sometimes, it is necessary for a vendor or distributor
189 * to adjust these defaults. Since patching the XML source for the schema
190 * is inconvenient and error-prone,
191 * <link linkend="glib-compile-schemas">glib-compile-schemas</link> reads
192 * so-called 'vendor override' files. These are keyfiles in the same
193 * directory as the XML schema sources which can override default values.
194 * The schema id serves as the group name in the key file, and the values
195 * are expected in serialized GVariant form, as in the following example:
196 * <informalexample><programlisting>
200 * </programlisting></informalexample>
203 * glib-compile-schemas expects schema files to have the extension
204 * <filename>.gschema.override</filename>
209 * <title>Binding</title>
211 * A very convenient feature of GSettings lets you bind #GObject properties
212 * directly to settings, using g_settings_bind(). Once a GObject property
213 * has been bound to a setting, changes on either side are automatically
214 * propagated to the other side. GSettings handles details like
215 * mapping between GObject and GVariant types, and preventing infinite
219 * This makes it very easy to hook up a preferences dialog to the
220 * underlying settings. To make this even more convenient, GSettings
221 * looks for a boolean property with the name "sensitivity" and
222 * automatically binds it to the writability of the bound setting.
223 * If this 'magic' gets in the way, it can be suppressed with the
224 * #G_SETTINGS_BIND_NO_SENSITIVITY flag.
229 struct _GSettingsPrivate
231 /* where the signals go... */
232 GMainContext *main_context;
234 GSettingsBackend *backend;
235 GSettingsSchema *schema;
239 GDelayedSettingsBackend *delayed;
254 SIGNAL_WRITABLE_CHANGE_EVENT,
255 SIGNAL_WRITABLE_CHANGED,
261 static guint g_settings_signals[N_SIGNALS];
263 G_DEFINE_TYPE (GSettings, g_settings, G_TYPE_OBJECT)
267 g_settings_real_change_event (GSettings *settings,
274 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
276 for (i = 0; i < n_keys; i++)
277 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGED],
278 keys[i], g_quark_to_string (keys[i]));
284 g_settings_real_writable_change_event (GSettings *settings,
287 const GQuark *keys = &key;
292 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
294 for (i = 0; i < n_keys; i++)
295 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGED],
296 keys[i], g_quark_to_string (keys[i]));
302 settings_backend_changed (GObject *target,
303 GSettingsBackend *backend,
307 GSettings *settings = G_SETTINGS (target);
308 gboolean ignore_this;
311 /* We used to assert here:
313 * settings->priv->backend == backend
315 * but it could be the case that a notification is queued for delivery
316 * while someone calls g_settings_delay() (which changes the backend).
318 * Since the delay backend would just pass that straight through
319 * anyway, it doesn't make sense to try to detect this case.
320 * Therefore, we just accept it.
323 for (i = 0; key[i] == settings->priv->path[i]; i++);
325 if (settings->priv->path[i] == '\0' &&
326 g_settings_schema_has_key (settings->priv->schema, key + i))
330 quark = g_quark_from_string (key + i);
331 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
332 0, &quark, 1, &ignore_this);
337 settings_backend_path_changed (GObject *target,
338 GSettingsBackend *backend,
342 GSettings *settings = G_SETTINGS (target);
343 gboolean ignore_this;
345 if (g_str_has_prefix (settings->priv->path, path))
346 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
347 0, NULL, 0, &ignore_this);
351 settings_backend_keys_changed (GObject *target,
352 GSettingsBackend *backend,
354 const gchar * const *items,
357 GSettings *settings = G_SETTINGS (target);
358 gboolean ignore_this;
361 for (i = 0; settings->priv->path[i] &&
362 settings->priv->path[i] == path[i]; i++);
369 for (j = 0; items[j]; j++)
371 const gchar *item = items[j];
374 for (k = 0; item[k] == settings->priv->path[i + k]; k++);
376 if (settings->priv->path[i + k] == '\0' &&
377 g_settings_schema_has_key (settings->priv->schema, item + k))
378 quarks[l++] = g_quark_from_string (item + k);
380 /* "256 quarks ought to be enough for anybody!"
381 * If this bites you, I'm sorry. Please file a bug.
387 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
388 0, quarks, l, &ignore_this);
393 settings_backend_writable_changed (GObject *target,
394 GSettingsBackend *backend,
397 GSettings *settings = G_SETTINGS (target);
398 gboolean ignore_this;
401 for (i = 0; key[i] == settings->priv->path[i]; i++);
403 if (settings->priv->path[i] == '\0' &&
404 g_settings_schema_has_key (settings->priv->schema, key + i))
405 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
406 0, g_quark_from_string (key + i), &ignore_this);
410 settings_backend_path_writable_changed (GObject *target,
411 GSettingsBackend *backend,
414 GSettings *settings = G_SETTINGS (target);
415 gboolean ignore_this;
417 if (g_str_has_prefix (settings->priv->path, path))
418 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
419 0, (GQuark) 0, &ignore_this);
422 /* Properties, Construction, Destruction {{{1 */
424 g_settings_set_property (GObject *object,
429 GSettings *settings = G_SETTINGS (object);
434 g_assert (settings->priv->schema_name == NULL);
435 settings->priv->schema_name = g_value_dup_string (value);
439 settings->priv->path = g_value_dup_string (value);
443 settings->priv->backend = g_value_dup_object (value);
447 g_assert_not_reached ();
452 g_settings_get_property (GObject *object,
457 GSettings *settings = G_SETTINGS (object);
462 g_value_set_string (value, settings->priv->schema_name);
466 g_value_set_object (value, settings->priv->backend);
470 g_value_set_string (value, settings->priv->path);
473 case PROP_HAS_UNAPPLIED:
474 g_value_set_boolean (value, g_settings_get_has_unapplied (settings));
477 case PROP_DELAY_APPLY:
478 g_value_set_boolean (value, settings->priv->delayed != NULL);
482 g_assert_not_reached ();
486 static const GSettingsListenerVTable listener_vtable = {
487 settings_backend_changed,
488 settings_backend_path_changed,
489 settings_backend_keys_changed,
490 settings_backend_writable_changed,
491 settings_backend_path_writable_changed
495 g_settings_constructed (GObject *object)
497 GSettings *settings = G_SETTINGS (object);
498 const gchar *schema_path;
500 settings->priv->schema = g_settings_schema_new (settings->priv->schema_name);
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_object_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_get_thread_default ();
552 if (settings->priv->main_context == NULL)
553 settings->priv->main_context = g_main_context_default ();
555 g_main_context_ref (settings->priv->main_context);
559 g_settings_class_init (GSettingsClass *class)
561 GObjectClass *object_class = G_OBJECT_CLASS (class);
563 class->writable_change_event = g_settings_real_writable_change_event;
564 class->change_event = g_settings_real_change_event;
566 object_class->set_property = g_settings_set_property;
567 object_class->get_property = g_settings_get_property;
568 object_class->constructed = g_settings_constructed;
569 object_class->finalize = g_settings_finalize;
571 g_type_class_add_private (object_class, sizeof (GSettingsPrivate));
574 * GSettings::changed:
575 * @settings: the object on which the signal was emitted
576 * @key: the name of the key that changed
578 * The "changed" signal is emitted when a key has potentially changed.
579 * You should call one of the g_settings_get() calls to check the new
582 * This signal supports detailed connections. You can connect to the
583 * detailed signal "changed::x" in order to only receive callbacks
584 * when key "x" changes.
586 g_settings_signals[SIGNAL_CHANGED] =
587 g_signal_new ("changed", G_TYPE_SETTINGS,
588 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
589 G_STRUCT_OFFSET (GSettingsClass, changed),
590 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
591 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
594 * GSettings::change-event:
595 * @settings: the object on which the signal was emitted
596 * @keys: (array length=n_keys) (element-type GQuark) (allow-none):
597 * an array of #GQuark<!-- -->s for the changed keys, or %NULL
598 * @n_keys: the length of the @keys array, or 0
599 * @returns: %TRUE to stop other handlers from being invoked for the
600 * event. FALSE to propagate the event further.
602 * The "change-event" signal is emitted once per change event that
603 * affects this settings object. You should connect to this signal
604 * only if you are interested in viewing groups of changes before they
605 * are split out into multiple emissions of the "changed" signal.
606 * For most use cases it is more appropriate to use the "changed" signal.
608 * In the event that the change event applies to one or more specified
609 * keys, @keys will be an array of #GQuark of length @n_keys. In the
610 * event that the change event applies to the #GSettings object as a
611 * whole (ie: potentially every key has been changed) then @keys will
612 * be %NULL and @n_keys will be 0.
614 * The default handler for this signal invokes the "changed" signal
615 * for each affected key. If any other connected handler returns
616 * %TRUE then this default functionality will be supressed.
618 g_settings_signals[SIGNAL_CHANGE_EVENT] =
619 g_signal_new ("change-event", G_TYPE_SETTINGS,
621 G_STRUCT_OFFSET (GSettingsClass, change_event),
622 g_signal_accumulator_true_handled, NULL,
623 g_cclosure_marshal_generic,
624 G_TYPE_BOOLEAN, 2, G_TYPE_POINTER, G_TYPE_INT);
627 * GSettings::writable-changed:
628 * @settings: the object on which the signal was emitted
631 * The "writable-changed" signal is emitted when the writability of a
632 * key has potentially changed. You should call
633 * g_settings_is_writable() in order to determine the new status.
635 * This signal supports detailed connections. You can connect to the
636 * detailed signal "writable-changed::x" in order to only receive
637 * callbacks when the writability of "x" changes.
639 g_settings_signals[SIGNAL_WRITABLE_CHANGED] =
640 g_signal_new ("writable-changed", G_TYPE_SETTINGS,
641 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
642 G_STRUCT_OFFSET (GSettingsClass, writable_changed),
643 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
644 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
647 * GSettings::writable-change-event:
648 * @settings: the object on which the signal was emitted
649 * @key: the quark of the key, or 0
650 * @returns: %TRUE to stop other handlers from being invoked for the
651 * event. FALSE to propagate the event further.
653 * The "writable-change-event" signal is emitted once per writability
654 * change event that affects this settings object. You should connect
655 * to this signal if you are interested in viewing groups of changes
656 * before they are split out into multiple emissions of the
657 * "writable-changed" signal. For most use cases it is more
658 * appropriate to use the "writable-changed" signal.
660 * In the event that the writability change applies only to a single
661 * key, @key will be set to the #GQuark for that key. In the event
662 * that the writability change affects the entire settings object,
665 * The default handler for this signal invokes the "writable-changed"
666 * and "changed" signals for each affected key. This is done because
667 * changes in writability might also imply changes in value (if for
668 * example, a new mandatory setting is introduced). If any other
669 * connected handler returns %TRUE then this default functionality
672 g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT] =
673 g_signal_new ("writable-change-event", G_TYPE_SETTINGS,
675 G_STRUCT_OFFSET (GSettingsClass, writable_change_event),
676 g_signal_accumulator_true_handled, NULL,
677 g_cclosure_marshal_generic, G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
682 * The name of the context that the settings are stored in.
684 g_object_class_install_property (object_class, PROP_BACKEND,
685 g_param_spec_object ("backend",
686 P_("GSettingsBackend"),
687 P_("The GSettingsBackend for this settings object"),
688 G_TYPE_SETTINGS_BACKEND, G_PARAM_CONSTRUCT_ONLY |
689 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
694 * The name of the schema that describes the types of keys
695 * for this #GSettings object.
697 g_object_class_install_property (object_class, PROP_SCHEMA,
698 g_param_spec_string ("schema",
700 P_("The name of the schema for this settings object"),
702 G_PARAM_CONSTRUCT_ONLY |
703 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
708 * The path within the backend where the settings are stored.
710 g_object_class_install_property (object_class, PROP_PATH,
711 g_param_spec_string ("path",
713 P_("The path within the backend where the settings are"),
715 G_PARAM_CONSTRUCT_ONLY |
716 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
719 * GSettings:has-unapplied:
721 * If this property is %TRUE, the #GSettings object has outstanding
722 * changes that will be applied when g_settings_apply() is called.
724 g_object_class_install_property (object_class, PROP_HAS_UNAPPLIED,
725 g_param_spec_boolean ("has-unapplied",
726 P_("Has unapplied changes"),
727 P_("TRUE if there are outstanding changes to apply()"),
729 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
732 * GSettings:delay-apply:
734 * Whether the #GSettings object is in 'delay-apply' mode. See
735 * g_settings_delay() for details.
739 g_object_class_install_property (object_class, PROP_DELAY_APPLY,
740 g_param_spec_boolean ("delay-apply",
741 P_("Delay-apply mode"),
742 P_("Whether this settings object is in 'delay-apply' mode"),
744 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
747 /* Construction (new, new_with_path, etc.) {{{1 */
750 * @schema: the name of the schema
751 * @returns: a new #GSettings object
753 * Creates a new #GSettings object with a given schema.
755 * Signals on the newly created #GSettings object will be dispatched
756 * via the thread-default #GMainContext in effect at the time of the
757 * call to g_settings_new(). The new #GSettings will hold a reference
758 * on the context. See g_main_context_push_thread_default().
763 g_settings_new (const gchar *schema)
765 g_return_val_if_fail (schema != NULL, NULL);
767 return g_object_new (G_TYPE_SETTINGS,
773 * g_settings_new_with_path:
774 * @schema: the name of the schema
775 * @path: the path to use
776 * @returns: a new #GSettings object
778 * Creates a new #GSettings object with a given schema and path.
780 * You only need to do this if you want to directly create a settings
781 * object with a schema that doesn't have a specified path of its own.
784 * It is a programmer error to call this function for a schema that
785 * has an explicitly specified path.
790 g_settings_new_with_path (const gchar *schema,
793 g_return_val_if_fail (schema != NULL, NULL);
794 g_return_val_if_fail (path != NULL, NULL);
796 return g_object_new (G_TYPE_SETTINGS,
803 * g_settings_new_with_backend:
804 * @schema: the name of the schema
805 * @backend: the #GSettingsBackend to use
806 * @returns: a new #GSettings object
808 * Creates a new #GSettings object with a given schema and backend.
810 * Creating a #GSettings object with a different backend allows accessing
811 * settings from a database other than the usual one. For example, it may make
812 * sense to pass a backend corresponding to the "defaults" settings database on
813 * the system to get a settings object that modifies the system default
814 * settings instead of the settings for this user.
819 g_settings_new_with_backend (const gchar *schema,
820 GSettingsBackend *backend)
822 g_return_val_if_fail (schema != NULL, NULL);
823 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
825 return g_object_new (G_TYPE_SETTINGS,
832 * g_settings_new_with_backend_and_path:
833 * @schema: the name of the schema
834 * @backend: the #GSettingsBackend to use
835 * @path: the path to use
836 * @returns: a new #GSettings object
838 * Creates a new #GSettings object with a given schema, backend and
841 * This is a mix of g_settings_new_with_backend() and
842 * g_settings_new_with_path().
847 g_settings_new_with_backend_and_path (const gchar *schema,
848 GSettingsBackend *backend,
851 g_return_val_if_fail (schema != NULL, NULL);
852 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
853 g_return_val_if_fail (path != NULL, NULL);
855 return g_object_new (G_TYPE_SETTINGS,
862 /* Internal read/write utilities, enum/flags conversion, validation {{{1 */
868 GSettingsSchema *schema;
873 const guint32 *strinfo;
874 gsize strinfo_length;
876 const gchar *unparsed;
879 const GVariantType *type;
880 GVariant *minimum, *maximum;
881 GVariant *default_value;
885 endian_fixup (GVariant **value)
887 #if G_BYTE_ORDER == G_BIG_ENDIAN
890 tmp = g_variant_byteswap (*value);
891 g_variant_unref (*value);
897 g_settings_get_key_info (GSettingsKeyInfo *info,
905 memset (info, 0, sizeof *info);
907 iter = g_settings_schema_get_value (settings->priv->schema, key);
909 info->default_value = g_variant_iter_next_value (iter);
910 endian_fixup (&info->default_value);
911 info->type = g_variant_get_type (info->default_value);
912 info->settings = g_object_ref (settings);
913 info->key = g_intern_string (key);
915 while (g_variant_iter_next (iter, "(y*)", &code, &data))
920 /* translation requested */
921 g_variant_get (data, "(y&s)", &info->lc_char, &info->unparsed);
925 /* enumerated types... */
926 info->is_enum = TRUE;
931 info->is_flags = TRUE;
935 /* ..., choices, aliases */
936 info->strinfo = g_variant_get_fixed_array (data,
937 &info->strinfo_length,
942 g_variant_get (data, "(**)", &info->minimum, &info->maximum);
943 endian_fixup (&info->minimum);
944 endian_fixup (&info->maximum);
948 g_warning ("unknown schema extension '%c'", code);
952 g_variant_unref (data);
955 g_variant_iter_free (iter);
959 g_settings_free_key_info (GSettingsKeyInfo *info)
962 g_variant_unref (info->minimum);
965 g_variant_unref (info->maximum);
967 g_variant_unref (info->default_value);
968 g_object_unref (info->settings);
972 g_settings_write_to_backend (GSettingsKeyInfo *info,
978 path = g_strconcat (info->settings->priv->path, info->key, NULL);
979 success = g_settings_backend_write (info->settings->priv->backend,
987 g_settings_type_check (GSettingsKeyInfo *info,
990 g_return_val_if_fail (value != NULL, FALSE);
992 return g_variant_is_of_type (value, info->type);
996 g_settings_key_info_range_check (GSettingsKeyInfo *info,
999 if (info->minimum == NULL && info->strinfo == NULL)
1002 if (g_variant_is_container (value))
1008 g_variant_iter_init (&iter, value);
1009 while (ok && (child = g_variant_iter_next_value (&iter)))
1011 ok = g_settings_key_info_range_check (info, child);
1012 g_variant_unref (child);
1020 return g_variant_compare (info->minimum, value) <= 0 &&
1021 g_variant_compare (value, info->maximum) <= 0;
1024 return strinfo_is_string_valid (info->strinfo,
1025 info->strinfo_length,
1026 g_variant_get_string (value, NULL));
1030 g_settings_range_fixup (GSettingsKeyInfo *info,
1033 const gchar *target;
1035 if (g_settings_key_info_range_check (info, value))
1036 return g_variant_ref (value);
1038 if (info->strinfo == NULL)
1041 if (g_variant_is_container (value))
1043 GVariantBuilder builder;
1047 g_variant_iter_init (&iter, value);
1048 g_variant_builder_init (&builder, g_variant_get_type (value));
1050 while ((child = g_variant_iter_next_value (&iter)))
1054 fixed = g_settings_range_fixup (info, child);
1055 g_variant_unref (child);
1059 g_variant_builder_clear (&builder);
1063 g_variant_builder_add_value (&builder, fixed);
1064 g_variant_unref (fixed);
1067 return g_variant_ref_sink (g_variant_builder_end (&builder));
1070 target = strinfo_string_from_alias (info->strinfo, info->strinfo_length,
1071 g_variant_get_string (value, NULL));
1072 return target ? g_variant_ref_sink (g_variant_new_string (target)) : NULL;
1076 g_settings_read_from_backend (GSettingsKeyInfo *info)
1082 path = g_strconcat (info->settings->priv->path, info->key, NULL);
1083 value = g_settings_backend_read (info->settings->priv->backend,
1084 path, info->type, FALSE);
1089 fixup = g_settings_range_fixup (info, value);
1090 g_variant_unref (value);
1099 g_settings_get_translated_default (GSettingsKeyInfo *info)
1101 const gchar *translated;
1102 GError *error = NULL;
1103 const gchar *domain;
1106 if (info->lc_char == '\0')
1107 /* translation not requested for this key */
1110 domain = g_settings_schema_get_gettext_domain (info->settings->priv->schema);
1112 if (info->lc_char == 't')
1113 translated = g_dcgettext (domain, info->unparsed, LC_TIME);
1115 translated = g_dgettext (domain, info->unparsed);
1117 if (translated == info->unparsed)
1118 /* the default value was not translated */
1121 /* try to parse the translation of the unparsed default */
1122 value = g_variant_parse (info->type, translated, NULL, NULL, &error);
1126 g_warning ("Failed to parse translated string `%s' for "
1127 "key `%s' in schema `%s': %s", info->unparsed, info->key,
1128 info->settings->priv->schema_name, error->message);
1129 g_warning ("Using untranslated default instead.");
1130 g_error_free (error);
1133 else if (!g_settings_key_info_range_check (info, value))
1135 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
1136 "is outside of valid range", info->unparsed, info->key,
1137 info->settings->priv->schema_name);
1138 g_variant_unref (value);
1146 g_settings_to_enum (GSettingsKeyInfo *info,
1152 it_worked = strinfo_enum_from_string (info->strinfo, info->strinfo_length,
1153 g_variant_get_string (value, NULL),
1156 /* 'value' can only come from the backend after being filtered for validity,
1157 * from the translation after being filtered for validity, or from the schema
1158 * itself (which the schema compiler checks for validity). If this assertion
1159 * fails then it's really a bug in GSettings or the schema compiler...
1161 g_assert (it_worked);
1167 g_settings_from_enum (GSettingsKeyInfo *info,
1170 const gchar *string;
1172 string = strinfo_string_from_enum (info->strinfo,
1173 info->strinfo_length,
1179 return g_variant_new_string (string);
1183 g_settings_to_flags (GSettingsKeyInfo *info,
1191 g_variant_iter_init (&iter, value);
1192 while (g_variant_iter_next (&iter, "&s", &flag))
1197 it_worked = strinfo_enum_from_string (info->strinfo,
1198 info->strinfo_length,
1200 /* as in g_settings_to_enum() */
1201 g_assert (it_worked);
1203 result |= flag_value;
1210 g_settings_from_flags (GSettingsKeyInfo *info,
1213 GVariantBuilder builder;
1216 g_variant_builder_init (&builder, G_VARIANT_TYPE ("as"));
1218 for (i = 0; i < 32; i++)
1219 if (value & (1u << i))
1221 const gchar *string;
1223 string = strinfo_string_from_enum (info->strinfo,
1224 info->strinfo_length,
1229 g_variant_builder_clear (&builder);
1233 g_variant_builder_add (&builder, "s", string);
1236 return g_variant_builder_end (&builder);
1239 /* Public Get/Set API {{{1 (get, get_value, set, set_value, get_mapped) */
1241 * g_settings_get_value:
1242 * @settings: a #GSettings object
1243 * @key: the key to get the value for
1244 * @returns: a new #GVariant
1246 * Gets the value that is stored in @settings for @key.
1248 * It is a programmer error to give a @key that isn't contained in the
1249 * schema for @settings.
1254 g_settings_get_value (GSettings *settings,
1257 GSettingsKeyInfo info;
1260 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1261 g_return_val_if_fail (key != NULL, NULL);
1263 g_settings_get_key_info (&info, settings, key);
1264 value = g_settings_read_from_backend (&info);
1267 value = g_settings_get_translated_default (&info);
1270 value = g_variant_ref (info.default_value);
1272 g_settings_free_key_info (&info);
1278 * g_settings_get_enum:
1279 * @settings: a #GSettings object
1280 * @key: the key to get the value for
1281 * @returns: the enum value
1283 * Gets the value that is stored in @settings for @key and converts it
1284 * to the enum value that it represents.
1286 * In order to use this function the type of the value must be a string
1287 * and it must be marked in the schema file as an enumerated type.
1289 * It is a programmer error to give a @key that isn't contained in the
1290 * schema for @settings or is not marked as an enumerated type.
1292 * If the value stored in the configuration database is not a valid
1293 * value for the enumerated type then this function will return the
1299 g_settings_get_enum (GSettings *settings,
1302 GSettingsKeyInfo info;
1306 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1307 g_return_val_if_fail (key != NULL, -1);
1309 g_settings_get_key_info (&info, settings, key);
1313 g_critical ("g_settings_get_enum() called on key `%s' which is not "
1314 "associated with an enumerated type", info.key);
1315 g_settings_free_key_info (&info);
1319 value = g_settings_read_from_backend (&info);
1322 value = g_settings_get_translated_default (&info);
1325 value = g_variant_ref (info.default_value);
1327 result = g_settings_to_enum (&info, value);
1328 g_settings_free_key_info (&info);
1329 g_variant_unref (value);
1335 * g_settings_set_enum:
1336 * @settings: a #GSettings object
1337 * @key: a key, within @settings
1338 * @value: an enumerated value
1339 * @returns: %TRUE, if the set succeeds
1341 * Looks up the enumerated type nick for @value and writes it to @key,
1344 * It is a programmer error to give a @key that isn't contained in the
1345 * schema for @settings or is not marked as an enumerated type, or for
1346 * @value not to be a valid value for the named type.
1348 * After performing the write, accessing @key directly with
1349 * g_settings_get_string() will return the 'nick' associated with
1353 g_settings_set_enum (GSettings *settings,
1357 GSettingsKeyInfo info;
1361 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1362 g_return_val_if_fail (key != NULL, FALSE);
1364 g_settings_get_key_info (&info, settings, key);
1368 g_critical ("g_settings_set_enum() called on key `%s' which is not "
1369 "associated with an enumerated type", info.key);
1373 if (!(variant = g_settings_from_enum (&info, value)))
1375 g_critical ("g_settings_set_enum(): invalid enum value %d for key `%s' "
1376 "in schema `%s'. Doing nothing.", value, info.key,
1377 info.settings->priv->schema_name);
1378 g_settings_free_key_info (&info);
1382 success = g_settings_write_to_backend (&info, variant);
1383 g_settings_free_key_info (&info);
1389 * g_settings_get_flags:
1390 * @settings: a #GSettings object
1391 * @key: the key to get the value for
1392 * @returns: the flags value
1394 * Gets the value that is stored in @settings for @key and converts it
1395 * to the flags value that it represents.
1397 * In order to use this function the type of the value must be an array
1398 * of strings and it must be marked in the schema file as an flags type.
1400 * It is a programmer error to give a @key that isn't contained in the
1401 * schema for @settings or is not marked as a flags type.
1403 * If the value stored in the configuration database is not a valid
1404 * value for the flags type then this function will return the default
1410 g_settings_get_flags (GSettings *settings,
1413 GSettingsKeyInfo info;
1417 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1418 g_return_val_if_fail (key != NULL, -1);
1420 g_settings_get_key_info (&info, settings, key);
1424 g_critical ("g_settings_get_flags() called on key `%s' which is not "
1425 "associated with a flags type", info.key);
1426 g_settings_free_key_info (&info);
1430 value = g_settings_read_from_backend (&info);
1433 value = g_settings_get_translated_default (&info);
1436 value = g_variant_ref (info.default_value);
1438 result = g_settings_to_flags (&info, value);
1439 g_settings_free_key_info (&info);
1440 g_variant_unref (value);
1446 * g_settings_set_flags:
1447 * @settings: a #GSettings object
1448 * @key: a key, within @settings
1449 * @value: a flags value
1450 * @returns: %TRUE, if the set succeeds
1452 * Looks up the flags type nicks for the bits specified by @value, puts
1453 * them in an array of strings and writes the array to @key, withing
1456 * It is a programmer error to give a @key that isn't contained in the
1457 * schema for @settings or is not marked as a flags type, or for @value
1458 * to contain any bits that are not value for the named type.
1460 * After performing the write, accessing @key directly with
1461 * g_settings_get_strv() will return an array of 'nicks'; one for each
1465 g_settings_set_flags (GSettings *settings,
1469 GSettingsKeyInfo info;
1473 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1474 g_return_val_if_fail (key != NULL, FALSE);
1476 g_settings_get_key_info (&info, settings, key);
1480 g_critical ("g_settings_set_flags() called on key `%s' which is not "
1481 "associated with a flags type", info.key);
1485 if (!(variant = g_settings_from_flags (&info, value)))
1487 g_critical ("g_settings_set_flags(): invalid flags value 0x%08x "
1488 "for key `%s' in schema `%s'. Doing nothing.",
1489 value, info.key, info.settings->priv->schema_name);
1490 g_settings_free_key_info (&info);
1494 success = g_settings_write_to_backend (&info, variant);
1495 g_settings_free_key_info (&info);
1501 * g_settings_set_value:
1502 * @settings: a #GSettings object
1503 * @key: the name of the key to set
1504 * @value: a #GVariant of the correct type
1505 * @returns: %TRUE if setting the key succeeded,
1506 * %FALSE if the key was not writable
1508 * Sets @key in @settings to @value.
1510 * It is a programmer error to give a @key that isn't contained in the
1511 * schema for @settings or for @value to have the incorrect type, per
1514 * If @value is floating then this function consumes the reference.
1519 g_settings_set_value (GSettings *settings,
1523 GSettingsKeyInfo info;
1525 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1526 g_return_val_if_fail (key != NULL, FALSE);
1528 g_settings_get_key_info (&info, settings, key);
1530 if (!g_settings_type_check (&info, value))
1532 g_critical ("g_settings_set_value: key '%s' in '%s' expects type '%s', but a GVariant of type '%s' was given",
1534 settings->priv->schema_name,
1535 g_variant_type_peek_string (info.type),
1536 g_variant_get_type_string (value));
1541 if (!g_settings_key_info_range_check (&info, value))
1543 g_warning ("g_settings_set_value: value for key '%s' in schema '%s' "
1544 "is outside of valid range",
1546 settings->priv->schema_name);
1551 g_settings_free_key_info (&info);
1553 return g_settings_write_to_backend (&info, value);
1558 * @settings: a #GSettings object
1559 * @key: the key to get the value for
1560 * @format: a #GVariant format string
1561 * @...: arguments as per @format
1563 * Gets the value that is stored at @key in @settings.
1565 * A convenience function that combines g_settings_get_value() with
1568 * It is a programmer error to give a @key that isn't contained in the
1569 * schema for @settings or for the #GVariantType of @format to mismatch
1570 * the type given in the schema.
1575 g_settings_get (GSettings *settings,
1577 const gchar *format,
1583 value = g_settings_get_value (settings, key);
1585 va_start (ap, format);
1586 g_variant_get_va (value, format, NULL, &ap);
1589 g_variant_unref (value);
1594 * @settings: a #GSettings object
1595 * @key: the name of the key to set
1596 * @format: a #GVariant format string
1597 * @...: arguments as per @format
1598 * @returns: %TRUE if setting the key succeeded,
1599 * %FALSE if the key was not writable
1601 * Sets @key in @settings to @value.
1603 * A convenience function that combines g_settings_set_value() with
1606 * It is a programmer error to give a @key that isn't contained in the
1607 * schema for @settings or for the #GVariantType of @format to mismatch
1608 * the type given in the schema.
1613 g_settings_set (GSettings *settings,
1615 const gchar *format,
1621 va_start (ap, format);
1622 value = g_variant_new_va (format, NULL, &ap);
1625 return g_settings_set_value (settings, key, value);
1629 * g_settings_get_mapped:
1630 * @settings: a #GSettings object
1631 * @key: the key to get the value for
1632 * @mapping: (scope call): the function to map the value in the
1633 * settings database to the value used by the application
1634 * @user_data: user data for @mapping
1635 * @returns: (transfer full): the result, which may be %NULL
1637 * Gets the value that is stored at @key in @settings, subject to
1638 * application-level validation/mapping.
1640 * You should use this function when the application needs to perform
1641 * some processing on the value of the key (for example, parsing). The
1642 * @mapping function performs that processing. If the function
1643 * indicates that the processing was unsuccessful (due to a parse error,
1644 * for example) then the mapping is tried again with another value.
1646 * This allows a robust 'fall back to defaults' behaviour to be
1647 * implemented somewhat automatically.
1649 * The first value that is tried is the user's setting for the key. If
1650 * the mapping function fails to map this value, other values may be
1651 * tried in an unspecified order (system or site defaults, translated
1652 * schema default values, untranslated schema default values, etc).
1654 * If the mapping function fails for all possible values, one additional
1655 * attempt is made: the mapping function is called with a %NULL value.
1656 * If the mapping function still indicates failure at this point then
1657 * the application will be aborted.
1659 * The result parameter for the @mapping function is pointed to a
1660 * #gpointer which is initially set to %NULL. The same pointer is given
1661 * to each invocation of @mapping. The final value of that #gpointer is
1662 * what is returned by this function. %NULL is valid; it is returned
1663 * just as any other value would be.
1666 g_settings_get_mapped (GSettings *settings,
1668 GSettingsGetMapping mapping,
1671 gpointer result = NULL;
1672 GSettingsKeyInfo info;
1676 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1677 g_return_val_if_fail (key != NULL, NULL);
1678 g_return_val_if_fail (mapping != NULL, NULL);
1680 g_settings_get_key_info (&info, settings, key);
1682 if ((value = g_settings_read_from_backend (&info)))
1684 okay = mapping (value, &result, user_data);
1685 g_variant_unref (value);
1686 if (okay) goto okay;
1689 if ((value = g_settings_get_translated_default (&info)))
1691 okay = mapping (value, &result, user_data);
1692 g_variant_unref (value);
1693 if (okay) goto okay;
1696 if (mapping (info.default_value, &result, user_data))
1699 if (!mapping (NULL, &result, user_data))
1700 g_error ("The mapping function given to g_settings_get_mapped() for key "
1701 "`%s' in schema `%s' returned FALSE when given a NULL value.",
1702 key, settings->priv->schema_name);
1705 g_settings_free_key_info (&info);
1710 /* Convenience API (get, set_string, int, double, boolean, strv) {{{1 */
1712 * g_settings_get_string:
1713 * @settings: a #GSettings object
1714 * @key: the key to get the value for
1715 * @returns: a newly-allocated string
1717 * Gets the value that is stored at @key in @settings.
1719 * A convenience variant of g_settings_get() for strings.
1721 * It is a programmer error to give a @key that isn't specified as
1722 * having a string type in the schema for @settings.
1727 g_settings_get_string (GSettings *settings,
1733 value = g_settings_get_value (settings, key);
1734 result = g_variant_dup_string (value, NULL);
1735 g_variant_unref (value);
1741 * g_settings_set_string:
1742 * @settings: a #GSettings object
1743 * @key: the name of the key to set
1744 * @value: the value to set it to
1745 * @returns: %TRUE if setting the key succeeded,
1746 * %FALSE if the key was not writable
1748 * Sets @key in @settings to @value.
1750 * A convenience variant of g_settings_set() for strings.
1752 * It is a programmer error to give a @key that isn't specified as
1753 * having a string type in the schema for @settings.
1758 g_settings_set_string (GSettings *settings,
1762 return g_settings_set_value (settings, key, g_variant_new_string (value));
1766 * g_settings_get_int:
1767 * @settings: a #GSettings object
1768 * @key: the key to get the value for
1769 * @returns: an integer
1771 * Gets the value that is stored at @key in @settings.
1773 * A convenience variant of g_settings_get() for 32-bit integers.
1775 * It is a programmer error to give a @key that isn't specified as
1776 * having a int32 type in the schema for @settings.
1781 g_settings_get_int (GSettings *settings,
1787 value = g_settings_get_value (settings, key);
1788 result = g_variant_get_int32 (value);
1789 g_variant_unref (value);
1795 * g_settings_set_int:
1796 * @settings: a #GSettings object
1797 * @key: the name of the key to set
1798 * @value: the value to set it to
1799 * @returns: %TRUE if setting the key succeeded,
1800 * %FALSE if the key was not writable
1802 * Sets @key in @settings to @value.
1804 * A convenience variant of g_settings_set() for 32-bit integers.
1806 * It is a programmer error to give a @key that isn't specified as
1807 * having a int32 type in the schema for @settings.
1812 g_settings_set_int (GSettings *settings,
1816 return g_settings_set_value (settings, key, g_variant_new_int32 (value));
1820 * g_settings_get_uint:
1821 * @settings: a #GSettings object
1822 * @key: the key to get the value for
1823 * @returns: an unsigned integer
1825 * Gets the value that is stored at @key in @settings.
1827 * A convenience variant of g_settings_get() for 32-bit unsigned
1830 * It is a programmer error to give a @key that isn't specified as
1831 * having a uint32 type in the schema for @settings.
1836 g_settings_get_uint (GSettings *settings,
1842 value = g_settings_get_value (settings, key);
1843 result = g_variant_get_uint32 (value);
1844 g_variant_unref (value);
1850 * g_settings_set_uint:
1851 * @settings: a #GSettings object
1852 * @key: the name of the key to set
1853 * @value: the value to set it to
1854 * @returns: %TRUE if setting the key succeeded,
1855 * %FALSE if the key was not writable
1857 * Sets @key in @settings to @value.
1859 * A convenience variant of g_settings_set() for 32-bit unsigned
1862 * It is a programmer error to give a @key that isn't specified as
1863 * having a uint32 type in the schema for @settings.
1868 g_settings_set_uint (GSettings *settings,
1872 return g_settings_set_value (settings, key, g_variant_new_uint32 (value));
1876 * g_settings_get_double:
1877 * @settings: a #GSettings object
1878 * @key: the key to get the value for
1879 * @returns: a double
1881 * Gets the value that is stored at @key in @settings.
1883 * A convenience variant of g_settings_get() for doubles.
1885 * It is a programmer error to give a @key that isn't specified as
1886 * having a 'double' type in the schema for @settings.
1891 g_settings_get_double (GSettings *settings,
1897 value = g_settings_get_value (settings, key);
1898 result = g_variant_get_double (value);
1899 g_variant_unref (value);
1905 * g_settings_set_double:
1906 * @settings: a #GSettings object
1907 * @key: the name of the key to set
1908 * @value: the value to set it to
1909 * @returns: %TRUE if setting the key succeeded,
1910 * %FALSE if the key was not writable
1912 * Sets @key in @settings to @value.
1914 * A convenience variant of g_settings_set() for doubles.
1916 * It is a programmer error to give a @key that isn't specified as
1917 * having a 'double' type in the schema for @settings.
1922 g_settings_set_double (GSettings *settings,
1926 return g_settings_set_value (settings, key, g_variant_new_double (value));
1930 * g_settings_get_boolean:
1931 * @settings: a #GSettings object
1932 * @key: the key to get the value for
1933 * @returns: a boolean
1935 * Gets the value that is stored at @key in @settings.
1937 * A convenience variant of g_settings_get() for booleans.
1939 * It is a programmer error to give a @key that isn't specified as
1940 * having a boolean type in the schema for @settings.
1945 g_settings_get_boolean (GSettings *settings,
1951 value = g_settings_get_value (settings, key);
1952 result = g_variant_get_boolean (value);
1953 g_variant_unref (value);
1959 * g_settings_set_boolean:
1960 * @settings: a #GSettings object
1961 * @key: the name of the key to set
1962 * @value: the value to set it to
1963 * @returns: %TRUE if setting the key succeeded,
1964 * %FALSE if the key was not writable
1966 * Sets @key in @settings to @value.
1968 * A convenience variant of g_settings_set() for booleans.
1970 * It is a programmer error to give a @key that isn't specified as
1971 * having a boolean type in the schema for @settings.
1976 g_settings_set_boolean (GSettings *settings,
1980 return g_settings_set_value (settings, key, g_variant_new_boolean (value));
1984 * g_settings_get_strv:
1985 * @settings: a #GSettings object
1986 * @key: the key to get the value for
1987 * @returns: (array zero-terminated=1) (transfer full): a
1988 * newly-allocated, %NULL-terminated array of strings, the value that
1989 * is stored at @key in @settings.
1991 * A convenience variant of g_settings_get() for string arrays.
1993 * It is a programmer error to give a @key that isn't specified as
1994 * having an array of strings type in the schema for @settings.
1999 g_settings_get_strv (GSettings *settings,
2005 value = g_settings_get_value (settings, key);
2006 result = g_variant_dup_strv (value, NULL);
2007 g_variant_unref (value);
2013 * g_settings_set_strv:
2014 * @settings: a #GSettings object
2015 * @key: the name of the key to set
2016 * @value: (allow-none) (array zero-terminated=1): the value to set it to, or %NULL
2017 * @returns: %TRUE if setting the key succeeded,
2018 * %FALSE if the key was not writable
2020 * Sets @key in @settings to @value.
2022 * A convenience variant of g_settings_set() for string arrays. If
2023 * @value is %NULL, then @key is set to be the empty array.
2025 * It is a programmer error to give a @key that isn't specified as
2026 * having an array of strings type in the schema for @settings.
2031 g_settings_set_strv (GSettings *settings,
2033 const gchar * const *value)
2038 array = g_variant_new_strv (value, -1);
2040 array = g_variant_new_strv (NULL, 0);
2042 return g_settings_set_value (settings, key, array);
2045 /* Delayed apply (delay, apply, revert, get_has_unapplied) {{{1 */
2048 * @settings: a #GSettings object
2050 * Changes the #GSettings object into 'delay-apply' mode. In this
2051 * mode, changes to @settings are not immediately propagated to the
2052 * backend, but kept locally until g_settings_apply() is called.
2057 g_settings_delay (GSettings *settings)
2059 g_return_if_fail (G_IS_SETTINGS (settings));
2061 if (settings->priv->delayed)
2064 settings->priv->delayed =
2065 g_delayed_settings_backend_new (settings->priv->backend,
2067 settings->priv->main_context);
2068 g_settings_backend_unwatch (settings->priv->backend, G_OBJECT (settings));
2069 g_object_unref (settings->priv->backend);
2071 settings->priv->backend = G_SETTINGS_BACKEND (settings->priv->delayed);
2072 g_settings_backend_watch (settings->priv->backend,
2073 &listener_vtable, G_OBJECT (settings),
2074 settings->priv->main_context);
2076 g_object_notify (G_OBJECT (settings), "delay-apply");
2081 * @settings: a #GSettings instance
2083 * Applies any changes that have been made to the settings. This
2084 * function does nothing unless @settings is in 'delay-apply' mode;
2085 * see g_settings_delay(). In the normal case settings are always
2086 * applied immediately.
2089 g_settings_apply (GSettings *settings)
2091 if (settings->priv->delayed)
2093 GDelayedSettingsBackend *delayed;
2095 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
2096 g_delayed_settings_backend_apply (delayed);
2101 * g_settings_revert:
2102 * @settings: a #GSettings instance
2104 * Reverts all non-applied changes to the settings. This function
2105 * does nothing unless @settings is in 'delay-apply' mode; see
2106 * g_settings_delay(). In the normal case settings are always applied
2109 * Change notifications will be emitted for affected keys.
2112 g_settings_revert (GSettings *settings)
2114 if (settings->priv->delayed)
2116 GDelayedSettingsBackend *delayed;
2118 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
2119 g_delayed_settings_backend_revert (delayed);
2124 * g_settings_get_has_unapplied:
2125 * @settings: a #GSettings object
2126 * @returns: %TRUE if @settings has unapplied changes
2128 * Returns whether the #GSettings object has any unapplied
2129 * changes. This can only be the case if it is in 'delayed-apply' mode.
2134 g_settings_get_has_unapplied (GSettings *settings)
2136 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
2138 return settings->priv->delayed &&
2139 g_delayed_settings_backend_get_has_unapplied (
2140 G_DELAYED_SETTINGS_BACKEND (settings->priv->backend));
2143 /* Extra API (reset, sync, get_child, is_writable, list_*, ranges) {{{1 */
2146 * @settings: a #GSettings object
2147 * @key: the name of a key
2149 * Resets @key to its default value.
2151 * This call resets the key, as much as possible, to its default value.
2152 * That might the value specified in the schema or the one set by the
2156 g_settings_reset (GSettings *settings,
2161 path = g_strconcat (settings->priv->path, key, NULL);
2162 g_settings_backend_reset (settings->priv->backend, path, NULL);
2169 * Ensures that all pending operations for the given are complete for
2170 * the default backend.
2172 * Writes made to a #GSettings are handled asynchronously. For this
2173 * reason, it is very unlikely that the changes have it to disk by the
2174 * time g_settings_set() returns.
2176 * This call will block until all of the writes have made it to the
2177 * backend. Since the mainloop is not running, no change notifications
2178 * will be dispatched during this call (but some may be queued by the
2179 * time the call is done).
2182 g_settings_sync (void)
2184 g_settings_backend_sync_default ();
2188 * g_settings_is_writable:
2189 * @settings: a #GSettings object
2190 * @name: the name of a key
2191 * @returns: %TRUE if the key @name is writable
2193 * Finds out if a key can be written or not
2198 g_settings_is_writable (GSettings *settings,
2204 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
2206 path = g_strconcat (settings->priv->path, name, NULL);
2207 writable = g_settings_backend_get_writable (settings->priv->backend, path);
2214 * g_settings_get_child:
2215 * @settings: a #GSettings object
2216 * @name: the name of the 'child' schema
2217 * @returns: (transfer full): a 'child' settings object
2219 * Creates a 'child' settings object which has a base path of
2220 * <replaceable>base-path</replaceable>/@name, where
2221 * <replaceable>base-path</replaceable> is the base path of @settings.
2223 * The schema for the child settings object must have been declared
2224 * in the schema of @settings using a <tag class="starttag">child</tag> element.
2229 g_settings_get_child (GSettings *settings,
2232 const gchar *child_schema;
2237 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
2239 child_name = g_strconcat (name, "/", NULL);
2240 child_schema = g_settings_schema_get_string (settings->priv->schema,
2242 if (child_schema == NULL)
2243 g_error ("Schema '%s' has no child '%s'",
2244 settings->priv->schema_name, name);
2246 child_path = g_strconcat (settings->priv->path, child_name, NULL);
2247 child = g_object_new (G_TYPE_SETTINGS,
2248 "schema", child_schema,
2251 g_free (child_path);
2252 g_free (child_name);
2258 * g_settings_list_keys:
2259 * @settings: a #GSettings object
2260 * @returns: (transfer full) (element-type utf8): a list of the keys on @settings
2262 * Introspects the list of keys on @settings.
2264 * You should probably not be calling this function from "normal" code
2265 * (since you should already know what keys are in your schema). This
2266 * function is intended for introspection reasons.
2268 * You should free the return value with g_strfreev() when you are done
2272 g_settings_list_keys (GSettings *settings)
2279 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2280 strv = g_new (gchar *, n_keys + 1);
2281 for (i = j = 0; i < n_keys; i++)
2283 const gchar *key = g_quark_to_string (keys[i]);
2285 if (!g_str_has_suffix (key, "/"))
2286 strv[j++] = g_strdup (key);
2294 * g_settings_list_children:
2295 * @settings: a #GSettings object
2296 * @returns: (transfer full) (element-type utf8): a list of the children on @settings
2298 * Gets the list of children on @settings.
2300 * The list is exactly the list of strings for which it is not an error
2301 * to call g_settings_get_child().
2303 * For GSettings objects that are lists, this value can change at any
2304 * time and you should connect to the "children-changed" signal to watch
2305 * for those changes. Note that there is a race condition here: you may
2306 * request a child after listing it only for it to have been destroyed
2307 * in the meantime. For this reason, g_settings_get_child() may return
2308 * %NULL even for a child that was listed by this function.
2310 * For GSettings objects that are not lists, you should probably not be
2311 * calling this function from "normal" code (since you should already
2312 * know what children are in your schema). This function may still be
2313 * useful there for introspection reasons, however.
2315 * You should free the return value with g_strfreev() when you are done
2319 g_settings_list_children (GSettings *settings)
2326 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2327 strv = g_new (gchar *, n_keys + 1);
2328 for (i = j = 0; i < n_keys; i++)
2330 const gchar *key = g_quark_to_string (keys[i]);
2332 if (g_str_has_suffix (key, "/"))
2334 gint length = strlen (key);
2336 strv[j] = g_memdup (key, length);
2337 strv[j][length - 1] = '\0';
2347 * g_settings_get_range:
2348 * @settings: a #GSettings
2349 * @key: the key to query the range of
2350 * @returns: a #GVariant describing the range
2352 * Queries the range of a key.
2354 * This function will return a #GVariant that fully describes the range
2355 * of values that are valid for @key.
2357 * The type of #GVariant returned is <literal>(sv)</literal>. The
2358 * string describes the type of range restriction in effect. The type
2359 * and meaning of the value contained in the variant depends on the
2362 * If the string is <literal>'type'</literal> then the variant contains
2363 * an empty array. The element type of that empty array is the expected
2364 * type of value and all values of that type are valid.
2366 * If the string is <literal>'enum'</literal> then the variant contains
2367 * an array enumerating the possible values. Each item in the array is
2368 * a possible valid value and no other values are valid.
2370 * If the string is <literal>'flags'</literal> then the variant contains
2371 * an array. Each item in the array is a value that may appear zero or
2372 * one times in an array to be used as the value for this key. For
2373 * example, if the variant contained the array <literal>['x',
2374 * 'y']</literal> then the valid values for the key would be
2375 * <literal>[]</literal>, <literal>['x']</literal>,
2376 * <literal>['y']</literal>, <literal>['x', 'y']</literal> and
2377 * <literal>['y', 'x']</literal>.
2379 * Finally, if the string is <literal>'range'</literal> then the variant
2380 * contains a pair of like-typed values -- the minimum and maximum
2381 * permissible values for this key.
2383 * This information should not be used by normal programs. It is
2384 * considered to be a hint for introspection purposes. Normal programs
2385 * should already know what is permitted by their own schema. The
2386 * format may change in any way in the future -- but particularly, new
2387 * forms may be added to the possibilities described above.
2389 * It is a programmer error to give a @key that isn't contained in the
2390 * schema for @settings.
2392 * You should free the returned value with g_variant_unref() when it is
2398 g_settings_get_range (GSettings *settings,
2401 GSettingsKeyInfo info;
2405 g_settings_get_key_info (&info, settings, key);
2409 range = g_variant_new ("(**)", info.minimum, info.maximum);
2412 else if (info.strinfo)
2414 range = strinfo_enumerate (info.strinfo, info.strinfo_length);
2415 type = info.is_flags ? "flags" : "enum";
2419 range = g_variant_new_array (info.type, NULL, 0);
2423 g_settings_free_key_info (&info);
2425 return g_variant_ref_sink (g_variant_new ("(sv)", type, range));
2429 * g_settings_range_check:
2430 * @settings: a #GSettings
2431 * @key: the key to check
2432 * @value: the value to check
2433 * @returns: %TRUE if @value is valid for @key
2435 * Checks if the given @value is of the correct type and within the
2436 * permitted range for @key.
2438 * This API is not intended to be used by normal programs -- they should
2439 * already know what is permitted by their own schemas. This API is
2440 * meant to be used by programs such as editors or commandline tools.
2442 * It is a programmer error to give a @key that isn't contained in the
2443 * schema for @settings.
2448 g_settings_range_check (GSettings *settings,
2452 GSettingsKeyInfo info;
2455 g_settings_get_key_info (&info, settings, key);
2456 good = g_settings_type_check (&info, value) &&
2457 g_settings_key_info_range_check (&info, value);
2458 g_settings_free_key_info (&info);
2466 GSettingsKeyInfo info;
2469 GSettingsBindGetMapping get_mapping;
2470 GSettingsBindSetMapping set_mapping;
2472 GDestroyNotify destroy;
2474 guint writable_handler_id;
2475 guint property_handler_id;
2476 const GParamSpec *property;
2477 guint key_handler_id;
2479 /* prevent recursion */
2484 g_settings_binding_free (gpointer data)
2486 GSettingsBinding *binding = data;
2488 g_assert (!binding->running);
2490 if (binding->writable_handler_id)
2491 g_signal_handler_disconnect (binding->info.settings,
2492 binding->writable_handler_id);
2494 if (binding->key_handler_id)
2495 g_signal_handler_disconnect (binding->info.settings,
2496 binding->key_handler_id);
2498 if (g_signal_handler_is_connected (binding->object,
2499 binding->property_handler_id))
2500 g_signal_handler_disconnect (binding->object,
2501 binding->property_handler_id);
2503 g_settings_free_key_info (&binding->info);
2505 if (binding->destroy)
2506 binding->destroy (binding->user_data);
2508 g_slice_free (GSettingsBinding, binding);
2512 g_settings_binding_quark (const char *property)
2517 tmp = g_strdup_printf ("gsettingsbinding-%s", property);
2518 quark = g_quark_from_string (tmp);
2525 g_settings_binding_key_changed (GSettings *settings,
2529 GSettingsBinding *binding = user_data;
2530 GValue value = { 0, };
2533 g_assert (settings == binding->info.settings);
2534 g_assert (key == binding->info.key);
2536 if (binding->running)
2539 binding->running = TRUE;
2541 g_value_init (&value, binding->property->value_type);
2543 variant = g_settings_read_from_backend (&binding->info);
2544 if (variant && !binding->get_mapping (&value, variant, binding->user_data))
2546 /* silently ignore errors in the user's config database */
2547 g_variant_unref (variant);
2551 if (variant == NULL)
2553 variant = g_settings_get_translated_default (&binding->info);
2555 !binding->get_mapping (&value, variant, binding->user_data))
2557 /* flag translation errors with a warning */
2558 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
2559 "was rejected by the binding mapping function",
2560 binding->info.unparsed, binding->info.key,
2561 binding->info.settings->priv->schema_name);
2562 g_variant_unref (variant);
2567 if (variant == NULL)
2569 variant = g_variant_ref (binding->info.default_value);
2570 if (!binding->get_mapping (&value, variant, binding->user_data))
2571 g_error ("The schema default value for key `%s' in schema `%s' "
2572 "was rejected by the binding mapping function.",
2574 binding->info.settings->priv->schema_name);
2577 g_object_set_property (binding->object, binding->property->name, &value);
2578 g_variant_unref (variant);
2579 g_value_unset (&value);
2581 binding->running = FALSE;
2585 g_settings_binding_property_changed (GObject *object,
2586 const GParamSpec *pspec,
2589 GSettingsBinding *binding = user_data;
2590 GValue value = { 0, };
2593 g_assert (object == binding->object);
2594 g_assert (pspec == binding->property);
2596 if (binding->running)
2599 binding->running = TRUE;
2601 g_value_init (&value, pspec->value_type);
2602 g_object_get_property (object, pspec->name, &value);
2603 if ((variant = binding->set_mapping (&value, binding->info.type,
2604 binding->user_data)))
2606 g_variant_take_ref (variant);
2608 if (!g_settings_type_check (&binding->info, variant))
2610 g_critical ("binding mapping function for key `%s' returned "
2611 "GVariant of type `%s' when type `%s' was requested",
2612 binding->info.key, g_variant_get_type_string (variant),
2613 g_variant_type_dup_string (binding->info.type));
2617 if (!g_settings_key_info_range_check (&binding->info, variant))
2619 g_critical ("GObject property `%s' on a `%s' object is out of "
2620 "schema-specified range for key `%s' of `%s': %s",
2621 binding->property->name,
2622 g_type_name (binding->property->owner_type),
2624 binding->info.settings->priv->schema_name,
2625 g_variant_print (variant, TRUE));
2629 g_settings_write_to_backend (&binding->info, variant);
2630 g_variant_unref (variant);
2632 g_value_unset (&value);
2634 binding->running = FALSE;
2638 g_settings_bind_invert_boolean_get_mapping (GValue *value,
2642 g_value_set_boolean (value, !g_variant_get_boolean (variant));
2647 g_settings_bind_invert_boolean_set_mapping (const GValue *value,
2648 const GVariantType *expected_type,
2651 return g_variant_new_boolean (!g_value_get_boolean (value));
2656 * @settings: a #GSettings object
2657 * @key: the key to bind
2658 * @object: (type GObject.Object): a #GObject
2659 * @property: the name of the property to bind
2660 * @flags: flags for the binding
2662 * Create a binding between the @key in the @settings object
2663 * and the property @property of @object.
2665 * The binding uses the default GIO mapping functions to map
2666 * between the settings and property values. These functions
2667 * handle booleans, numeric types and string types in a
2668 * straightforward way. Use g_settings_bind_with_mapping() if
2669 * you need a custom mapping, or map between types that are not
2670 * supported by the default mapping functions.
2672 * Unless the @flags include %G_SETTINGS_BIND_NO_SENSITIVITY, this
2673 * function also establishes a binding between the writability of
2674 * @key and the "sensitive" property of @object (if @object has
2675 * a boolean property by that name). See g_settings_bind_writable()
2676 * for more details about writable bindings.
2678 * Note that the lifecycle of the binding is tied to the object,
2679 * and that you can have only one binding per object property.
2680 * If you bind the same property twice on the same object, the second
2681 * binding overrides the first one.
2686 g_settings_bind (GSettings *settings,
2689 const gchar *property,
2690 GSettingsBindFlags flags)
2692 GSettingsBindGetMapping get_mapping = NULL;
2693 GSettingsBindSetMapping set_mapping = NULL;
2695 if (flags & G_SETTINGS_BIND_INVERT_BOOLEAN)
2697 get_mapping = g_settings_bind_invert_boolean_get_mapping;
2698 set_mapping = g_settings_bind_invert_boolean_set_mapping;
2700 /* can't pass this flag to g_settings_bind_with_mapping() */
2701 flags &= ~G_SETTINGS_BIND_INVERT_BOOLEAN;
2704 g_settings_bind_with_mapping (settings, key, object, property, flags,
2705 get_mapping, set_mapping, NULL, NULL);
2709 * g_settings_bind_with_mapping: (skip)
2710 * @settings: a #GSettings object
2711 * @key: the key to bind
2712 * @object: (type GObject.Object): a #GObject
2713 * @property: the name of the property to bind
2714 * @flags: flags for the binding
2715 * @get_mapping: a function that gets called to convert values
2716 * from @settings to @object, or %NULL to use the default GIO mapping
2717 * @set_mapping: a function that gets called to convert values
2718 * from @object to @settings, or %NULL to use the default GIO mapping
2719 * @user_data: data that gets passed to @get_mapping and @set_mapping
2720 * @destroy: #GDestroyNotify function for @user_data
2722 * Create a binding between the @key in the @settings object
2723 * and the property @property of @object.
2725 * The binding uses the provided mapping functions to map between
2726 * settings and property values.
2728 * Note that the lifecycle of the binding is tied to the object,
2729 * and that you can have only one binding per object property.
2730 * If you bind the same property twice on the same object, the second
2731 * binding overrides the first one.
2736 g_settings_bind_with_mapping (GSettings *settings,
2739 const gchar *property,
2740 GSettingsBindFlags flags,
2741 GSettingsBindGetMapping get_mapping,
2742 GSettingsBindSetMapping set_mapping,
2744 GDestroyNotify destroy)
2746 GSettingsBinding *binding;
2747 GObjectClass *objectclass;
2748 gchar *detailed_signal;
2749 GQuark binding_quark;
2751 g_return_if_fail (G_IS_SETTINGS (settings));
2752 g_return_if_fail (~flags & G_SETTINGS_BIND_INVERT_BOOLEAN);
2754 objectclass = G_OBJECT_GET_CLASS (object);
2756 binding = g_slice_new0 (GSettingsBinding);
2757 g_settings_get_key_info (&binding->info, settings, key);
2758 binding->object = object;
2759 binding->property = g_object_class_find_property (objectclass, property);
2760 binding->user_data = user_data;
2761 binding->destroy = destroy;
2762 binding->get_mapping = get_mapping ? get_mapping : g_settings_get_mapping;
2763 binding->set_mapping = set_mapping ? set_mapping : g_settings_set_mapping;
2765 if (!(flags & (G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET)))
2766 flags |= G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET;
2768 if (binding->property == NULL)
2770 g_critical ("g_settings_bind: no property '%s' on class '%s'",
2771 property, G_OBJECT_TYPE_NAME (object));
2775 if ((flags & G_SETTINGS_BIND_GET) &&
2776 (binding->property->flags & G_PARAM_WRITABLE) == 0)
2778 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2779 "writable", property, G_OBJECT_TYPE_NAME (object));
2782 if ((flags & G_SETTINGS_BIND_SET) &&
2783 (binding->property->flags & G_PARAM_READABLE) == 0)
2785 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2786 "readable", property, G_OBJECT_TYPE_NAME (object));
2790 if (get_mapping == g_settings_bind_invert_boolean_get_mapping)
2792 /* g_settings_bind_invert_boolean_get_mapping() is a private
2793 * function, so if we are here it means that g_settings_bind() was
2794 * called with G_SETTINGS_BIND_INVERT_BOOLEAN.
2796 * Ensure that both sides are boolean.
2799 if (binding->property->value_type != G_TYPE_BOOLEAN)
2801 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2802 "was specified, but property `%s' on type `%s' has "
2803 "type `%s'", property, G_OBJECT_TYPE_NAME (object),
2804 g_type_name ((binding->property->value_type)));
2808 if (!g_variant_type_equal (binding->info.type, G_VARIANT_TYPE_BOOLEAN))
2810 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2811 "was specified, but key `%s' on schema `%s' has "
2812 "type `%s'", key, settings->priv->schema_name,
2813 g_variant_type_dup_string (binding->info.type));
2819 else if (((get_mapping == NULL && (flags & G_SETTINGS_BIND_GET)) ||
2820 (set_mapping == NULL && (flags & G_SETTINGS_BIND_SET))) &&
2821 !g_settings_mapping_is_compatible (binding->property->value_type,
2822 binding->info.type))
2824 g_critical ("g_settings_bind: property '%s' on class '%s' has type "
2825 "'%s' which is not compatible with type '%s' of key '%s' "
2826 "on schema '%s'", property, G_OBJECT_TYPE_NAME (object),
2827 g_type_name (binding->property->value_type),
2828 g_variant_type_dup_string (binding->info.type), key,
2829 settings->priv->schema_name);
2833 if ((flags & G_SETTINGS_BIND_SET) &&
2834 (~flags & G_SETTINGS_BIND_NO_SENSITIVITY))
2836 GParamSpec *sensitive;
2838 sensitive = g_object_class_find_property (objectclass, "sensitive");
2840 if (sensitive && sensitive->value_type == G_TYPE_BOOLEAN &&
2841 (sensitive->flags & G_PARAM_WRITABLE))
2842 g_settings_bind_writable (settings, binding->info.key,
2843 object, "sensitive", FALSE);
2846 if (flags & G_SETTINGS_BIND_SET)
2848 detailed_signal = g_strdup_printf ("notify::%s", property);
2849 binding->property_handler_id =
2850 g_signal_connect (object, detailed_signal,
2851 G_CALLBACK (g_settings_binding_property_changed),
2853 g_free (detailed_signal);
2855 if (~flags & G_SETTINGS_BIND_GET)
2856 g_settings_binding_property_changed (object,
2861 if (flags & G_SETTINGS_BIND_GET)
2863 if (~flags & G_SETTINGS_BIND_GET_NO_CHANGES)
2865 detailed_signal = g_strdup_printf ("changed::%s", key);
2866 binding->key_handler_id =
2867 g_signal_connect (settings, detailed_signal,
2868 G_CALLBACK (g_settings_binding_key_changed),
2870 g_free (detailed_signal);
2873 g_settings_binding_key_changed (settings, binding->info.key, binding);
2876 binding_quark = g_settings_binding_quark (property);
2877 g_object_set_qdata_full (object, binding_quark,
2878 binding, g_settings_binding_free);
2881 /* Writability binding {{{1 */
2884 GSettings *settings;
2887 const gchar *property;
2890 } GSettingsWritableBinding;
2893 g_settings_writable_binding_free (gpointer data)
2895 GSettingsWritableBinding *binding = data;
2897 g_signal_handler_disconnect (binding->settings, binding->handler_id);
2898 g_object_unref (binding->settings);
2899 g_slice_free (GSettingsWritableBinding, binding);
2903 g_settings_binding_writable_changed (GSettings *settings,
2907 GSettingsWritableBinding *binding = user_data;
2910 g_assert (settings == binding->settings);
2911 g_assert (key == binding->key);
2913 writable = g_settings_is_writable (settings, key);
2915 if (binding->inverted)
2916 writable = !writable;
2918 g_object_set (binding->object, binding->property, writable, NULL);
2922 * g_settings_bind_writable:
2923 * @settings: a #GSettings object
2924 * @key: the key to bind
2925 * @object: (type GObject.Object):a #GObject
2926 * @property: the name of a boolean property to bind
2927 * @inverted: whether to 'invert' the value
2929 * Create a binding between the writability of @key in the
2930 * @settings object and the property @property of @object.
2931 * The property must be boolean; "sensitive" or "visible"
2932 * properties of widgets are the most likely candidates.
2934 * Writable bindings are always uni-directional; changes of the
2935 * writability of the setting will be propagated to the object
2936 * property, not the other way.
2938 * When the @inverted argument is %TRUE, the binding inverts the
2939 * value as it passes from the setting to the object, i.e. @property
2940 * will be set to %TRUE if the key is <emphasis>not</emphasis>
2943 * Note that the lifecycle of the binding is tied to the object,
2944 * and that you can have only one binding per object property.
2945 * If you bind the same property twice on the same object, the second
2946 * binding overrides the first one.
2951 g_settings_bind_writable (GSettings *settings,
2954 const gchar *property,
2957 GSettingsWritableBinding *binding;
2958 gchar *detailed_signal;
2961 g_return_if_fail (G_IS_SETTINGS (settings));
2963 pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
2966 g_critical ("g_settings_bind_writable: no property '%s' on class '%s'",
2967 property, G_OBJECT_TYPE_NAME (object));
2970 if ((pspec->flags & G_PARAM_WRITABLE) == 0)
2972 g_critical ("g_settings_bind_writable: property '%s' on class '%s' is not writable",
2973 property, G_OBJECT_TYPE_NAME (object));
2977 binding = g_slice_new (GSettingsWritableBinding);
2978 binding->settings = g_object_ref (settings);
2979 binding->object = object;
2980 binding->key = g_intern_string (key);
2981 binding->property = g_intern_string (property);
2982 binding->inverted = inverted;
2984 detailed_signal = g_strdup_printf ("writable-changed::%s", key);
2985 binding->handler_id =
2986 g_signal_connect (settings, detailed_signal,
2987 G_CALLBACK (g_settings_binding_writable_changed),
2989 g_free (detailed_signal);
2991 g_object_set_qdata_full (object, g_settings_binding_quark (property),
2992 binding, g_settings_writable_binding_free);
2994 g_settings_binding_writable_changed (settings, binding->key, binding);
2998 * g_settings_unbind:
2999 * @object: the object
3000 * @property: the property whose binding is removed
3002 * Removes an existing binding for @property on @object.
3004 * Note that bindings are automatically removed when the
3005 * object is finalized, so it is rarely necessary to call this
3011 g_settings_unbind (gpointer object,
3012 const gchar *property)
3014 GQuark binding_quark;
3016 binding_quark = g_settings_binding_quark (property);
3017 g_object_set_qdata (object, binding_quark, NULL);
3022 /* vim:set foldmethod=marker: */