2 * Copyright © 2009, 2010 Codethink Limited
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the licence, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Author: Ryan Lortie <desrt@desrt.ca>
29 #include "gsettings.h"
31 #include "gdelayedsettingsbackend.h"
32 #include "gsettingsbackendinternal.h"
33 #include "gsettings-mapping.h"
34 #include "gsettingsschema-internal.h"
40 * @short_description: High-level API for application settings
42 * The #GSettings class provides a convenient API for storing and retrieving
43 * application settings.
45 * Reads and writes can be considered to be non-blocking. Reading
46 * settings with #GSettings is typically extremely fast: on
47 * approximately the same order of magnitude (but slower than) a
48 * #GHashTable lookup. Writing settings is also extremely fast in terms
49 * of time to return to your application, but can be extremely expensive
50 * for other threads and other processes. Many settings backends
51 * (including dconf) have lazy initialisation which means in the common
52 * case of the user using their computer without modifying any settings
53 * a lot of work can be avoided. For dconf, the D-Bus service doesn't
54 * even need to be started in this case. For this reason, you should
55 * only ever modify #GSettings keys in response to explicit user action.
56 * Particular care should be paid to ensure that modifications are not
57 * made during startup -- for example, when setting the initial value
58 * of preferences widgets. The built-in g_settings_bind() functionality
59 * is careful not to write settings in response to notify signals as a
60 * result of modifications that it makes to widgets.
62 * When creating a GSettings instance, you have to specify a schema
63 * that describes the keys in your settings and their types and default
64 * values, as well as some other information.
66 * Normally, a schema has as fixed path that determines where the settings
67 * are stored in the conceptual global tree of settings. However, schemas
68 * can also be 'relocatable', i.e. not equipped with a fixed path. This is
69 * useful e.g. when the schema describes an 'account', and you want to be
70 * able to store a arbitrary number of accounts.
72 * Unlike other configuration systems (like GConf), GSettings does not
73 * restrict keys to basic types like strings and numbers. GSettings stores
74 * values as #GVariant, and allows any #GVariantType for keys. Key names
75 * are restricted to lowercase characters, numbers and '-'. Furthermore,
76 * the names must begin with a lowercase character, must not end
77 * with a '-', and must not contain consecutive dashes.
79 * Similar to GConf, the default values in GSettings schemas can be
80 * localized, but the localized values are stored in gettext catalogs
81 * and looked up with the domain that is specified in the
82 * <tag class="attribute">gettext-domain</tag> attribute of the
83 * <tag class="starttag">schemalist</tag> or <tag class="starttag">schema</tag>
84 * elements and the category that is specified in the l10n attribute of the
85 * <tag class="starttag">key</tag> element.
87 * GSettings uses schemas in a compact binary form that is created
88 * by the <link linkend="glib-compile-schemas">glib-compile-schemas</link>
89 * utility. The input is a schema description in an XML format that can be
90 * described by the following DTD:
91 * |[<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>]|
93 * glib-compile-schemas expects schema files to have the extension <filename>.gschema.xml</filename>
95 * At runtime, schemas are identified by their id (as specified
96 * in the <tag class="attribute">id</tag> attribute of the
97 * <tag class="starttag">schema</tag> element). The
98 * convention for schema ids is to use a dotted name, similar in
99 * style to a D-Bus bus name, e.g. "org.gnome.SessionManager". In particular,
100 * if the settings are for a specific service that owns a D-Bus bus name,
101 * the D-Bus bus name and schema id should match. For schemas which deal
102 * with settings not associated with one named application, the id should
103 * not use StudlyCaps, e.g. "org.gnome.font-rendering".
105 * In addition to #GVariant types, keys can have types that have enumerated
106 * types. These can be described by a <tag class="starttag">choice</tag>,
107 * <tag class="starttag">enum</tag> or <tag class="starttag">flags</tag> element, see
108 * <xref linkend="schema-enumerated"/>. The underlying type of
109 * such a key is string, but you can use g_settings_get_enum(),
110 * g_settings_set_enum(), g_settings_get_flags(), g_settings_set_flags()
111 * access the numeric values corresponding to the string value of enum
114 * <example id="schema-default-values"><title>Default values</title>
115 * <programlisting><![CDATA[
117 * <schema id="org.gtk.Test" path="/tests/" gettext-domain="test">
119 * <key name="greeting" type="s">
120 * <default l10n="messages">"Hello, earthlings"</default>
121 * <summary>A greeting</summary>
123 * Greeting of the invading martians
127 * <key name="box" type="(ii)">
128 * <default>(20,30)</default>
133 * ]]></programlisting></example>
135 * <example id="schema-enumerated"><title>Ranges, choices and enumerated types</title>
136 * <programlisting><![CDATA[
139 * <enum id="org.gtk.Test.myenum">
140 * <value nick="first" value="1"/>
141 * <value nick="second" value="2"/>
144 * <flags id="org.gtk.Test.myflags">
145 * <value nick="flag1" value="1"/>
146 * <value nick="flag2" value="2"/>
147 * <value nick="flag3" value="4"/>
150 * <schema id="org.gtk.Test">
152 * <key name="key-with-range" type="i">
153 * <range min="1" max="100"/>
154 * <default>10</default>
157 * <key name="key-with-choices" type="s">
159 * <choice value='Elisabeth'/>
160 * <choice value='Annabeth'/>
161 * <choice value='Joe'/>
164 * <alias value='Anna' target='Annabeth'/>
165 * <alias value='Beth' target='Elisabeth'/>
167 * <default>'Joe'</default>
170 * <key name='enumerated-key' enum='org.gtk.Test.myenum'>
171 * <default>'first'</default>
174 * <key name='flags-key' flags='org.gtk.Test.myflags'>
175 * <default>["flag1",flag2"]</default>
179 * ]]></programlisting></example>
182 * <title>Vendor overrides</title>
184 * Default values are defined in the schemas that get installed by
185 * an application. Sometimes, it is necessary for a vendor or distributor
186 * to adjust these defaults. Since patching the XML source for the schema
187 * is inconvenient and error-prone,
188 * <link linkend="glib-compile-schemas">glib-compile-schemas</link> reads
189 * so-called 'vendor override' files. These are keyfiles in the same
190 * directory as the XML schema sources which can override default values.
191 * The schema id serves as the group name in the key file, and the values
192 * are expected in serialized GVariant form, as in the following example:
193 * <informalexample><programlisting>
197 * </programlisting></informalexample>
200 * glib-compile-schemas expects schema files to have the extension
201 * <filename>.gschema.override</filename>
206 * <title>Binding</title>
208 * A very convenient feature of GSettings lets you bind #GObject properties
209 * directly to settings, using g_settings_bind(). Once a GObject property
210 * has been bound to a setting, changes on either side are automatically
211 * propagated to the other side. GSettings handles details like
212 * mapping between GObject and GVariant types, and preventing infinite
216 * This makes it very easy to hook up a preferences dialog to the
217 * underlying settings. To make this even more convenient, GSettings
218 * looks for a boolean property with the name "sensitivity" and
219 * automatically binds it to the writability of the bound setting.
220 * If this 'magic' gets in the way, it can be suppressed with the
221 * #G_SETTINGS_BIND_NO_SENSITIVITY flag.
226 struct _GSettingsPrivate
228 /* where the signals go... */
229 GMainContext *main_context;
231 GSettingsBackend *backend;
232 GSettingsSchema *schema;
235 GDelayedSettingsBackend *delayed;
251 SIGNAL_WRITABLE_CHANGE_EVENT,
252 SIGNAL_WRITABLE_CHANGED,
258 static guint g_settings_signals[N_SIGNALS];
260 G_DEFINE_TYPE (GSettings, g_settings, G_TYPE_OBJECT)
264 g_settings_real_change_event (GSettings *settings,
271 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
273 for (i = 0; i < n_keys; i++)
274 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGED],
275 keys[i], g_quark_to_string (keys[i]));
281 g_settings_real_writable_change_event (GSettings *settings,
284 const GQuark *keys = &key;
289 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
291 for (i = 0; i < n_keys; i++)
292 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGED],
293 keys[i], g_quark_to_string (keys[i]));
299 settings_backend_changed (GObject *target,
300 GSettingsBackend *backend,
304 GSettings *settings = G_SETTINGS (target);
305 gboolean ignore_this;
308 /* We used to assert here:
310 * settings->priv->backend == backend
312 * but it could be the case that a notification is queued for delivery
313 * while someone calls g_settings_delay() (which changes the backend).
315 * Since the delay backend would just pass that straight through
316 * anyway, it doesn't make sense to try to detect this case.
317 * Therefore, we just accept it.
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 (GObject *target,
335 GSettingsBackend *backend,
339 GSettings *settings = G_SETTINGS (target);
340 gboolean ignore_this;
342 if (g_str_has_prefix (settings->priv->path, path))
343 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
344 0, NULL, 0, &ignore_this);
348 settings_backend_keys_changed (GObject *target,
349 GSettingsBackend *backend,
351 const gchar * const *items,
354 GSettings *settings = G_SETTINGS (target);
355 gboolean ignore_this;
358 for (i = 0; settings->priv->path[i] &&
359 settings->priv->path[i] == path[i]; i++);
366 for (j = 0; items[j]; j++)
368 const gchar *item = items[j];
371 for (k = 0; item[k] == settings->priv->path[i + k]; k++);
373 if (settings->priv->path[i + k] == '\0' &&
374 g_settings_schema_has_key (settings->priv->schema, item + k))
375 quarks[l++] = g_quark_from_string (item + k);
377 /* "256 quarks ought to be enough for anybody!"
378 * If this bites you, I'm sorry. Please file a bug.
384 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
385 0, quarks, l, &ignore_this);
390 settings_backend_writable_changed (GObject *target,
391 GSettingsBackend *backend,
394 GSettings *settings = G_SETTINGS (target);
395 gboolean ignore_this;
398 for (i = 0; key[i] == settings->priv->path[i]; i++);
400 if (settings->priv->path[i] == '\0' &&
401 g_settings_schema_has_key (settings->priv->schema, key + i))
402 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
403 0, g_quark_from_string (key + i), &ignore_this);
407 settings_backend_path_writable_changed (GObject *target,
408 GSettingsBackend *backend,
411 GSettings *settings = G_SETTINGS (target);
412 gboolean ignore_this;
414 if (g_str_has_prefix (settings->priv->path, path))
415 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
416 0, (GQuark) 0, &ignore_this);
419 /* Properties, Construction, Destruction {{{1 */
421 g_settings_set_property (GObject *object,
426 GSettings *settings = G_SETTINGS (object);
432 GSettingsSchema *schema;
434 schema = g_value_dup_boxed (value);
436 /* we receive a set_property() call for "settings-schema" even
437 * if it was not specified (ie: with NULL value). ->schema
438 * could already be set at this point (ie: via "schema-id").
439 * check for NULL to avoid clobbering the existing value.
443 g_assert (settings->priv->schema == NULL);
444 settings->priv->schema = schema;
451 const gchar *schema_id;
453 schema_id = g_value_get_string (value);
455 /* we receive a set_property() call for both "schema" and
456 * "schema-id", even if they are not set. Hopefully only one of
459 if (schema_id != NULL)
461 GSettingsSchemaSource *default_source;
463 g_assert (settings->priv->schema == NULL);
464 default_source = g_settings_schema_source_get_default ();
466 if (default_source == NULL)
467 g_error ("No GSettings schemas are installed on the system");
469 settings->priv->schema = g_settings_schema_source_lookup (default_source, schema_id, TRUE);
471 if (settings->priv->schema == NULL)
472 g_error ("Settings schema '%s' is not installed\n", schema_id);
478 settings->priv->path = g_value_dup_string (value);
482 settings->priv->backend = g_value_dup_object (value);
486 g_assert_not_reached ();
491 g_settings_get_property (GObject *object,
496 GSettings *settings = G_SETTINGS (object);
501 g_value_set_boxed (value, settings->priv->schema);
505 g_value_set_string (value, g_settings_schema_get_id (settings->priv->schema));
509 g_value_set_object (value, settings->priv->backend);
513 g_value_set_string (value, settings->priv->path);
516 case PROP_HAS_UNAPPLIED:
517 g_value_set_boolean (value, g_settings_get_has_unapplied (settings));
520 case PROP_DELAY_APPLY:
521 g_value_set_boolean (value, settings->priv->delayed != NULL);
525 g_assert_not_reached ();
529 static const GSettingsListenerVTable listener_vtable = {
530 settings_backend_changed,
531 settings_backend_path_changed,
532 settings_backend_keys_changed,
533 settings_backend_writable_changed,
534 settings_backend_path_writable_changed
538 g_settings_constructed (GObject *object)
540 GSettings *settings = G_SETTINGS (object);
541 const gchar *schema_path;
543 schema_path = g_settings_schema_get_path (settings->priv->schema);
545 if (settings->priv->path && schema_path && strcmp (settings->priv->path, schema_path) != 0)
546 g_error ("settings object created with schema '%s' and path '%s', but path '%s' is specified by schema",
547 g_settings_schema_get_id (settings->priv->schema), settings->priv->path, schema_path);
549 if (settings->priv->path == NULL)
551 if (schema_path == NULL)
552 g_error ("attempting to create schema '%s' without a path",
553 g_settings_schema_get_id (settings->priv->schema));
555 settings->priv->path = g_strdup (schema_path);
558 if (settings->priv->backend == NULL)
559 settings->priv->backend = g_settings_backend_get_default ();
561 g_settings_backend_watch (settings->priv->backend,
562 &listener_vtable, G_OBJECT (settings),
563 settings->priv->main_context);
564 g_settings_backend_subscribe (settings->priv->backend,
565 settings->priv->path);
569 g_settings_finalize (GObject *object)
571 GSettings *settings = G_SETTINGS (object);
573 g_settings_backend_unsubscribe (settings->priv->backend,
574 settings->priv->path);
575 g_main_context_unref (settings->priv->main_context);
576 g_object_unref (settings->priv->backend);
577 g_settings_schema_unref (settings->priv->schema);
578 g_free (settings->priv->path);
580 G_OBJECT_CLASS (g_settings_parent_class)->finalize (object);
584 g_settings_init (GSettings *settings)
586 settings->priv = G_TYPE_INSTANCE_GET_PRIVATE (settings,
590 settings->priv->main_context = g_main_context_ref_thread_default ();
594 g_settings_class_init (GSettingsClass *class)
596 GObjectClass *object_class = G_OBJECT_CLASS (class);
598 class->writable_change_event = g_settings_real_writable_change_event;
599 class->change_event = g_settings_real_change_event;
601 object_class->set_property = g_settings_set_property;
602 object_class->get_property = g_settings_get_property;
603 object_class->constructed = g_settings_constructed;
604 object_class->finalize = g_settings_finalize;
606 g_type_class_add_private (object_class, sizeof (GSettingsPrivate));
609 * GSettings::changed:
610 * @settings: the object on which the signal was emitted
611 * @key: the name of the key that changed
613 * The "changed" signal is emitted when a key has potentially changed.
614 * You should call one of the g_settings_get() calls to check the new
617 * This signal supports detailed connections. You can connect to the
618 * detailed signal "changed::x" in order to only receive callbacks
619 * when key "x" changes.
621 g_settings_signals[SIGNAL_CHANGED] =
622 g_signal_new ("changed", G_TYPE_SETTINGS,
623 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
624 G_STRUCT_OFFSET (GSettingsClass, changed),
625 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
626 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
629 * GSettings::change-event:
630 * @settings: the object on which the signal was emitted
631 * @keys: (array length=n_keys) (element-type GQuark) (allow-none):
632 * an array of #GQuark<!-- -->s for the changed keys, or %NULL
633 * @n_keys: the length of the @keys array, or 0
634 * @returns: %TRUE to stop other handlers from being invoked for the
635 * event. FALSE to propagate the event further.
637 * The "change-event" signal is emitted once per change event that
638 * affects this settings object. You should connect to this signal
639 * only if you are interested in viewing groups of changes before they
640 * are split out into multiple emissions of the "changed" signal.
641 * For most use cases it is more appropriate to use the "changed" signal.
643 * In the event that the change event applies to one or more specified
644 * keys, @keys will be an array of #GQuark of length @n_keys. In the
645 * event that the change event applies to the #GSettings object as a
646 * whole (ie: potentially every key has been changed) then @keys will
647 * be %NULL and @n_keys will be 0.
649 * The default handler for this signal invokes the "changed" signal
650 * for each affected key. If any other connected handler returns
651 * %TRUE then this default functionality will be suppressed.
653 g_settings_signals[SIGNAL_CHANGE_EVENT] =
654 g_signal_new ("change-event", G_TYPE_SETTINGS,
656 G_STRUCT_OFFSET (GSettingsClass, change_event),
657 g_signal_accumulator_true_handled, NULL,
659 G_TYPE_BOOLEAN, 2, G_TYPE_POINTER, G_TYPE_INT);
662 * GSettings::writable-changed:
663 * @settings: the object on which the signal was emitted
666 * The "writable-changed" signal is emitted when the writability of a
667 * key has potentially changed. You should call
668 * g_settings_is_writable() in order to determine the new status.
670 * This signal supports detailed connections. You can connect to the
671 * detailed signal "writable-changed::x" in order to only receive
672 * callbacks when the writability of "x" changes.
674 g_settings_signals[SIGNAL_WRITABLE_CHANGED] =
675 g_signal_new ("writable-changed", G_TYPE_SETTINGS,
676 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
677 G_STRUCT_OFFSET (GSettingsClass, writable_changed),
678 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
679 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
682 * GSettings::writable-change-event:
683 * @settings: the object on which the signal was emitted
684 * @key: the quark of the key, or 0
685 * @returns: %TRUE to stop other handlers from being invoked for the
686 * event. FALSE to propagate the event further.
688 * The "writable-change-event" signal is emitted once per writability
689 * change event that affects this settings object. You should connect
690 * to this signal if you are interested in viewing groups of changes
691 * before they are split out into multiple emissions of the
692 * "writable-changed" signal. For most use cases it is more
693 * appropriate to use the "writable-changed" signal.
695 * In the event that the writability change applies only to a single
696 * key, @key will be set to the #GQuark for that key. In the event
697 * that the writability change affects the entire settings object,
700 * The default handler for this signal invokes the "writable-changed"
701 * and "changed" signals for each affected key. This is done because
702 * changes in writability might also imply changes in value (if for
703 * example, a new mandatory setting is introduced). If any other
704 * connected handler returns %TRUE then this default functionality
705 * will be suppressed.
707 g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT] =
708 g_signal_new ("writable-change-event", G_TYPE_SETTINGS,
710 G_STRUCT_OFFSET (GSettingsClass, writable_change_event),
711 g_signal_accumulator_true_handled, NULL,
712 NULL, G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
717 * The name of the context that the settings are stored in.
719 g_object_class_install_property (object_class, PROP_BACKEND,
720 g_param_spec_object ("backend",
721 P_("GSettingsBackend"),
722 P_("The GSettingsBackend for this settings object"),
723 G_TYPE_SETTINGS_BACKEND, G_PARAM_CONSTRUCT_ONLY |
724 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
727 * GSettings:settings-schema:
729 * The #GSettingsSchema describing the types of keys for this
732 * Ideally, this property would be called 'schema'. #GSettingsSchema
733 * has only existed since version 2.32, however, and before then the
734 * 'schema' property was used to refer to the ID of the schema rather
735 * than the schema itself. Take care.
737 g_object_class_install_property (object_class, PROP_SCHEMA,
738 g_param_spec_boxed ("settings-schema",
740 P_("The GSettingsSchema for this settings object"),
741 G_TYPE_SETTINGS_SCHEMA,
742 G_PARAM_CONSTRUCT_ONLY |
743 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
748 * The name of the schema that describes the types of keys
749 * for this #GSettings object.
751 * The type of this property is *not* #GSettingsSchema.
752 * #GSettingsSchema has only existed since version 2.32 and
753 * unfortunately this name was used in previous versions to refer to
754 * the schema ID rather than the schema itself. Take care to use the
755 * 'settings-schema' property if you wish to pass in a
758 * Deprecated:2.32:Use the 'schema-id' property instead. In a future
759 * version, this property may instead refer to a #GSettingsSchema.
761 g_object_class_install_property (object_class, PROP_SCHEMA_ID,
762 g_param_spec_string ("schema",
764 P_("The name of the schema for this settings object"),
766 G_PARAM_CONSTRUCT_ONLY |
767 G_PARAM_DEPRECATED | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
770 * GSettings:schema-id:
772 * The name of the schema that describes the types of keys
773 * for this #GSettings object.
775 g_object_class_install_property (object_class, PROP_SCHEMA_ID,
776 g_param_spec_string ("schema-id",
778 P_("The name of the schema for this settings object"),
780 G_PARAM_CONSTRUCT_ONLY |
781 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
786 * The path within the backend where the settings are stored.
788 g_object_class_install_property (object_class, PROP_PATH,
789 g_param_spec_string ("path",
791 P_("The path within the backend where the settings are"),
793 G_PARAM_CONSTRUCT_ONLY |
794 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
797 * GSettings:has-unapplied:
799 * If this property is %TRUE, the #GSettings object has outstanding
800 * changes that will be applied when g_settings_apply() is called.
802 g_object_class_install_property (object_class, PROP_HAS_UNAPPLIED,
803 g_param_spec_boolean ("has-unapplied",
804 P_("Has unapplied changes"),
805 P_("TRUE if there are outstanding changes to apply()"),
807 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
810 * GSettings:delay-apply:
812 * Whether the #GSettings object is in 'delay-apply' mode. See
813 * g_settings_delay() for details.
817 g_object_class_install_property (object_class, PROP_DELAY_APPLY,
818 g_param_spec_boolean ("delay-apply",
819 P_("Delay-apply mode"),
820 P_("Whether this settings object is in 'delay-apply' mode"),
822 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
825 /* Construction (new, new_with_path, etc.) {{{1 */
828 * @schema: the name of the schema
829 * @returns: a new #GSettings object
831 * Creates a new #GSettings object with a given schema.
833 * Signals on the newly created #GSettings object will be dispatched
834 * via the thread-default #GMainContext in effect at the time of the
835 * call to g_settings_new(). The new #GSettings will hold a reference
836 * on the context. See g_main_context_push_thread_default().
841 g_settings_new (const gchar *schema)
843 g_return_val_if_fail (schema != NULL, NULL);
845 return g_object_new (G_TYPE_SETTINGS,
851 * g_settings_new_with_path:
852 * @schema: the name of the schema
853 * @path: the path to use
854 * @returns: a new #GSettings object
856 * Creates a new #GSettings object with a given schema and path.
858 * You only need to do this if you want to directly create a settings
859 * object with a schema that doesn't have a specified path of its own.
862 * It is a programmer error to call this function for a schema that
863 * has an explicitly specified path.
868 g_settings_new_with_path (const gchar *schema,
871 g_return_val_if_fail (schema != NULL, NULL);
872 g_return_val_if_fail (path != NULL, NULL);
874 return g_object_new (G_TYPE_SETTINGS,
881 * g_settings_new_with_backend:
882 * @schema: the name of the schema
883 * @backend: the #GSettingsBackend to use
884 * @returns: a new #GSettings object
886 * Creates a new #GSettings object with a given schema and backend.
888 * Creating a #GSettings object with a different backend allows accessing
889 * settings from a database other than the usual one. For example, it may make
890 * sense to pass a backend corresponding to the "defaults" settings database on
891 * the system to get a settings object that modifies the system default
892 * settings instead of the settings for this user.
897 g_settings_new_with_backend (const gchar *schema,
898 GSettingsBackend *backend)
900 g_return_val_if_fail (schema != NULL, NULL);
901 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
903 return g_object_new (G_TYPE_SETTINGS,
910 * g_settings_new_with_backend_and_path:
911 * @schema: the name of the schema
912 * @backend: the #GSettingsBackend to use
913 * @path: the path to use
914 * @returns: a new #GSettings object
916 * Creates a new #GSettings object with a given schema, backend and
919 * This is a mix of g_settings_new_with_backend() and
920 * g_settings_new_with_path().
925 g_settings_new_with_backend_and_path (const gchar *schema,
926 GSettingsBackend *backend,
929 g_return_val_if_fail (schema != NULL, NULL);
930 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
931 g_return_val_if_fail (path != NULL, NULL);
933 return g_object_new (G_TYPE_SETTINGS,
941 * g_settings_new_full:
942 * @schema: a #GSettingsSchema
943 * @backend: a #GSettingsBackend
944 * @path: the path to use
945 * @returns: a new #GSettings object
947 * Creates a new #GSettings object with a given schema, backend and
950 * It should be extremely rare that you ever want to use this function.
951 * It is made available for advanced use-cases (such as plugin systems
952 * that want to provide access to schemas loaded from custom locations,
955 * At the most basic level, a #GSettings object is a pure composition of
956 * 4 things: a #GSettingsSchema, a #GSettingsBackend, a path within that
957 * backend, and a #GMainContext to which signals are dispatched.
959 * This constructor therefore gives you full control over constructing
960 * #GSettings instances. The first 4 parameters are given directly as
961 * @schema, @backend and @path, and the main context is taken from the
962 * thread-default (as per g_settings_new()).
967 g_settings_new_full (GSettingsSchema *schema,
968 GSettingsBackend *backend,
971 return g_object_new (G_TYPE_SETTINGS,
972 "settings-schema", schema,
977 /* Internal read/write utilities {{{1 */
979 g_settings_write_to_backend (GSettings *settings,
980 GSettingsSchemaKey *key,
986 path = g_strconcat (settings->priv->path, key->name, NULL);
987 success = g_settings_backend_write (settings->priv->backend, path, value, NULL);
994 g_settings_read_from_backend (GSettings *settings,
995 GSettingsSchemaKey *key)
1001 path = g_strconcat (settings->priv->path, key->name, NULL);
1002 value = g_settings_backend_read (settings->priv->backend, path, key->type, FALSE);
1007 fixup = g_settings_schema_key_range_fixup (key, value);
1008 g_variant_unref (value);
1016 /* Public Get/Set API {{{1 (get, get_value, set, set_value, get_mapped) */
1018 * g_settings_get_value:
1019 * @settings: a #GSettings object
1020 * @key: the key to get the value for
1021 * @returns: a new #GVariant
1023 * Gets the value that is stored in @settings for @key.
1025 * It is a programmer error to give a @key that isn't contained in the
1026 * schema for @settings.
1031 g_settings_get_value (GSettings *settings,
1034 GSettingsSchemaKey skey;
1037 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1038 g_return_val_if_fail (key != NULL, NULL);
1040 g_settings_schema_key_init (&skey, settings->priv->schema, key);
1041 value = g_settings_read_from_backend (settings, &skey);
1044 value = g_settings_schema_key_get_translated_default (&skey);
1047 value = g_variant_ref (skey.default_value);
1049 g_settings_schema_key_clear (&skey);
1055 * g_settings_get_enum:
1056 * @settings: a #GSettings object
1057 * @key: the key to get the value for
1058 * @returns: the enum value
1060 * Gets the value that is stored in @settings for @key and converts it
1061 * to the enum value that it represents.
1063 * In order to use this function the type of the value must be a string
1064 * and it must be marked in the schema file as an enumerated type.
1066 * It is a programmer error to give a @key that isn't contained in the
1067 * schema for @settings or is not marked as an enumerated type.
1069 * If the value stored in the configuration database is not a valid
1070 * value for the enumerated type then this function will return the
1076 g_settings_get_enum (GSettings *settings,
1079 GSettingsSchemaKey skey;
1083 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1084 g_return_val_if_fail (key != NULL, -1);
1086 g_settings_schema_key_init (&skey, settings->priv->schema, key);
1090 g_critical ("g_settings_get_enum() called on key `%s' which is not "
1091 "associated with an enumerated type", skey.name);
1092 g_settings_schema_key_clear (&skey);
1096 value = g_settings_read_from_backend (settings, &skey);
1099 value = g_settings_schema_key_get_translated_default (&skey);
1102 value = g_variant_ref (skey.default_value);
1104 result = g_settings_schema_key_to_enum (&skey, value);
1105 g_settings_schema_key_clear (&skey);
1106 g_variant_unref (value);
1112 * g_settings_set_enum:
1113 * @settings: a #GSettings object
1114 * @key: a key, within @settings
1115 * @value: an enumerated value
1116 * @returns: %TRUE, if the set succeeds
1118 * Looks up the enumerated type nick for @value and writes it to @key,
1121 * It is a programmer error to give a @key that isn't contained in the
1122 * schema for @settings or is not marked as an enumerated type, or for
1123 * @value not to be a valid value for the named type.
1125 * After performing the write, accessing @key directly with
1126 * g_settings_get_string() will return the 'nick' associated with
1130 g_settings_set_enum (GSettings *settings,
1134 GSettingsSchemaKey skey;
1138 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1139 g_return_val_if_fail (key != NULL, FALSE);
1141 g_settings_schema_key_init (&skey, settings->priv->schema, key);
1145 g_critical ("g_settings_set_enum() called on key `%s' which is not "
1146 "associated with an enumerated type", skey.name);
1150 if (!(variant = g_settings_schema_key_from_enum (&skey, value)))
1152 g_critical ("g_settings_set_enum(): invalid enum value %d for key `%s' "
1153 "in schema `%s'. Doing nothing.", value, skey.name,
1154 g_settings_schema_get_id (skey.schema));
1155 g_settings_schema_key_clear (&skey);
1159 success = g_settings_write_to_backend (settings, &skey, variant);
1160 g_settings_schema_key_clear (&skey);
1166 * g_settings_get_flags:
1167 * @settings: a #GSettings object
1168 * @key: the key to get the value for
1169 * @returns: the flags value
1171 * Gets the value that is stored in @settings for @key and converts it
1172 * to the flags value that it represents.
1174 * In order to use this function the type of the value must be an array
1175 * of strings and it must be marked in the schema file as an flags type.
1177 * It is a programmer error to give a @key that isn't contained in the
1178 * schema for @settings or is not marked as a flags type.
1180 * If the value stored in the configuration database is not a valid
1181 * value for the flags type then this function will return the default
1187 g_settings_get_flags (GSettings *settings,
1190 GSettingsSchemaKey skey;
1194 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1195 g_return_val_if_fail (key != NULL, -1);
1197 g_settings_schema_key_init (&skey, settings->priv->schema, key);
1201 g_critical ("g_settings_get_flags() called on key `%s' which is not "
1202 "associated with a flags type", skey.name);
1203 g_settings_schema_key_clear (&skey);
1207 value = g_settings_read_from_backend (settings, &skey);
1210 value = g_settings_schema_key_get_translated_default (&skey);
1213 value = g_variant_ref (skey.default_value);
1215 result = g_settings_schema_key_to_flags (&skey, value);
1216 g_settings_schema_key_clear (&skey);
1217 g_variant_unref (value);
1223 * g_settings_set_flags:
1224 * @settings: a #GSettings object
1225 * @key: a key, within @settings
1226 * @value: a flags value
1227 * @returns: %TRUE, if the set succeeds
1229 * Looks up the flags type nicks for the bits specified by @value, puts
1230 * them in an array of strings and writes the array to @key, within
1233 * It is a programmer error to give a @key that isn't contained in the
1234 * schema for @settings or is not marked as a flags type, or for @value
1235 * to contain any bits that are not value for the named type.
1237 * After performing the write, accessing @key directly with
1238 * g_settings_get_strv() will return an array of 'nicks'; one for each
1242 g_settings_set_flags (GSettings *settings,
1246 GSettingsSchemaKey skey;
1250 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1251 g_return_val_if_fail (key != NULL, FALSE);
1253 g_settings_schema_key_init (&skey, settings->priv->schema, key);
1257 g_critical ("g_settings_set_flags() called on key `%s' which is not "
1258 "associated with a flags type", skey.name);
1262 if (!(variant = g_settings_schema_key_from_flags (&skey, value)))
1264 g_critical ("g_settings_set_flags(): invalid flags value 0x%08x "
1265 "for key `%s' in schema `%s'. Doing nothing.",
1266 value, skey.name, g_settings_schema_get_id (skey.schema));
1267 g_settings_schema_key_clear (&skey);
1271 success = g_settings_write_to_backend (settings, &skey, variant);
1272 g_settings_schema_key_clear (&skey);
1278 * g_settings_set_value:
1279 * @settings: a #GSettings object
1280 * @key: the name of the key to set
1281 * @value: a #GVariant of the correct type
1282 * @returns: %TRUE if setting the key succeeded,
1283 * %FALSE if the key was not writable
1285 * Sets @key in @settings to @value.
1287 * It is a programmer error to give a @key that isn't contained in the
1288 * schema for @settings or for @value to have the incorrect type, per
1291 * If @value is floating then this function consumes the reference.
1296 g_settings_set_value (GSettings *settings,
1300 GSettingsSchemaKey skey;
1302 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1303 g_return_val_if_fail (key != NULL, FALSE);
1305 g_settings_schema_key_init (&skey, settings->priv->schema, key);
1307 if (!g_settings_schema_key_type_check (&skey, value))
1309 g_critical ("g_settings_set_value: key '%s' in '%s' expects type '%s', but a GVariant of type '%s' was given",
1311 g_settings_schema_get_id (settings->priv->schema),
1312 g_variant_type_peek_string (skey.type),
1313 g_variant_get_type_string (value));
1318 if (!g_settings_schema_key_range_check (&skey, value))
1320 g_warning ("g_settings_set_value: value for key '%s' in schema '%s' "
1321 "is outside of valid range",
1323 g_settings_schema_get_id (settings->priv->schema));
1328 g_settings_schema_key_clear (&skey);
1330 return g_settings_write_to_backend (settings, &skey, value);
1335 * @settings: a #GSettings object
1336 * @key: the key to get the value for
1337 * @format: a #GVariant format string
1338 * @...: arguments as per @format
1340 * Gets the value that is stored at @key in @settings.
1342 * A convenience function that combines g_settings_get_value() with
1345 * It is a programmer error to give a @key that isn't contained in the
1346 * schema for @settings or for the #GVariantType of @format to mismatch
1347 * the type given in the schema.
1352 g_settings_get (GSettings *settings,
1354 const gchar *format,
1360 value = g_settings_get_value (settings, key);
1362 va_start (ap, format);
1363 g_variant_get_va (value, format, NULL, &ap);
1366 g_variant_unref (value);
1371 * @settings: a #GSettings object
1372 * @key: the name of the key to set
1373 * @format: a #GVariant format string
1374 * @...: arguments as per @format
1375 * @returns: %TRUE if setting the key succeeded,
1376 * %FALSE if the key was not writable
1378 * Sets @key in @settings to @value.
1380 * A convenience function that combines g_settings_set_value() with
1383 * It is a programmer error to give a @key that isn't contained in the
1384 * schema for @settings or for the #GVariantType of @format to mismatch
1385 * the type given in the schema.
1390 g_settings_set (GSettings *settings,
1392 const gchar *format,
1398 va_start (ap, format);
1399 value = g_variant_new_va (format, NULL, &ap);
1402 return g_settings_set_value (settings, key, value);
1406 * g_settings_get_mapped:
1407 * @settings: a #GSettings object
1408 * @key: the key to get the value for
1409 * @mapping: (scope call): the function to map the value in the
1410 * settings database to the value used by the application
1411 * @user_data: user data for @mapping
1412 * @returns: (transfer full): the result, which may be %NULL
1414 * Gets the value that is stored at @key in @settings, subject to
1415 * application-level validation/mapping.
1417 * You should use this function when the application needs to perform
1418 * some processing on the value of the key (for example, parsing). The
1419 * @mapping function performs that processing. If the function
1420 * indicates that the processing was unsuccessful (due to a parse error,
1421 * for example) then the mapping is tried again with another value.
1423 * This allows a robust 'fall back to defaults' behaviour to be
1424 * implemented somewhat automatically.
1426 * The first value that is tried is the user's setting for the key. If
1427 * the mapping function fails to map this value, other values may be
1428 * tried in an unspecified order (system or site defaults, translated
1429 * schema default values, untranslated schema default values, etc).
1431 * If the mapping function fails for all possible values, one additional
1432 * attempt is made: the mapping function is called with a %NULL value.
1433 * If the mapping function still indicates failure at this point then
1434 * the application will be aborted.
1436 * The result parameter for the @mapping function is pointed to a
1437 * #gpointer which is initially set to %NULL. The same pointer is given
1438 * to each invocation of @mapping. The final value of that #gpointer is
1439 * what is returned by this function. %NULL is valid; it is returned
1440 * just as any other value would be.
1443 g_settings_get_mapped (GSettings *settings,
1445 GSettingsGetMapping mapping,
1448 gpointer result = NULL;
1449 GSettingsSchemaKey skey;
1453 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1454 g_return_val_if_fail (key != NULL, NULL);
1455 g_return_val_if_fail (mapping != NULL, NULL);
1457 g_settings_schema_key_init (&skey, settings->priv->schema, key);
1459 if ((value = g_settings_read_from_backend (settings, &skey)))
1461 okay = mapping (value, &result, user_data);
1462 g_variant_unref (value);
1463 if (okay) goto okay;
1466 if ((value = g_settings_schema_key_get_translated_default (&skey)))
1468 okay = mapping (value, &result, user_data);
1469 g_variant_unref (value);
1470 if (okay) goto okay;
1473 if (mapping (skey.default_value, &result, user_data))
1476 if (!mapping (NULL, &result, user_data))
1477 g_error ("The mapping function given to g_settings_get_mapped() for key "
1478 "`%s' in schema `%s' returned FALSE when given a NULL value.",
1479 key, g_settings_schema_get_id (settings->priv->schema));
1482 g_settings_schema_key_clear (&skey);
1487 /* Convenience API (get, set_string, int, double, boolean, strv) {{{1 */
1489 * g_settings_get_string:
1490 * @settings: a #GSettings object
1491 * @key: the key to get the value for
1492 * @returns: a newly-allocated string
1494 * Gets the value that is stored at @key in @settings.
1496 * A convenience variant of g_settings_get() for strings.
1498 * It is a programmer error to give a @key that isn't specified as
1499 * having a string type in the schema for @settings.
1504 g_settings_get_string (GSettings *settings,
1510 value = g_settings_get_value (settings, key);
1511 result = g_variant_dup_string (value, NULL);
1512 g_variant_unref (value);
1518 * g_settings_set_string:
1519 * @settings: a #GSettings object
1520 * @key: the name of the key to set
1521 * @value: the value to set it to
1522 * @returns: %TRUE if setting the key succeeded,
1523 * %FALSE if the key was not writable
1525 * Sets @key in @settings to @value.
1527 * A convenience variant of g_settings_set() for strings.
1529 * It is a programmer error to give a @key that isn't specified as
1530 * having a string type in the schema for @settings.
1535 g_settings_set_string (GSettings *settings,
1539 return g_settings_set_value (settings, key, g_variant_new_string (value));
1543 * g_settings_get_int:
1544 * @settings: a #GSettings object
1545 * @key: the key to get the value for
1546 * @returns: an integer
1548 * Gets the value that is stored at @key in @settings.
1550 * A convenience variant of g_settings_get() for 32-bit integers.
1552 * It is a programmer error to give a @key that isn't specified as
1553 * having a int32 type in the schema for @settings.
1558 g_settings_get_int (GSettings *settings,
1564 value = g_settings_get_value (settings, key);
1565 result = g_variant_get_int32 (value);
1566 g_variant_unref (value);
1572 * g_settings_set_int:
1573 * @settings: a #GSettings object
1574 * @key: the name of the key to set
1575 * @value: the value to set it to
1576 * @returns: %TRUE if setting the key succeeded,
1577 * %FALSE if the key was not writable
1579 * Sets @key in @settings to @value.
1581 * A convenience variant of g_settings_set() for 32-bit integers.
1583 * It is a programmer error to give a @key that isn't specified as
1584 * having a int32 type in the schema for @settings.
1589 g_settings_set_int (GSettings *settings,
1593 return g_settings_set_value (settings, key, g_variant_new_int32 (value));
1597 * g_settings_get_uint:
1598 * @settings: a #GSettings object
1599 * @key: the key to get the value for
1600 * @returns: an unsigned integer
1602 * Gets the value that is stored at @key in @settings.
1604 * A convenience variant of g_settings_get() for 32-bit unsigned
1607 * It is a programmer error to give a @key that isn't specified as
1608 * having a uint32 type in the schema for @settings.
1613 g_settings_get_uint (GSettings *settings,
1619 value = g_settings_get_value (settings, key);
1620 result = g_variant_get_uint32 (value);
1621 g_variant_unref (value);
1627 * g_settings_set_uint:
1628 * @settings: a #GSettings object
1629 * @key: the name of the key to set
1630 * @value: the value to set it to
1631 * @returns: %TRUE if setting the key succeeded,
1632 * %FALSE if the key was not writable
1634 * Sets @key in @settings to @value.
1636 * A convenience variant of g_settings_set() for 32-bit unsigned
1639 * It is a programmer error to give a @key that isn't specified as
1640 * having a uint32 type in the schema for @settings.
1645 g_settings_set_uint (GSettings *settings,
1649 return g_settings_set_value (settings, key, g_variant_new_uint32 (value));
1653 * g_settings_get_double:
1654 * @settings: a #GSettings object
1655 * @key: the key to get the value for
1656 * @returns: a double
1658 * Gets the value that is stored at @key in @settings.
1660 * A convenience variant of g_settings_get() for doubles.
1662 * It is a programmer error to give a @key that isn't specified as
1663 * having a 'double' type in the schema for @settings.
1668 g_settings_get_double (GSettings *settings,
1674 value = g_settings_get_value (settings, key);
1675 result = g_variant_get_double (value);
1676 g_variant_unref (value);
1682 * g_settings_set_double:
1683 * @settings: a #GSettings object
1684 * @key: the name of the key to set
1685 * @value: the value to set it to
1686 * @returns: %TRUE if setting the key succeeded,
1687 * %FALSE if the key was not writable
1689 * Sets @key in @settings to @value.
1691 * A convenience variant of g_settings_set() for doubles.
1693 * It is a programmer error to give a @key that isn't specified as
1694 * having a 'double' type in the schema for @settings.
1699 g_settings_set_double (GSettings *settings,
1703 return g_settings_set_value (settings, key, g_variant_new_double (value));
1707 * g_settings_get_boolean:
1708 * @settings: a #GSettings object
1709 * @key: the key to get the value for
1710 * @returns: a boolean
1712 * Gets the value that is stored at @key in @settings.
1714 * A convenience variant of g_settings_get() for booleans.
1716 * It is a programmer error to give a @key that isn't specified as
1717 * having a boolean type in the schema for @settings.
1722 g_settings_get_boolean (GSettings *settings,
1728 value = g_settings_get_value (settings, key);
1729 result = g_variant_get_boolean (value);
1730 g_variant_unref (value);
1736 * g_settings_set_boolean:
1737 * @settings: a #GSettings object
1738 * @key: the name of the key to set
1739 * @value: the value to set it to
1740 * @returns: %TRUE if setting the key succeeded,
1741 * %FALSE if the key was not writable
1743 * Sets @key in @settings to @value.
1745 * A convenience variant of g_settings_set() for booleans.
1747 * It is a programmer error to give a @key that isn't specified as
1748 * having a boolean type in the schema for @settings.
1753 g_settings_set_boolean (GSettings *settings,
1757 return g_settings_set_value (settings, key, g_variant_new_boolean (value));
1761 * g_settings_get_strv:
1762 * @settings: a #GSettings object
1763 * @key: the key to get the value for
1764 * @returns: (array zero-terminated=1) (transfer full): a
1765 * newly-allocated, %NULL-terminated array of strings, the value that
1766 * is stored at @key in @settings.
1768 * A convenience variant of g_settings_get() for string arrays.
1770 * It is a programmer error to give a @key that isn't specified as
1771 * having an array of strings type in the schema for @settings.
1776 g_settings_get_strv (GSettings *settings,
1782 value = g_settings_get_value (settings, key);
1783 result = g_variant_dup_strv (value, NULL);
1784 g_variant_unref (value);
1790 * g_settings_set_strv:
1791 * @settings: a #GSettings object
1792 * @key: the name of the key to set
1793 * @value: (allow-none) (array zero-terminated=1): the value to set it to, or %NULL
1794 * @returns: %TRUE if setting the key succeeded,
1795 * %FALSE if the key was not writable
1797 * Sets @key in @settings to @value.
1799 * A convenience variant of g_settings_set() for string arrays. If
1800 * @value is %NULL, then @key is set to be the empty array.
1802 * It is a programmer error to give a @key that isn't specified as
1803 * having an array of strings type in the schema for @settings.
1808 g_settings_set_strv (GSettings *settings,
1810 const gchar * const *value)
1815 array = g_variant_new_strv (value, -1);
1817 array = g_variant_new_strv (NULL, 0);
1819 return g_settings_set_value (settings, key, array);
1822 /* Delayed apply (delay, apply, revert, get_has_unapplied) {{{1 */
1825 * @settings: a #GSettings object
1827 * Changes the #GSettings object into 'delay-apply' mode. In this
1828 * mode, changes to @settings are not immediately propagated to the
1829 * backend, but kept locally until g_settings_apply() is called.
1834 g_settings_delay (GSettings *settings)
1836 g_return_if_fail (G_IS_SETTINGS (settings));
1838 if (settings->priv->delayed)
1841 settings->priv->delayed =
1842 g_delayed_settings_backend_new (settings->priv->backend,
1844 settings->priv->main_context);
1845 g_settings_backend_unwatch (settings->priv->backend, G_OBJECT (settings));
1846 g_object_unref (settings->priv->backend);
1848 settings->priv->backend = G_SETTINGS_BACKEND (settings->priv->delayed);
1849 g_settings_backend_watch (settings->priv->backend,
1850 &listener_vtable, G_OBJECT (settings),
1851 settings->priv->main_context);
1853 g_object_notify (G_OBJECT (settings), "delay-apply");
1858 * @settings: a #GSettings instance
1860 * Applies any changes that have been made to the settings. This
1861 * function does nothing unless @settings is in 'delay-apply' mode;
1862 * see g_settings_delay(). In the normal case settings are always
1863 * applied immediately.
1866 g_settings_apply (GSettings *settings)
1868 if (settings->priv->delayed)
1870 GDelayedSettingsBackend *delayed;
1872 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
1873 g_delayed_settings_backend_apply (delayed);
1878 * g_settings_revert:
1879 * @settings: a #GSettings instance
1881 * Reverts all non-applied changes to the settings. This function
1882 * does nothing unless @settings is in 'delay-apply' mode; see
1883 * g_settings_delay(). In the normal case settings are always applied
1886 * Change notifications will be emitted for affected keys.
1889 g_settings_revert (GSettings *settings)
1891 if (settings->priv->delayed)
1893 GDelayedSettingsBackend *delayed;
1895 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
1896 g_delayed_settings_backend_revert (delayed);
1901 * g_settings_get_has_unapplied:
1902 * @settings: a #GSettings object
1903 * @returns: %TRUE if @settings has unapplied changes
1905 * Returns whether the #GSettings object has any unapplied
1906 * changes. This can only be the case if it is in 'delayed-apply' mode.
1911 g_settings_get_has_unapplied (GSettings *settings)
1913 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1915 return settings->priv->delayed &&
1916 g_delayed_settings_backend_get_has_unapplied (
1917 G_DELAYED_SETTINGS_BACKEND (settings->priv->backend));
1920 /* Extra API (reset, sync, get_child, is_writable, list_*, ranges) {{{1 */
1923 * @settings: a #GSettings object
1924 * @key: the name of a key
1926 * Resets @key to its default value.
1928 * This call resets the key, as much as possible, to its default value.
1929 * That might the value specified in the schema or the one set by the
1933 g_settings_reset (GSettings *settings,
1938 path = g_strconcat (settings->priv->path, key, NULL);
1939 g_settings_backend_reset (settings->priv->backend, path, NULL);
1946 * Ensures that all pending operations for the given are complete for
1947 * the default backend.
1949 * Writes made to a #GSettings are handled asynchronously. For this
1950 * reason, it is very unlikely that the changes have it to disk by the
1951 * time g_settings_set() returns.
1953 * This call will block until all of the writes have made it to the
1954 * backend. Since the mainloop is not running, no change notifications
1955 * will be dispatched during this call (but some may be queued by the
1956 * time the call is done).
1959 g_settings_sync (void)
1961 g_settings_backend_sync_default ();
1965 * g_settings_is_writable:
1966 * @settings: a #GSettings object
1967 * @name: the name of a key
1968 * @returns: %TRUE if the key @name is writable
1970 * Finds out if a key can be written or not
1975 g_settings_is_writable (GSettings *settings,
1981 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1983 path = g_strconcat (settings->priv->path, name, NULL);
1984 writable = g_settings_backend_get_writable (settings->priv->backend, path);
1991 * g_settings_get_child:
1992 * @settings: a #GSettings object
1993 * @name: the name of the 'child' schema
1994 * @returns: (transfer full): a 'child' settings object
1996 * Creates a 'child' settings object which has a base path of
1997 * <replaceable>base-path</replaceable>/@name, where
1998 * <replaceable>base-path</replaceable> is the base path of @settings.
2000 * The schema for the child settings object must have been declared
2001 * in the schema of @settings using a <tag class="starttag">child</tag> element.
2006 g_settings_get_child (GSettings *settings,
2009 const gchar *child_schema;
2014 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
2016 child_name = g_strconcat (name, "/", NULL);
2017 child_schema = g_settings_schema_get_string (settings->priv->schema,
2019 if (child_schema == NULL)
2020 g_error ("Schema '%s' has no child '%s'",
2021 g_settings_schema_get_id (settings->priv->schema), name);
2023 child_path = g_strconcat (settings->priv->path, child_name, NULL);
2024 child = g_object_new (G_TYPE_SETTINGS,
2025 "schema-id", child_schema,
2028 g_free (child_path);
2029 g_free (child_name);
2035 * g_settings_list_keys:
2036 * @settings: a #GSettings object
2037 * @returns: (transfer full) (element-type utf8): a list of the keys on @settings
2039 * Introspects the list of keys on @settings.
2041 * You should probably not be calling this function from "normal" code
2042 * (since you should already know what keys are in your schema). This
2043 * function is intended for introspection reasons.
2045 * You should free the return value with g_strfreev() when you are done
2049 g_settings_list_keys (GSettings *settings)
2056 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2057 strv = g_new (gchar *, n_keys + 1);
2058 for (i = j = 0; i < n_keys; i++)
2060 const gchar *key = g_quark_to_string (keys[i]);
2062 if (!g_str_has_suffix (key, "/"))
2063 strv[j++] = g_strdup (key);
2071 * g_settings_list_children:
2072 * @settings: a #GSettings object
2073 * @returns: (transfer full) (element-type utf8): a list of the children on @settings
2075 * Gets the list of children on @settings.
2077 * The list is exactly the list of strings for which it is not an error
2078 * to call g_settings_get_child().
2080 * For GSettings objects that are lists, this value can change at any
2081 * time and you should connect to the "children-changed" signal to watch
2082 * for those changes. Note that there is a race condition here: you may
2083 * request a child after listing it only for it to have been destroyed
2084 * in the meantime. For this reason, g_settings_get_child() may return
2085 * %NULL even for a child that was listed by this function.
2087 * For GSettings objects that are not lists, you should probably not be
2088 * calling this function from "normal" code (since you should already
2089 * know what children are in your schema). This function may still be
2090 * useful there for introspection reasons, however.
2092 * You should free the return value with g_strfreev() when you are done
2096 g_settings_list_children (GSettings *settings)
2103 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2104 strv = g_new (gchar *, n_keys + 1);
2105 for (i = j = 0; i < n_keys; i++)
2107 const gchar *key = g_quark_to_string (keys[i]);
2109 if (g_str_has_suffix (key, "/"))
2111 gint length = strlen (key);
2113 strv[j] = g_memdup (key, length);
2114 strv[j][length - 1] = '\0';
2124 * g_settings_get_range:
2125 * @settings: a #GSettings
2126 * @key: the key to query the range of
2127 * @returns: a #GVariant describing the range
2129 * Queries the range of a key.
2131 * This function will return a #GVariant that fully describes the range
2132 * of values that are valid for @key.
2134 * The type of #GVariant returned is <literal>(sv)</literal>. The
2135 * string describes the type of range restriction in effect. The type
2136 * and meaning of the value contained in the variant depends on the
2139 * If the string is <literal>'type'</literal> then the variant contains
2140 * an empty array. The element type of that empty array is the expected
2141 * type of value and all values of that type are valid.
2143 * If the string is <literal>'enum'</literal> then the variant contains
2144 * an array enumerating the possible values. Each item in the array is
2145 * a possible valid value and no other values are valid.
2147 * If the string is <literal>'flags'</literal> then the variant contains
2148 * an array. Each item in the array is a value that may appear zero or
2149 * one times in an array to be used as the value for this key. For
2150 * example, if the variant contained the array <literal>['x',
2151 * 'y']</literal> then the valid values for the key would be
2152 * <literal>[]</literal>, <literal>['x']</literal>,
2153 * <literal>['y']</literal>, <literal>['x', 'y']</literal> and
2154 * <literal>['y', 'x']</literal>.
2156 * Finally, if the string is <literal>'range'</literal> then the variant
2157 * contains a pair of like-typed values -- the minimum and maximum
2158 * permissible values for this key.
2160 * This information should not be used by normal programs. It is
2161 * considered to be a hint for introspection purposes. Normal programs
2162 * should already know what is permitted by their own schema. The
2163 * format may change in any way in the future -- but particularly, new
2164 * forms may be added to the possibilities described above.
2166 * It is a programmer error to give a @key that isn't contained in the
2167 * schema for @settings.
2169 * You should free the returned value with g_variant_unref() when it is
2175 g_settings_get_range (GSettings *settings,
2178 GSettingsSchemaKey skey;
2182 g_settings_schema_key_init (&skey, settings->priv->schema, key);
2186 range = g_variant_new ("(**)", skey.minimum, skey.maximum);
2189 else if (skey.strinfo)
2191 range = strinfo_enumerate (skey.strinfo, skey.strinfo_length);
2192 type = skey.is_flags ? "flags" : "enum";
2196 range = g_variant_new_array (skey.type, NULL, 0);
2200 g_settings_schema_key_clear (&skey);
2202 return g_variant_ref_sink (g_variant_new ("(sv)", type, range));
2206 * g_settings_range_check:
2207 * @settings: a #GSettings
2208 * @key: the key to check
2209 * @value: the value to check
2210 * @returns: %TRUE if @value is valid for @key
2212 * Checks if the given @value is of the correct type and within the
2213 * permitted range for @key.
2215 * This API is not intended to be used by normal programs -- they should
2216 * already know what is permitted by their own schemas. This API is
2217 * meant to be used by programs such as editors or commandline tools.
2219 * It is a programmer error to give a @key that isn't contained in the
2220 * schema for @settings.
2225 g_settings_range_check (GSettings *settings,
2229 GSettingsSchemaKey skey;
2232 g_settings_schema_key_init (&skey, settings->priv->schema, key);
2233 good = g_settings_schema_key_type_check (&skey, value) &&
2234 g_settings_schema_key_range_check (&skey, value);
2235 g_settings_schema_key_clear (&skey);
2243 GSettingsSchemaKey key;
2244 GSettings *settings;
2247 GSettingsBindGetMapping get_mapping;
2248 GSettingsBindSetMapping set_mapping;
2250 GDestroyNotify destroy;
2252 guint writable_handler_id;
2253 guint property_handler_id;
2254 const GParamSpec *property;
2255 guint key_handler_id;
2257 /* prevent recursion */
2262 g_settings_binding_free (gpointer data)
2264 GSettingsBinding *binding = data;
2266 g_assert (!binding->running);
2268 if (binding->writable_handler_id)
2269 g_signal_handler_disconnect (binding->settings,
2270 binding->writable_handler_id);
2272 if (binding->key_handler_id)
2273 g_signal_handler_disconnect (binding->settings,
2274 binding->key_handler_id);
2276 if (g_signal_handler_is_connected (binding->object,
2277 binding->property_handler_id))
2278 g_signal_handler_disconnect (binding->object,
2279 binding->property_handler_id);
2281 g_settings_schema_key_clear (&binding->key);
2283 if (binding->destroy)
2284 binding->destroy (binding->user_data);
2286 g_object_unref (binding->settings);
2288 g_slice_free (GSettingsBinding, binding);
2292 g_settings_binding_quark (const char *property)
2297 tmp = g_strdup_printf ("gsettingsbinding-%s", property);
2298 quark = g_quark_from_string (tmp);
2305 g_settings_binding_key_changed (GSettings *settings,
2309 GSettingsBinding *binding = user_data;
2310 GValue value = G_VALUE_INIT;
2313 g_assert (settings == binding->settings);
2314 g_assert (key == binding->key.name);
2316 if (binding->running)
2319 binding->running = TRUE;
2321 g_value_init (&value, binding->property->value_type);
2323 variant = g_settings_read_from_backend (binding->settings, &binding->key);
2324 if (variant && !binding->get_mapping (&value, variant, binding->user_data))
2326 /* silently ignore errors in the user's config database */
2327 g_variant_unref (variant);
2331 if (variant == NULL)
2333 variant = g_settings_schema_key_get_translated_default (&binding->key);
2335 !binding->get_mapping (&value, variant, binding->user_data))
2337 /* flag translation errors with a warning */
2338 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
2339 "was rejected by the binding mapping function",
2340 binding->key.unparsed, binding->key.name,
2341 g_settings_schema_get_id (binding->key.schema));
2342 g_variant_unref (variant);
2347 if (variant == NULL)
2349 variant = g_variant_ref (binding->key.default_value);
2350 if (!binding->get_mapping (&value, variant, binding->user_data))
2351 g_error ("The schema default value for key `%s' in schema `%s' "
2352 "was rejected by the binding mapping function.",
2353 binding->key.name, g_settings_schema_get_id (binding->key.schema));
2356 g_object_set_property (binding->object, binding->property->name, &value);
2357 g_variant_unref (variant);
2358 g_value_unset (&value);
2360 binding->running = FALSE;
2364 g_settings_binding_property_changed (GObject *object,
2365 const GParamSpec *pspec,
2368 GSettingsBinding *binding = user_data;
2369 GValue value = G_VALUE_INIT;
2372 g_assert (object == binding->object);
2373 g_assert (pspec == binding->property);
2375 if (binding->running)
2378 binding->running = TRUE;
2380 g_value_init (&value, pspec->value_type);
2381 g_object_get_property (object, pspec->name, &value);
2382 if ((variant = binding->set_mapping (&value, binding->key.type,
2383 binding->user_data)))
2385 g_variant_take_ref (variant);
2387 if (!g_settings_schema_key_type_check (&binding->key, variant))
2389 g_critical ("binding mapping function for key `%s' returned "
2390 "GVariant of type `%s' when type `%s' was requested",
2391 binding->key.name, g_variant_get_type_string (variant),
2392 g_variant_type_dup_string (binding->key.type));
2396 if (!g_settings_schema_key_range_check (&binding->key, variant))
2398 g_critical ("GObject property `%s' on a `%s' object is out of "
2399 "schema-specified range for key `%s' of `%s': %s",
2400 binding->property->name, g_type_name (binding->property->owner_type),
2401 binding->key.name, g_settings_schema_get_id (binding->key.schema),
2402 g_variant_print (variant, TRUE));
2406 g_settings_write_to_backend (binding->settings, &binding->key, variant);
2407 g_variant_unref (variant);
2409 g_value_unset (&value);
2411 binding->running = FALSE;
2415 g_settings_bind_invert_boolean_get_mapping (GValue *value,
2419 g_value_set_boolean (value, !g_variant_get_boolean (variant));
2424 g_settings_bind_invert_boolean_set_mapping (const GValue *value,
2425 const GVariantType *expected_type,
2428 return g_variant_new_boolean (!g_value_get_boolean (value));
2433 * @settings: a #GSettings object
2434 * @key: the key to bind
2435 * @object: (type GObject.Object): a #GObject
2436 * @property: the name of the property to bind
2437 * @flags: flags for the binding
2439 * Create a binding between the @key in the @settings object
2440 * and the property @property of @object.
2442 * The binding uses the default GIO mapping functions to map
2443 * between the settings and property values. These functions
2444 * handle booleans, numeric types and string types in a
2445 * straightforward way. Use g_settings_bind_with_mapping() if
2446 * you need a custom mapping, or map between types that are not
2447 * supported by the default mapping functions.
2449 * Unless the @flags include %G_SETTINGS_BIND_NO_SENSITIVITY, this
2450 * function also establishes a binding between the writability of
2451 * @key and the "sensitive" property of @object (if @object has
2452 * a boolean property by that name). See g_settings_bind_writable()
2453 * for more details about writable bindings.
2455 * Note that the lifecycle of the binding is tied to the object,
2456 * and that you can have only one binding per object property.
2457 * If you bind the same property twice on the same object, the second
2458 * binding overrides the first one.
2463 g_settings_bind (GSettings *settings,
2466 const gchar *property,
2467 GSettingsBindFlags flags)
2469 GSettingsBindGetMapping get_mapping = NULL;
2470 GSettingsBindSetMapping set_mapping = NULL;
2472 if (flags & G_SETTINGS_BIND_INVERT_BOOLEAN)
2474 get_mapping = g_settings_bind_invert_boolean_get_mapping;
2475 set_mapping = g_settings_bind_invert_boolean_set_mapping;
2477 /* can't pass this flag to g_settings_bind_with_mapping() */
2478 flags &= ~G_SETTINGS_BIND_INVERT_BOOLEAN;
2481 g_settings_bind_with_mapping (settings, key, object, property, flags,
2482 get_mapping, set_mapping, NULL, NULL);
2486 * g_settings_bind_with_mapping: (skip)
2487 * @settings: a #GSettings object
2488 * @key: the key to bind
2489 * @object: (type GObject.Object): a #GObject
2490 * @property: the name of the property to bind
2491 * @flags: flags for the binding
2492 * @get_mapping: a function that gets called to convert values
2493 * from @settings to @object, or %NULL to use the default GIO mapping
2494 * @set_mapping: a function that gets called to convert values
2495 * from @object to @settings, or %NULL to use the default GIO mapping
2496 * @user_data: data that gets passed to @get_mapping and @set_mapping
2497 * @destroy: #GDestroyNotify function for @user_data
2499 * Create a binding between the @key in the @settings object
2500 * and the property @property of @object.
2502 * The binding uses the provided mapping functions to map between
2503 * settings and property values.
2505 * Note that the lifecycle of the binding is tied to the object,
2506 * and that you can have only one binding per object property.
2507 * If you bind the same property twice on the same object, the second
2508 * binding overrides the first one.
2513 g_settings_bind_with_mapping (GSettings *settings,
2516 const gchar *property,
2517 GSettingsBindFlags flags,
2518 GSettingsBindGetMapping get_mapping,
2519 GSettingsBindSetMapping set_mapping,
2521 GDestroyNotify destroy)
2523 GSettingsBinding *binding;
2524 GObjectClass *objectclass;
2525 gchar *detailed_signal;
2526 GQuark binding_quark;
2528 g_return_if_fail (G_IS_SETTINGS (settings));
2529 g_return_if_fail (key != NULL);
2530 g_return_if_fail (G_IS_OBJECT (object));
2531 g_return_if_fail (property != NULL);
2532 g_return_if_fail (~flags & G_SETTINGS_BIND_INVERT_BOOLEAN);
2534 objectclass = G_OBJECT_GET_CLASS (object);
2536 binding = g_slice_new0 (GSettingsBinding);
2537 g_settings_schema_key_init (&binding->key, settings->priv->schema, key);
2538 binding->settings = g_object_ref (settings);
2539 binding->object = object;
2540 binding->property = g_object_class_find_property (objectclass, property);
2541 binding->user_data = user_data;
2542 binding->destroy = destroy;
2543 binding->get_mapping = get_mapping ? get_mapping : g_settings_get_mapping;
2544 binding->set_mapping = set_mapping ? set_mapping : g_settings_set_mapping;
2546 if (!(flags & (G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET)))
2547 flags |= G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET;
2549 if (binding->property == NULL)
2551 g_critical ("g_settings_bind: no property '%s' on class '%s'",
2552 property, G_OBJECT_TYPE_NAME (object));
2556 if ((flags & G_SETTINGS_BIND_GET) &&
2557 (binding->property->flags & G_PARAM_WRITABLE) == 0)
2559 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2560 "writable", property, G_OBJECT_TYPE_NAME (object));
2563 if ((flags & G_SETTINGS_BIND_SET) &&
2564 (binding->property->flags & G_PARAM_READABLE) == 0)
2566 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2567 "readable", property, G_OBJECT_TYPE_NAME (object));
2571 if (get_mapping == g_settings_bind_invert_boolean_get_mapping)
2573 /* g_settings_bind_invert_boolean_get_mapping() is a private
2574 * function, so if we are here it means that g_settings_bind() was
2575 * called with G_SETTINGS_BIND_INVERT_BOOLEAN.
2577 * Ensure that both sides are boolean.
2580 if (binding->property->value_type != G_TYPE_BOOLEAN)
2582 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2583 "was specified, but property `%s' on type `%s' has "
2584 "type `%s'", property, G_OBJECT_TYPE_NAME (object),
2585 g_type_name ((binding->property->value_type)));
2589 if (!g_variant_type_equal (binding->key.type, G_VARIANT_TYPE_BOOLEAN))
2591 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2592 "was specified, but key `%s' on schema `%s' has "
2593 "type `%s'", key, g_settings_schema_get_id (settings->priv->schema),
2594 g_variant_type_dup_string (binding->key.type));
2600 else if (((get_mapping == NULL && (flags & G_SETTINGS_BIND_GET)) ||
2601 (set_mapping == NULL && (flags & G_SETTINGS_BIND_SET))) &&
2602 !g_settings_mapping_is_compatible (binding->property->value_type,
2605 g_critical ("g_settings_bind: property '%s' on class '%s' has type "
2606 "'%s' which is not compatible with type '%s' of key '%s' "
2607 "on schema '%s'", property, G_OBJECT_TYPE_NAME (object),
2608 g_type_name (binding->property->value_type),
2609 g_variant_type_dup_string (binding->key.type), key,
2610 g_settings_schema_get_id (settings->priv->schema));
2614 if ((flags & G_SETTINGS_BIND_SET) &&
2615 (~flags & G_SETTINGS_BIND_NO_SENSITIVITY))
2617 GParamSpec *sensitive;
2619 sensitive = g_object_class_find_property (objectclass, "sensitive");
2621 if (sensitive && sensitive->value_type == G_TYPE_BOOLEAN &&
2622 (sensitive->flags & G_PARAM_WRITABLE))
2623 g_settings_bind_writable (settings, binding->key.name, object, "sensitive", FALSE);
2626 if (flags & G_SETTINGS_BIND_SET)
2628 detailed_signal = g_strdup_printf ("notify::%s", property);
2629 binding->property_handler_id =
2630 g_signal_connect (object, detailed_signal,
2631 G_CALLBACK (g_settings_binding_property_changed),
2633 g_free (detailed_signal);
2635 if (~flags & G_SETTINGS_BIND_GET)
2636 g_settings_binding_property_changed (object,
2641 if (flags & G_SETTINGS_BIND_GET)
2643 if (~flags & G_SETTINGS_BIND_GET_NO_CHANGES)
2645 detailed_signal = g_strdup_printf ("changed::%s", key);
2646 binding->key_handler_id =
2647 g_signal_connect (settings, detailed_signal,
2648 G_CALLBACK (g_settings_binding_key_changed),
2650 g_free (detailed_signal);
2653 g_settings_binding_key_changed (settings, binding->key.name, binding);
2656 binding_quark = g_settings_binding_quark (property);
2657 g_object_set_qdata_full (object, binding_quark,
2658 binding, g_settings_binding_free);
2661 /* Writability binding {{{1 */
2664 GSettings *settings;
2667 const gchar *property;
2670 } GSettingsWritableBinding;
2673 g_settings_writable_binding_free (gpointer data)
2675 GSettingsWritableBinding *binding = data;
2677 g_signal_handler_disconnect (binding->settings, binding->handler_id);
2678 g_object_unref (binding->settings);
2679 g_slice_free (GSettingsWritableBinding, binding);
2683 g_settings_binding_writable_changed (GSettings *settings,
2687 GSettingsWritableBinding *binding = user_data;
2690 g_assert (settings == binding->settings);
2691 g_assert (key == binding->key);
2693 writable = g_settings_is_writable (settings, key);
2695 if (binding->inverted)
2696 writable = !writable;
2698 g_object_set (binding->object, binding->property, writable, NULL);
2702 * g_settings_bind_writable:
2703 * @settings: a #GSettings object
2704 * @key: the key to bind
2705 * @object: (type GObject.Object):a #GObject
2706 * @property: the name of a boolean property to bind
2707 * @inverted: whether to 'invert' the value
2709 * Create a binding between the writability of @key in the
2710 * @settings object and the property @property of @object.
2711 * The property must be boolean; "sensitive" or "visible"
2712 * properties of widgets are the most likely candidates.
2714 * Writable bindings are always uni-directional; changes of the
2715 * writability of the setting will be propagated to the object
2716 * property, not the other way.
2718 * When the @inverted argument is %TRUE, the binding inverts the
2719 * value as it passes from the setting to the object, i.e. @property
2720 * will be set to %TRUE if the key is <emphasis>not</emphasis>
2723 * Note that the lifecycle of the binding is tied to the object,
2724 * and that you can have only one binding per object property.
2725 * If you bind the same property twice on the same object, the second
2726 * binding overrides the first one.
2731 g_settings_bind_writable (GSettings *settings,
2734 const gchar *property,
2737 GSettingsWritableBinding *binding;
2738 gchar *detailed_signal;
2741 g_return_if_fail (G_IS_SETTINGS (settings));
2743 pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
2746 g_critical ("g_settings_bind_writable: no property '%s' on class '%s'",
2747 property, G_OBJECT_TYPE_NAME (object));
2750 if ((pspec->flags & G_PARAM_WRITABLE) == 0)
2752 g_critical ("g_settings_bind_writable: property '%s' on class '%s' is not writable",
2753 property, G_OBJECT_TYPE_NAME (object));
2757 binding = g_slice_new (GSettingsWritableBinding);
2758 binding->settings = g_object_ref (settings);
2759 binding->object = object;
2760 binding->key = g_intern_string (key);
2761 binding->property = g_intern_string (property);
2762 binding->inverted = inverted;
2764 detailed_signal = g_strdup_printf ("writable-changed::%s", key);
2765 binding->handler_id =
2766 g_signal_connect (settings, detailed_signal,
2767 G_CALLBACK (g_settings_binding_writable_changed),
2769 g_free (detailed_signal);
2771 g_object_set_qdata_full (object, g_settings_binding_quark (property),
2772 binding, g_settings_writable_binding_free);
2774 g_settings_binding_writable_changed (settings, binding->key, binding);
2778 * g_settings_unbind:
2779 * @object: the object
2780 * @property: the property whose binding is removed
2782 * Removes an existing binding for @property on @object.
2784 * Note that bindings are automatically removed when the
2785 * object is finalized, so it is rarely necessary to call this
2791 g_settings_unbind (gpointer object,
2792 const gchar *property)
2794 GQuark binding_quark;
2796 binding_quark = g_settings_binding_quark (property);
2797 g_object_set_qdata (object, binding_quark, NULL);
2802 /* vim:set foldmethod=marker: */