| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | /*
 | 
					
						
							|  |  |  |  |  * Copyright © 2009, 2010 Codethink Limited | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2022-05-18 09:12:45 +01:00
										 |  |  |  |  * SPDX-License-Identifier: LGPL-2.1-or-later | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * This library is free software; you can redistribute it and/or | 
					
						
							|  |  |  |  |  * modify it under the terms of the GNU Lesser General Public | 
					
						
							|  |  |  |  |  * License as published by the Free Software Foundation; either | 
					
						
							| 
									
										
										
										
											2017-05-27 18:21:30 +02:00
										 |  |  |  |  * version 2.1 of the License, or (at your option) any later version. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * This library is distributed in the hope that it will be useful, | 
					
						
							|  |  |  |  |  * but WITHOUT ANY WARRANTY; without even the implied warranty of | 
					
						
							|  |  |  |  |  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU | 
					
						
							|  |  |  |  |  * Lesser General Public License for more details. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * You should have received a copy of the GNU Lesser General Public | 
					
						
							| 
									
										
										
										
											2014-01-23 12:58:29 +01:00
										 |  |  |  |  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
 | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Author: Ryan Lortie <desrt@desrt.ca> | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /* Prelude {{{1 */ | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | #include "config.h"
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | #include <glib.h>
 | 
					
						
							|  |  |  |  | #include <glibintl.h>
 | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | #include "gsettings.h"
 | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | #include "gdelayedsettingsbackend.h"
 | 
					
						
							|  |  |  |  | #include "gsettingsbackendinternal.h"
 | 
					
						
							|  |  |  |  | #include "gsettings-mapping.h"
 | 
					
						
							| 
									
										
										
										
											2011-11-13 21:41:01 +01:00
										 |  |  |  | #include "gsettingsschema-internal.h"
 | 
					
						
							| 
									
										
										
										
											2012-01-19 09:40:24 -05:00
										 |  |  |  | #include "gaction.h"
 | 
					
						
							| 
									
										
										
										
											2019-05-30 19:29:18 -07:00
										 |  |  |  | #include "gmarshal-internal.h"
 | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | #include "strinfo.c"
 | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * GSettings: | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * The `GSettings` class provides a convenient API for storing and retrieving | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * application settings. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-02-09 11:55:35 -05:00
										 |  |  |  |  * Reads and writes can be considered to be non-blocking.  Reading | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * settings with `GSettings` is typically extremely fast: on | 
					
						
							| 
									
										
										
										
											2011-02-09 11:55:35 -05:00
										 |  |  |  |  * approximately the same order of magnitude (but slower than) a | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * [struct@GLib.HashTable] lookup.  Writing settings is also extremely fast in | 
					
						
							|  |  |  |  |  * terms of time to return to your application, but can be extremely expensive | 
					
						
							| 
									
										
										
										
											2011-02-10 23:42:34 -05:00
										 |  |  |  |  * for other threads and other processes.  Many settings backends | 
					
						
							| 
									
										
										
										
											2011-02-09 11:55:35 -05:00
										 |  |  |  |  * (including dconf) have lazy initialisation which means in the common | 
					
						
							|  |  |  |  |  * case of the user using their computer without modifying any settings | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * a lot of work can be avoided.  For dconf, the D-Bus service doesn’t | 
					
						
							| 
									
										
										
										
											2011-02-09 11:55:35 -05:00
										 |  |  |  |  * even need to be started in this case.  For this reason, you should | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * only ever modify `GSettings` keys in response to explicit user action. | 
					
						
							| 
									
										
										
										
											2011-02-09 11:55:35 -05:00
										 |  |  |  |  * Particular care should be paid to ensure that modifications are not | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * made during startup — for example, when setting the initial value | 
					
						
							|  |  |  |  |  * of preferences widgets.  The built-in [method@Gio.Settings.bind] | 
					
						
							|  |  |  |  |  * functionality is careful not to write settings in response to notify signals | 
					
						
							|  |  |  |  |  * as a result of modifications that it makes to widgets. | 
					
						
							| 
									
										
										
										
											2011-02-09 11:55:35 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * When creating a `GSettings` instance, you have to specify a schema | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * that describes the keys in your settings and their types and default | 
					
						
							|  |  |  |  |  * values, as well as some other information. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2018-02-12 21:25:02 +00:00
										 |  |  |  |  * Normally, a schema has a fixed path that determines where the settings | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * are stored in the conceptual global tree of settings. However, schemas | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * can also be ‘[relocatable](#relocatable-schemas)’, i.e. not equipped with | 
					
						
							| 
									
										
										
										
											2014-12-19 21:03:46 +00:00
										 |  |  |  |  * a fixed path. This is | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * useful e.g. when the schema describes an ‘account’, and you want to be | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * able to store a arbitrary number of accounts. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * Paths must start with and end with a forward slash character (`/`) | 
					
						
							| 
									
										
										
										
											2012-04-12 20:04:32 -04:00
										 |  |  |  |  * and must not contain two sequential slash characters.  Paths should | 
					
						
							|  |  |  |  |  * be chosen based on a domain name associated with the program or | 
					
						
							|  |  |  |  |  * library to which the settings belong.  Examples of paths are | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * `/org/gtk/settings/file-chooser/` and `/ca/desrt/dconf-editor/`. | 
					
						
							|  |  |  |  |  * Paths should not start with `/apps/`, `/desktop/` or `/system/` as | 
					
						
							| 
									
										
										
										
											2012-04-12 20:04:32 -04:00
										 |  |  |  |  * they often did in GConf. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * Unlike other configuration systems (like GConf), GSettings does not | 
					
						
							|  |  |  |  |  * restrict keys to basic types like strings and numbers. GSettings stores | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * values as [struct@GLib.Variant], and allows any [type@GLib.VariantType] for | 
					
						
							|  |  |  |  |  * keys. Key names are restricted to lowercase characters, numbers and `-`. | 
					
						
							|  |  |  |  |  * Furthermore, the names must begin with a lowercase character, must not end | 
					
						
							|  |  |  |  |  * with a `-`, and must not contain consecutive dashes. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Similar to GConf, the default values in GSettings schemas can be | 
					
						
							|  |  |  |  |  * localized, but the localized values are stored in gettext catalogs | 
					
						
							| 
									
										
										
										
											2010-04-20 19:23:52 -04:00
										 |  |  |  |  * and looked up with the domain that is specified in the | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * `gettext-domain` attribute of the `<schemalist>` or `<schema>` | 
					
						
							| 
									
										
										
										
											2014-12-19 20:42:21 +00:00
										 |  |  |  |  * elements and the category that is specified in the `l10n` attribute of | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * the `<default>` element. The string which is translated includes all text in | 
					
						
							|  |  |  |  |  * the `<default>` element, including any surrounding quotation marks. | 
					
						
							| 
									
										
										
										
											2014-12-19 20:42:21 +00:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * The `l10n` attribute must be set to `messages` or `time`, and sets the | 
					
						
							|  |  |  |  |  * [locale category for | 
					
						
							|  |  |  |  |  * translation](https://www.gnu.org/software/gettext/manual/html_node/Aspects.html#index-locale-categories-1).
 | 
					
						
							|  |  |  |  |  * The `messages` category should be used by default; use `time` for | 
					
						
							|  |  |  |  |  * translatable date or time formats. A translation comment can be added as an | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * XML comment immediately above the `<default>` element — it is recommended to | 
					
						
							| 
									
										
										
										
											2014-12-19 20:42:21 +00:00
										 |  |  |  |  * add these comments to aid translators understand the meaning and | 
					
						
							|  |  |  |  |  * implications of the default value. An optional translation `context` | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * attribute can be set on the `<default>` element to disambiguate multiple | 
					
						
							| 
									
										
										
										
											2014-12-19 20:42:21 +00:00
										 |  |  |  |  * defaults which use the same string. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * For example: | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ```xml | 
					
						
							| 
									
										
										
										
											2014-12-19 20:42:21 +00:00
										 |  |  |  |  *  <!-- Translators: A list of words which are not allowed to be typed, in | 
					
						
							|  |  |  |  |  *       GVariant serialization syntax. | 
					
						
							|  |  |  |  |  *       See: https://developer.gnome.org/glib/stable/gvariant-text.html -->
 | 
					
						
							|  |  |  |  |  *  <default l10n='messages' context='Banned words'>['bad', 'words']</default> | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ``` | 
					
						
							| 
									
										
										
										
											2014-12-19 20:42:21 +00:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Translations of default values must remain syntactically valid serialized | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * [struct@GLib.Variant]s (e.g. retaining any surrounding quotation marks) or | 
					
						
							|  |  |  |  |  * runtime errors will occur. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * GSettings uses schemas in a compact binary form that is created | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * by the [`glib-compile-schemas`](glib-compile-schemas.html) | 
					
						
							| 
									
										
										
										
											2014-02-01 20:41:12 -05:00
										 |  |  |  |  * utility. The input is a schema description in an XML format. | 
					
						
							| 
									
										
										
										
											2014-02-01 10:48:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2014-02-05 21:23:28 -05:00
										 |  |  |  |  * A DTD for the gschema XML format can be found here: | 
					
						
							| 
									
										
										
										
											2021-06-07 13:16:50 +01:00
										 |  |  |  |  * [gschema.dtd](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/gschema.dtd)
 | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * The [`glib-compile-schemas`](glib-compile-schemas.html) tool expects schema | 
					
						
							| 
									
										
										
										
											2014-02-08 12:26:56 -05:00
										 |  |  |  |  * files to have the extension `.gschema.xml`. | 
					
						
							| 
									
										
										
										
											2011-03-15 11:28:03 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * At runtime, schemas are identified by their ID (as specified in the | 
					
						
							|  |  |  |  |  * `id` attribute of the `<schema>` element). The convention for schema | 
					
						
							|  |  |  |  |  * IDs is to use a dotted name, similar in style to a D-Bus bus name, | 
					
						
							|  |  |  |  |  * e.g. `org.gnome.SessionManager`. In particular, if the settings are | 
					
						
							| 
									
										
										
										
											2014-02-05 22:37:54 -05:00
										 |  |  |  |  * for a specific service that owns a D-Bus bus name, the D-Bus bus name | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * and schema ID should match. For schemas which deal with settings not | 
					
						
							|  |  |  |  |  * associated with one named application, the ID should not use | 
					
						
							|  |  |  |  |  * StudlyCaps, e.g. `org.gnome.font-rendering`. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * In addition to [struct@GLib.Variant] types, keys can have types that have | 
					
						
							|  |  |  |  |  * enumerated types. These can be described by a `<choice>`, | 
					
						
							|  |  |  |  |  * `<enum>` or `<flags>` element, as seen in the | 
					
						
							|  |  |  |  |  * second example below. The underlying type of such a key | 
					
						
							|  |  |  |  |  * is string, but you can use [method@Gio.Settings.get_enum], | 
					
						
							|  |  |  |  |  * [method@Gio.Settings.set_enum], [method@Gio.Settings.get_flags], | 
					
						
							|  |  |  |  |  * [method@Gio.Settings.set_flags] access the numeric values corresponding to | 
					
						
							|  |  |  |  |  * the string value of enum and flags keys. | 
					
						
							| 
									
										
										
										
											2010-11-05 14:28:44 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2014-01-31 21:56:33 -05:00
										 |  |  |  |  * An example for default value: | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ```xml | 
					
						
							| 
									
										
										
										
											2010-06-17 01:38:14 -04:00
										 |  |  |  |  * <schemalist> | 
					
						
							| 
									
										
										
										
											2012-04-12 20:04:32 -04:00
										 |  |  |  |  *   <schema id="org.gtk.Test" path="/org/gtk/Test/" gettext-domain="test"> | 
					
						
							| 
									
										
										
										
											2010-06-17 08:06:52 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-17 01:38:14 -04:00
										 |  |  |  |  *     <key name="greeting" type="s"> | 
					
						
							|  |  |  |  |  *       <default l10n="messages">"Hello, earthlings"</default> | 
					
						
							|  |  |  |  |  *       <summary>A greeting</summary> | 
					
						
							|  |  |  |  |  *       <description> | 
					
						
							|  |  |  |  |  *         Greeting of the invading martians | 
					
						
							|  |  |  |  |  *       </description> | 
					
						
							|  |  |  |  |  *     </key> | 
					
						
							| 
									
										
										
										
											2010-06-17 08:06:52 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-17 01:38:14 -04:00
										 |  |  |  |  *     <key name="box" type="(ii)"> | 
					
						
							|  |  |  |  |  *       <default>(20,30)</default> | 
					
						
							|  |  |  |  |  *     </key> | 
					
						
							| 
									
										
										
										
											2010-06-17 08:06:52 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2018-11-13 00:30:17 +00:00
										 |  |  |  |  *     <key name="empty-string" type="s"> | 
					
						
							|  |  |  |  |  *       <default>""</default> | 
					
						
							|  |  |  |  |  *       <summary>Empty strings have to be provided in GVariant form</summary> | 
					
						
							|  |  |  |  |  *     </key> | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-17 01:38:14 -04:00
										 |  |  |  |  *   </schema> | 
					
						
							|  |  |  |  |  * </schemalist> | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ``` | 
					
						
							| 
									
										
										
										
											2010-06-17 01:38:14 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2014-01-31 21:56:33 -05:00
										 |  |  |  |  * An example for ranges, choices and enumerated types: | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ```xml | 
					
						
							| 
									
										
										
										
											2010-06-17 01:38:14 -04:00
										 |  |  |  |  * <schemalist> | 
					
						
							| 
									
										
										
										
											2010-06-17 08:06:52 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-05-10 15:25:54 +02:00
										 |  |  |  |  *   <enum id="org.gtk.Test.myenum"> | 
					
						
							| 
									
										
										
										
											2010-06-17 01:38:14 -04:00
										 |  |  |  |  *     <value nick="first" value="1"/> | 
					
						
							|  |  |  |  |  *     <value nick="second" value="2"/> | 
					
						
							|  |  |  |  |  *   </enum> | 
					
						
							| 
									
										
										
										
											2010-06-17 08:06:52 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-05-10 15:25:54 +02:00
										 |  |  |  |  *   <flags id="org.gtk.Test.myflags"> | 
					
						
							| 
									
										
										
										
											2010-11-05 14:28:44 -04:00
										 |  |  |  |  *     <value nick="flag1" value="1"/> | 
					
						
							|  |  |  |  |  *     <value nick="flag2" value="2"/> | 
					
						
							|  |  |  |  |  *     <value nick="flag3" value="4"/> | 
					
						
							| 
									
										
										
										
											2011-05-10 15:25:54 +02:00
										 |  |  |  |  *   </flags> | 
					
						
							| 
									
										
										
										
											2010-11-05 14:28:44 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-01-17 17:13:44 -05:00
										 |  |  |  |  *   <schema id="org.gtk.Test"> | 
					
						
							| 
									
										
										
										
											2010-06-17 08:06:52 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-17 01:38:14 -04:00
										 |  |  |  |  *     <key name="key-with-range" type="i"> | 
					
						
							|  |  |  |  |  *       <range min="1" max="100"/> | 
					
						
							|  |  |  |  |  *       <default>10</default> | 
					
						
							|  |  |  |  |  *     </key> | 
					
						
							| 
									
										
										
										
											2010-06-17 08:06:52 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-17 01:38:14 -04:00
										 |  |  |  |  *     <key name="key-with-choices" type="s"> | 
					
						
							|  |  |  |  |  *       <choices> | 
					
						
							|  |  |  |  |  *         <choice value='Elisabeth'/> | 
					
						
							|  |  |  |  |  *         <choice value='Annabeth'/> | 
					
						
							|  |  |  |  |  *         <choice value='Joe'/> | 
					
						
							|  |  |  |  |  *       </choices> | 
					
						
							|  |  |  |  |  *       <aliases> | 
					
						
							| 
									
										
										
										
											2010-06-17 08:57:19 -04:00
										 |  |  |  |  *         <alias value='Anna' target='Annabeth'/> | 
					
						
							|  |  |  |  |  *         <alias value='Beth' target='Elisabeth'/> | 
					
						
							| 
									
										
										
										
											2010-06-17 01:38:14 -04:00
										 |  |  |  |  *       </aliases> | 
					
						
							|  |  |  |  |  *       <default>'Joe'</default> | 
					
						
							|  |  |  |  |  *     </key> | 
					
						
							| 
									
										
										
										
											2010-06-17 08:06:52 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-05-10 15:25:54 +02:00
										 |  |  |  |  *     <key name='enumerated-key' enum='org.gtk.Test.myenum'> | 
					
						
							| 
									
										
										
										
											2010-06-17 01:38:14 -04:00
										 |  |  |  |  *       <default>'first'</default> | 
					
						
							|  |  |  |  |  *     </key> | 
					
						
							| 
									
										
										
										
											2010-06-17 08:06:52 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-05-10 15:25:54 +02:00
										 |  |  |  |  *     <key name='flags-key' flags='org.gtk.Test.myflags'> | 
					
						
							| 
									
										
										
										
											2014-12-21 11:08:39 -05:00
										 |  |  |  |  *       <default>["flag1","flag2"]</default> | 
					
						
							| 
									
										
										
										
											2010-11-05 14:28:44 -04:00
										 |  |  |  |  *     </key> | 
					
						
							| 
									
										
										
										
											2010-06-17 01:38:14 -04:00
										 |  |  |  |  *   </schema> | 
					
						
							|  |  |  |  |  * </schemalist> | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ``` | 
					
						
							| 
									
										
										
										
											2010-06-17 01:38:14 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2014-02-01 10:48:02 -05:00
										 |  |  |  |  * ## Vendor overrides | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Default values are defined in the schemas that get installed by | 
					
						
							|  |  |  |  |  * an application. Sometimes, it is necessary for a vendor or distributor | 
					
						
							|  |  |  |  |  * to adjust these defaults. Since patching the XML source for the schema | 
					
						
							|  |  |  |  |  * is inconvenient and error-prone, | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * [`glib-compile-schemas`](glib-compile-schemas.html) reads so-called ‘vendor | 
					
						
							|  |  |  |  |  * override’ files. These are keyfiles in the same directory as the XML | 
					
						
							|  |  |  |  |  * schema sources which can override default values. The schema ID serves | 
					
						
							| 
									
										
										
										
											2014-02-08 12:26:56 -05:00
										 |  |  |  |  * as the group name in the key file, and the values are expected in | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * serialized [struct@GLib.Variant] form, as in the following example: | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * [org.gtk.Example] | 
					
						
							|  |  |  |  |  * key1='string' | 
					
						
							|  |  |  |  |  * key2=1.5 | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * `glib-compile-schemas` expects schema files to have the extension | 
					
						
							| 
									
										
										
										
											2014-02-05 20:17:46 -05:00
										 |  |  |  |  * `.gschema.override`. | 
					
						
							| 
									
										
										
										
											2014-02-01 10:48:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 14:03:04 +00:00
										 |  |  |  |  * ## Delay-apply mode | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * By default, values set on a [class@Gio.Settings] instance immediately start | 
					
						
							|  |  |  |  |  * to be written to the backend (although these writes may not complete by the | 
					
						
							|  |  |  |  |  * time that [method@Gio.Settings.set]) returns; see [func@Gio.Settings.sync]). | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * In order to allow groups of settings to be changed simultaneously and | 
					
						
							|  |  |  |  |  * atomically, GSettings also supports a ‘delay-apply’ mode. In this mode, | 
					
						
							|  |  |  |  |  * updated values are kept locally in the [class@Gio.Settings] instance until | 
					
						
							|  |  |  |  |  * they are explicitly applied by calling [method@Gio.Settings.apply]. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * For example, this could be useful for a preferences dialog where the | 
					
						
							|  |  |  |  |  * preferences all need to be applied simultaneously when the user clicks ‘Save’. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Switching a [class@Gio.Settings] instance to ‘delay-apply’ mode is a one-time | 
					
						
							|  |  |  |  |  * irreversible operation: from that point onwards, *all* changes made to that | 
					
						
							|  |  |  |  |  * [class@Gio.Settings] have to be explicitly applied by calling | 
					
						
							|  |  |  |  |  * [method@Gio.Settings.apply]. The ‘delay-apply’ mode is also propagated to any | 
					
						
							|  |  |  |  |  * child settings objects subsequently created using | 
					
						
							|  |  |  |  |  * [method@Gio.Settings.get_child]. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * At any point, the set of unapplied changes can be queried using | 
					
						
							|  |  |  |  |  * [property@Gio.Settings:has-unapplied], and discarded by calling | 
					
						
							|  |  |  |  |  * [method@Gio.Settings.revert]. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2014-02-01 10:48:02 -05:00
										 |  |  |  |  * ## Binding | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * A very convenient feature of GSettings lets you bind [class@GObject.Object] | 
					
						
							|  |  |  |  |  * properties directly to settings, using [method@Gio.Settings.bind]. Once a | 
					
						
							|  |  |  |  |  * [class@GObject.Object] property has been bound to a setting, changes on | 
					
						
							|  |  |  |  |  * either side are automatically propagated to the other side. GSettings handles | 
					
						
							|  |  |  |  |  * details like mapping between [class@GObject.Object] and [struct@GLib.Variant] | 
					
						
							|  |  |  |  |  * types, and preventing infinite cycles. | 
					
						
							| 
									
										
										
										
											2014-02-01 10:48:02 -05:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * This makes it very easy to hook up a preferences dialog to the | 
					
						
							|  |  |  |  |  * underlying settings. To make this even more convenient, GSettings | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * looks for a boolean property with the name `sensitivity` and | 
					
						
							| 
									
										
										
										
											2014-02-01 10:48:02 -05:00
										 |  |  |  |  * automatically binds it to the writability of the bound setting. | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * If this ‘magic’ gets in the way, it can be suppressed with the | 
					
						
							|  |  |  |  |  * `G_SETTINGS_BIND_NO_SENSITIVITY` flag. | 
					
						
							| 
									
										
										
										
											2014-12-19 21:03:46 +00:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ## Relocatable schemas | 
					
						
							| 
									
										
										
										
											2014-12-19 21:03:46 +00:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * A relocatable schema is one with no `path` attribute specified on its | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * `<schema>` element. By using [ctor@Gio.Settings.new_with_path], a `GSettings` | 
					
						
							|  |  |  |  |  * object can be instantiated for a relocatable schema, assigning a path to the | 
					
						
							|  |  |  |  |  * instance. Paths passed to [ctor@Gio.Settings.new_with_path] will typically be | 
					
						
							| 
									
										
										
										
											2014-12-19 21:03:46 +00:00
										 |  |  |  |  * constructed dynamically from a constant prefix plus some form of instance | 
					
						
							|  |  |  |  |  * identifier; but they must still be valid GSettings paths. Paths could also | 
					
						
							|  |  |  |  |  * be constant and used with a globally installed schema originating from a | 
					
						
							|  |  |  |  |  * dependency library. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * For example, a relocatable schema could be used to store geometry information | 
					
						
							|  |  |  |  |  * for different windows in an application. If the schema ID was | 
					
						
							|  |  |  |  |  * `org.foo.MyApp.Window`, it could be instantiated for paths | 
					
						
							|  |  |  |  |  * `/org/foo/MyApp/main/`, `/org/foo/MyApp/document-1/`, | 
					
						
							|  |  |  |  |  * `/org/foo/MyApp/document-2/`, etc. If any of the paths are well-known | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * they can be specified as `<child>` elements in the parent schema, e.g.: | 
					
						
							|  |  |  |  |  * ```xml | 
					
						
							| 
									
										
										
										
											2014-12-19 21:03:46 +00:00
										 |  |  |  |  * <schema id="org.foo.MyApp" path="/org/foo/MyApp/"> | 
					
						
							|  |  |  |  |  *   <child name="main" schema="org.foo.MyApp.Window"/> | 
					
						
							|  |  |  |  |  * </schema> | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ``` | 
					
						
							| 
									
										
										
										
											2014-12-19 20:43:06 +00:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ## Build system integration | 
					
						
							| 
									
										
										
										
											2014-12-19 20:43:06 +00:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2024-10-11 10:17:32 +01:00
										 |  |  |  |  * ### Meson | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * GSettings is natively supported by Meson’s [GNOME module](https://mesonbuild.com/Gnome-module.html).
 | 
					
						
							| 
									
										
										
										
											2024-10-11 10:17:32 +01:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * You can install the schemas as any other data file: | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * install_data( | 
					
						
							|  |  |  |  |  *   'org.foo.MyApp.gschema.xml', | 
					
						
							|  |  |  |  |  *   install_dir: get_option('datadir') / 'glib-2.0/schemas', | 
					
						
							|  |  |  |  |  * ) | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * You can use `gnome.post_install()` function to compile the schemas on | 
					
						
							|  |  |  |  |  * installation: | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * gnome = import('gnome') | 
					
						
							|  |  |  |  |  * gnome.post_install( | 
					
						
							|  |  |  |  |  *   glib_compile_schemas: true, | 
					
						
							|  |  |  |  |  * ) | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * If an enumerated type defined in a C header file is to be used in a GSettings | 
					
						
							|  |  |  |  |  * schema, it can either be defined manually using an `<enum>` element in the | 
					
						
							|  |  |  |  |  * schema XML, or it can be extracted automatically from the C header. This | 
					
						
							|  |  |  |  |  * approach is preferred, as it ensures the two representations are always | 
					
						
							|  |  |  |  |  * synchronised. To do so, you will need to use the `gnome.mkenums()` function | 
					
						
							|  |  |  |  |  * with the following templates: | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * schemas_enums = gnome.mkenums('org.foo.MyApp.enums.xml', | 
					
						
							|  |  |  |  |  *   comments: '<!-- @comment@ -->', | 
					
						
							|  |  |  |  |  *   fhead: '<schemalist>', | 
					
						
							|  |  |  |  |  *   vhead: '  <@type@ id="org.foo.MyApp.@EnumName@">', | 
					
						
							|  |  |  |  |  *   vprod: '    <value nick="@valuenick@" value="@valuenum@"/>', | 
					
						
							|  |  |  |  |  *   vtail: '  </@type@>', | 
					
						
							|  |  |  |  |  *   ftail: '</schemalist>', | 
					
						
							|  |  |  |  |  *   sources: enum_sources, | 
					
						
							|  |  |  |  |  *   install_header: true, | 
					
						
							|  |  |  |  |  *   install_dir: get_option('datadir') / 'glib-2.0/schemas', | 
					
						
							|  |  |  |  |  * ) | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * It is recommended to validate your schemas as part of the test suite for | 
					
						
							|  |  |  |  |  * your application: | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * test('validate-schema', | 
					
						
							|  |  |  |  |  *   find_program('glib-compile-schemas'), | 
					
						
							|  |  |  |  |  *   args: ['--strict', '--dry-run', meson.current_source_dir()], | 
					
						
							|  |  |  |  |  * ) | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * If your application allows running uninstalled, you should also use the | 
					
						
							|  |  |  |  |  * `gnome.compile_schemas()` function to compile the schemas in the current | 
					
						
							|  |  |  |  |  * build directory: | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * gnome.compile_schemas() | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * ### Autotools | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2014-12-19 20:43:06 +00:00
										 |  |  |  |  * GSettings comes with autotools integration to simplify compiling and | 
					
						
							|  |  |  |  |  * installing schemas. To add GSettings support to an application, add the | 
					
						
							|  |  |  |  |  * following to your `configure.ac`: | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ``` | 
					
						
							| 
									
										
										
										
											2014-12-19 20:43:06 +00:00
										 |  |  |  |  * GLIB_GSETTINGS | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ``` | 
					
						
							| 
									
										
										
										
											2014-12-19 20:43:06 +00:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * In the appropriate `Makefile.am`, use the following snippet to compile and | 
					
						
							|  |  |  |  |  * install the named schema: | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ``` | 
					
						
							| 
									
										
										
										
											2014-12-19 20:43:06 +00:00
										 |  |  |  |  * gsettings_SCHEMAS = org.foo.MyApp.gschema.xml | 
					
						
							|  |  |  |  |  * EXTRA_DIST = $(gsettings_SCHEMAS) | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * @GSETTINGS_RULES@ | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ``` | 
					
						
							| 
									
										
										
										
											2014-12-19 20:43:06 +00:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * If an enumerated type defined in a C header file is to be used in a GSettings | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * schema, it can either be defined manually using an `<enum>` element in the | 
					
						
							| 
									
										
										
										
											2014-12-19 20:43:06 +00:00
										 |  |  |  |  * schema XML, or it can be extracted automatically from the C header. This | 
					
						
							|  |  |  |  |  * approach is preferred, as it ensures the two representations are always | 
					
						
							|  |  |  |  |  * synchronised. To do so, add the following to the relevant `Makefile.am`: | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ``` | 
					
						
							| 
									
										
										
										
											2014-12-19 20:43:06 +00:00
										 |  |  |  |  * gsettings_ENUM_NAMESPACE = org.foo.MyApp | 
					
						
							|  |  |  |  |  * gsettings_ENUM_FILES = my-app-enums.h my-app-misc.h | 
					
						
							| 
									
										
										
										
											2023-11-02 16:22:47 +00:00
										 |  |  |  |  * ``` | 
					
						
							| 
									
										
										
										
											2014-12-19 20:43:06 +00:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * `gsettings_ENUM_NAMESPACE` specifies the schema namespace for the enum files, | 
					
						
							|  |  |  |  |  * which are specified in `gsettings_ENUM_FILES`. This will generate a | 
					
						
							|  |  |  |  |  * `org.foo.MyApp.enums.xml` file containing the extracted enums, which will be | 
					
						
							|  |  |  |  |  * automatically included in the schema compilation, install and uninstall | 
					
						
							|  |  |  |  |  * rules. It should not be committed to version control or included in | 
					
						
							|  |  |  |  |  * `EXTRA_DIST`. | 
					
						
							| 
									
										
										
										
											2024-10-11 10:17:32 +01:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * ## Localization | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * No changes are needed to the build system to mark a schema XML file for | 
					
						
							|  |  |  |  |  * translation. Assuming it sets the `gettext-domain` attribute, a schema may | 
					
						
							|  |  |  |  |  * be marked for translation by adding it to `POTFILES.in`, assuming gettext | 
					
						
							|  |  |  |  |  * 0.19 or newer is in use (the preferred method for translation): | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * data/org.foo.MyApp.gschema.xml | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Alternatively, if intltool 0.50.1 is in use: | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * [type: gettext/gsettings]data/org.foo.MyApp.gschema.xml | 
					
						
							|  |  |  |  |  * ``` | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * GSettings will use gettext to look up translations for the `<summary>` and | 
					
						
							|  |  |  |  |  * `<description>` elements, and also any `<default>` elements which have a | 
					
						
							|  |  |  |  |  * `l10n` attribute set. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Translations **must not** be included in the `.gschema.xml` file by the build | 
					
						
							|  |  |  |  |  * system, for example by using a rule to generate the XML file from a template. | 
					
						
							| 
									
										
										
										
											2014-02-01 10:48:02 -05:00
										 |  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  | struct _GSettingsPrivate | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-05-16 13:02:23 +02:00
										 |  |  |  |   /* where the signals go... */ | 
					
						
							|  |  |  |  |   GMainContext *main_context; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |   GSettingsBackend *backend; | 
					
						
							|  |  |  |  |   GSettingsSchema *schema; | 
					
						
							|  |  |  |  |   gchar *path; | 
					
						
							|  |  |  |  | }; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | enum | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   PROP_0, | 
					
						
							| 
									
										
										
										
											2011-11-15 12:16:50 +00:00
										 |  |  |  |   PROP_SCHEMA, | 
					
						
							| 
									
										
										
										
											2011-11-15 11:39:12 +00:00
										 |  |  |  |   PROP_SCHEMA_ID, | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |   PROP_BACKEND, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |   PROP_PATH, | 
					
						
							|  |  |  |  |   PROP_HAS_UNAPPLIED, | 
					
						
							| 
									
										
										
										
											2010-12-20 09:16:05 -05:00
										 |  |  |  |   PROP_DELAY_APPLY | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | }; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | enum | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   SIGNAL_WRITABLE_CHANGE_EVENT, | 
					
						
							|  |  |  |  |   SIGNAL_WRITABLE_CHANGED, | 
					
						
							|  |  |  |  |   SIGNAL_CHANGE_EVENT, | 
					
						
							|  |  |  |  |   SIGNAL_CHANGED, | 
					
						
							|  |  |  |  |   N_SIGNALS | 
					
						
							|  |  |  |  | }; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static guint g_settings_signals[N_SIGNALS]; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2013-06-11 00:29:58 +01:00
										 |  |  |  | G_DEFINE_TYPE_WITH_PRIVATE (GSettings, g_settings, G_TYPE_OBJECT) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /* Signals {{{1 */ | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | static gboolean | 
					
						
							|  |  |  |  | g_settings_real_change_event (GSettings    *settings, | 
					
						
							|  |  |  |  |                               const GQuark *keys, | 
					
						
							|  |  |  |  |                               gint          n_keys) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   gint i; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (keys == NULL) | 
					
						
							|  |  |  |  |     keys = g_settings_schema_list (settings->priv->schema, &n_keys); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   for (i = 0; i < n_keys; i++) | 
					
						
							| 
									
										
										
										
											2012-07-06 13:43:17 -04:00
										 |  |  |  |     { | 
					
						
							|  |  |  |  |       const gchar *key = g_quark_to_string (keys[i]); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |       if (g_str_has_suffix (key, "/")) | 
					
						
							|  |  |  |  |         continue; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |       g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGED], keys[i], key); | 
					
						
							|  |  |  |  |     } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   return FALSE; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static gboolean | 
					
						
							|  |  |  |  | g_settings_real_writable_change_event (GSettings *settings, | 
					
						
							|  |  |  |  |                                        GQuark     key) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   const GQuark *keys = &key; | 
					
						
							|  |  |  |  |   gint n_keys = 1; | 
					
						
							|  |  |  |  |   gint i; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (key == 0) | 
					
						
							|  |  |  |  |     keys = g_settings_schema_list (settings->priv->schema, &n_keys); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   for (i = 0; i < n_keys; i++) | 
					
						
							| 
									
										
										
										
											2012-07-06 13:43:17 -04:00
										 |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2022-01-19 18:50:24 +01:00
										 |  |  |  |       const gchar *key_name = g_quark_to_string (keys[i]); | 
					
						
							| 
									
										
										
										
											2012-07-06 13:43:17 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-01-19 18:50:24 +01:00
										 |  |  |  |       if (g_str_has_suffix (key_name, "/")) | 
					
						
							| 
									
										
										
										
											2012-07-06 13:43:17 -04:00
										 |  |  |  |         continue; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-01-19 18:50:24 +01:00
										 |  |  |  |       g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGED], keys[i], key_name); | 
					
						
							| 
									
										
										
										
											2012-07-06 13:43:17 -04:00
										 |  |  |  |     } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   return FALSE; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							| 
									
										
										
										
											2010-09-09 15:45:53 -04:00
										 |  |  |  | settings_backend_changed (GObject             *target, | 
					
						
							|  |  |  |  |                           GSettingsBackend    *backend, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                           const gchar         *key, | 
					
						
							| 
									
										
										
										
											2010-05-16 14:17:34 -04:00
										 |  |  |  |                           gpointer             origin_tag) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-05-16 14:17:34 -04:00
										 |  |  |  |   GSettings *settings = G_SETTINGS (target); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |   gboolean ignore_this; | 
					
						
							|  |  |  |  |   gint i; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-04-07 21:25:01 -04:00
										 |  |  |  |   /* We used to assert here:
 | 
					
						
							|  |  |  |  |    * | 
					
						
							|  |  |  |  |    *   settings->priv->backend == backend | 
					
						
							|  |  |  |  |    * | 
					
						
							|  |  |  |  |    * but it could be the case that a notification is queued for delivery | 
					
						
							|  |  |  |  |    * while someone calls g_settings_delay() (which changes the backend). | 
					
						
							|  |  |  |  |    * | 
					
						
							|  |  |  |  |    * Since the delay backend would just pass that straight through | 
					
						
							|  |  |  |  |    * anyway, it doesn't make sense to try to detect this case. | 
					
						
							|  |  |  |  |    * Therefore, we just accept it. | 
					
						
							|  |  |  |  |    */ | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   for (i = 0; key[i] == settings->priv->path[i]; i++); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (settings->priv->path[i] == '\0' && | 
					
						
							|  |  |  |  |       g_settings_schema_has_key (settings->priv->schema, key + i)) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       GQuark quark; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |       quark = g_quark_from_string (key + i); | 
					
						
							|  |  |  |  |       g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT], | 
					
						
							|  |  |  |  |                      0, &quark, 1, &ignore_this); | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							| 
									
										
										
										
											2010-09-09 15:45:53 -04:00
										 |  |  |  | settings_backend_path_changed (GObject          *target, | 
					
						
							|  |  |  |  |                                GSettingsBackend *backend, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                                const gchar      *path, | 
					
						
							| 
									
										
										
										
											2010-05-16 14:17:34 -04:00
										 |  |  |  |                                gpointer          origin_tag) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-05-16 14:17:34 -04:00
										 |  |  |  |   GSettings *settings = G_SETTINGS (target); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |   gboolean ignore_this; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (g_str_has_prefix (settings->priv->path, path)) | 
					
						
							|  |  |  |  |     g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT], | 
					
						
							|  |  |  |  |                    0, NULL, 0, &ignore_this); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							| 
									
										
										
										
											2010-09-09 15:45:53 -04:00
										 |  |  |  | settings_backend_keys_changed (GObject             *target, | 
					
						
							|  |  |  |  |                                GSettingsBackend    *backend, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                                const gchar         *path, | 
					
						
							| 
									
										
										
										
											2014-02-26 17:09:59 -05:00
										 |  |  |  |                                gpointer             origin_tag, | 
					
						
							|  |  |  |  |                                const gchar * const *items) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-05-16 14:17:34 -04:00
										 |  |  |  |   GSettings *settings = G_SETTINGS (target); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |   gboolean ignore_this; | 
					
						
							|  |  |  |  |   gint i; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   for (i = 0; settings->priv->path[i] && | 
					
						
							|  |  |  |  |               settings->priv->path[i] == path[i]; i++); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (path[i] == '\0') | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       GQuark quarks[256]; | 
					
						
							|  |  |  |  |       gint j, l = 0; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |       for (j = 0; items[j]; j++) | 
					
						
							|  |  |  |  |          { | 
					
						
							|  |  |  |  |            const gchar *item = items[j]; | 
					
						
							|  |  |  |  |            gint k; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |            for (k = 0; item[k] == settings->priv->path[i + k]; k++); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |            if (settings->priv->path[i + k] == '\0' && | 
					
						
							|  |  |  |  |                g_settings_schema_has_key (settings->priv->schema, item + k)) | 
					
						
							|  |  |  |  |              quarks[l++] = g_quark_from_string (item + k); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |            /* "256 quarks ought to be enough for anybody!"
 | 
					
						
							|  |  |  |  |             * If this bites you, I'm sorry.  Please file a bug. | 
					
						
							|  |  |  |  |             */ | 
					
						
							|  |  |  |  |            g_assert (l < 256); | 
					
						
							|  |  |  |  |          } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |       if (l > 0) | 
					
						
							|  |  |  |  |         g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT], | 
					
						
							|  |  |  |  |                        0, quarks, l, &ignore_this); | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							| 
									
										
										
										
											2010-09-09 15:45:53 -04:00
										 |  |  |  | settings_backend_writable_changed (GObject          *target, | 
					
						
							|  |  |  |  |                                    GSettingsBackend *backend, | 
					
						
							| 
									
										
										
										
											2010-05-16 14:17:34 -04:00
										 |  |  |  |                                    const gchar      *key) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-05-16 14:17:34 -04:00
										 |  |  |  |   GSettings *settings = G_SETTINGS (target); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |   gboolean ignore_this; | 
					
						
							|  |  |  |  |   gint i; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   for (i = 0; key[i] == settings->priv->path[i]; i++); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (settings->priv->path[i] == '\0' && | 
					
						
							|  |  |  |  |       g_settings_schema_has_key (settings->priv->schema, key + i)) | 
					
						
							|  |  |  |  |     g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT], | 
					
						
							|  |  |  |  |                    0, g_quark_from_string (key + i), &ignore_this); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							| 
									
										
										
										
											2010-09-09 15:45:53 -04:00
										 |  |  |  | settings_backend_path_writable_changed (GObject          *target, | 
					
						
							|  |  |  |  |                                         GSettingsBackend *backend, | 
					
						
							| 
									
										
										
										
											2010-05-16 14:17:34 -04:00
										 |  |  |  |                                         const gchar      *path) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-05-16 14:17:34 -04:00
										 |  |  |  |   GSettings *settings = G_SETTINGS (target); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |   gboolean ignore_this; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (g_str_has_prefix (settings->priv->path, path)) | 
					
						
							|  |  |  |  |     g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT], | 
					
						
							|  |  |  |  |                    0, (GQuark) 0, &ignore_this); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /* Properties, Construction, Destruction {{{1 */ | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_set_property (GObject      *object, | 
					
						
							|  |  |  |  |                          guint         prop_id, | 
					
						
							|  |  |  |  |                          const GValue *value, | 
					
						
							|  |  |  |  |                          GParamSpec   *pspec) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettings *settings = G_SETTINGS (object); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   switch (prop_id) | 
					
						
							|  |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2011-11-15 12:16:50 +00:00
										 |  |  |  |     case PROP_SCHEMA: | 
					
						
							|  |  |  |  |       { | 
					
						
							|  |  |  |  |         GSettingsSchema *schema; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |         schema = g_value_dup_boxed (value); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |         /* we receive a set_property() call for "settings-schema" even
 | 
					
						
							|  |  |  |  |          * if it was not specified (ie: with NULL value).  ->schema | 
					
						
							|  |  |  |  |          * could already be set at this point (ie: via "schema-id"). | 
					
						
							|  |  |  |  |          * check for NULL to avoid clobbering the existing value. | 
					
						
							|  |  |  |  |          */ | 
					
						
							|  |  |  |  |         if (schema != NULL) | 
					
						
							|  |  |  |  |           { | 
					
						
							|  |  |  |  |             g_assert (settings->priv->schema == NULL); | 
					
						
							|  |  |  |  |             settings->priv->schema = schema; | 
					
						
							|  |  |  |  |           } | 
					
						
							|  |  |  |  |       } | 
					
						
							|  |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-15 11:39:12 +00:00
										 |  |  |  |     case PROP_SCHEMA_ID: | 
					
						
							| 
									
										
										
										
											2011-11-15 11:56:18 +00:00
										 |  |  |  |       { | 
					
						
							|  |  |  |  |         const gchar *schema_id; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |         schema_id = g_value_get_string (value); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |         /* we receive a set_property() call for both "schema" and
 | 
					
						
							|  |  |  |  |          * "schema-id", even if they are not set.  Hopefully only one of | 
					
						
							|  |  |  |  |          * them is non-NULL. | 
					
						
							|  |  |  |  |          */ | 
					
						
							|  |  |  |  |         if (schema_id != NULL) | 
					
						
							|  |  |  |  |           { | 
					
						
							|  |  |  |  |             GSettingsSchemaSource *default_source; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |             g_assert (settings->priv->schema == NULL); | 
					
						
							|  |  |  |  |             default_source = g_settings_schema_source_get_default (); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |             if (default_source == NULL) | 
					
						
							|  |  |  |  |               g_error ("No GSettings schemas are installed on the system"); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |             settings->priv->schema = g_settings_schema_source_lookup (default_source, schema_id, TRUE); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |             if (settings->priv->schema == NULL) | 
					
						
							| 
									
										
										
										
											2018-04-27 16:45:36 +01:00
										 |  |  |  |               g_error ("Settings schema '%s' is not installed", schema_id); | 
					
						
							| 
									
										
										
										
											2011-11-15 11:56:18 +00:00
										 |  |  |  |           } | 
					
						
							|  |  |  |  |       } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |     case PROP_PATH: | 
					
						
							|  |  |  |  |       settings->priv->path = g_value_dup_string (value); | 
					
						
							|  |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |     case PROP_BACKEND: | 
					
						
							|  |  |  |  |       settings->priv->backend = g_value_dup_object (value); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |     default: | 
					
						
							|  |  |  |  |       g_assert_not_reached (); | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_get_property (GObject    *object, | 
					
						
							|  |  |  |  |                          guint       prop_id, | 
					
						
							|  |  |  |  |                          GValue     *value, | 
					
						
							|  |  |  |  |                          GParamSpec *pspec) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettings *settings = G_SETTINGS (object); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   switch (prop_id) | 
					
						
							|  |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2011-11-15 12:16:50 +00:00
										 |  |  |  |     case PROP_SCHEMA: | 
					
						
							|  |  |  |  |       g_value_set_boxed (value, settings->priv->schema); | 
					
						
							|  |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-15 11:39:12 +00:00
										 |  |  |  |      case PROP_SCHEMA_ID: | 
					
						
							| 
									
										
										
										
											2011-11-15 11:56:18 +00:00
										 |  |  |  |       g_value_set_string (value, g_settings_schema_get_id (settings->priv->schema)); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-11-30 18:19:12 -06:00
										 |  |  |  |      case PROP_BACKEND: | 
					
						
							|  |  |  |  |       g_value_set_object (value, settings->priv->backend); | 
					
						
							|  |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-10-03 01:53:09 -04:00
										 |  |  |  |      case PROP_PATH: | 
					
						
							|  |  |  |  |       g_value_set_string (value, settings->priv->path); | 
					
						
							|  |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |      case PROP_HAS_UNAPPLIED: | 
					
						
							|  |  |  |  |       g_value_set_boolean (value, g_settings_get_has_unapplied (settings)); | 
					
						
							|  |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-12-20 09:16:05 -05:00
										 |  |  |  |      case PROP_DELAY_APPLY: | 
					
						
							| 
									
										
										
										
											2021-10-26 14:29:31 +01:00
										 |  |  |  |       g_value_set_boolean (value, G_IS_DELAYED_SETTINGS_BACKEND (settings->priv->backend)); | 
					
						
							| 
									
										
										
										
											2010-12-20 09:16:05 -05:00
										 |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |      default: | 
					
						
							|  |  |  |  |       g_assert_not_reached (); | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-09-09 15:45:53 -04:00
										 |  |  |  | static const GSettingsListenerVTable listener_vtable = { | 
					
						
							|  |  |  |  |   settings_backend_changed, | 
					
						
							|  |  |  |  |   settings_backend_path_changed, | 
					
						
							|  |  |  |  |   settings_backend_keys_changed, | 
					
						
							|  |  |  |  |   settings_backend_writable_changed, | 
					
						
							|  |  |  |  |   settings_backend_path_writable_changed | 
					
						
							|  |  |  |  | }; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_constructed (GObject *object) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettings *settings = G_SETTINGS (object); | 
					
						
							|  |  |  |  |   const gchar *schema_path; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   schema_path = g_settings_schema_get_path (settings->priv->schema); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (settings->priv->path && schema_path && strcmp (settings->priv->path, schema_path) != 0) | 
					
						
							| 
									
										
										
										
											2011-11-15 11:56:18 +00:00
										 |  |  |  |     g_error ("settings object created with schema '%s' and path '%s', but path '%s' is specified by schema", | 
					
						
							|  |  |  |  |              g_settings_schema_get_id (settings->priv->schema), settings->priv->path, schema_path); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (settings->priv->path == NULL) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       if (schema_path == NULL) | 
					
						
							| 
									
										
										
										
											2011-10-03 10:19:14 -04:00
										 |  |  |  |         g_error ("attempting to create schema '%s' without a path", | 
					
						
							| 
									
										
										
										
											2011-11-15 11:56:18 +00:00
										 |  |  |  |                  g_settings_schema_get_id (settings->priv->schema)); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |       settings->priv->path = g_strdup (schema_path); | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |   if (settings->priv->backend == NULL) | 
					
						
							| 
									
										
										
										
											2021-10-26 14:29:31 +01:00
										 |  |  |  |     settings->priv->backend = g_settings_backend_get_default (); | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-09-09 15:45:53 -04:00
										 |  |  |  |   g_settings_backend_watch (settings->priv->backend, | 
					
						
							|  |  |  |  |                             &listener_vtable, G_OBJECT (settings), | 
					
						
							|  |  |  |  |                             settings->priv->main_context); | 
					
						
							| 
									
										
										
										
											2015-09-01 10:21:26 -04:00
										 |  |  |  |   g_settings_backend_subscribe (settings->priv->backend, | 
					
						
							|  |  |  |  |                                 settings->priv->path); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_finalize (GObject *object) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettings *settings = G_SETTINGS (object); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-09-01 10:21:26 -04:00
										 |  |  |  |   g_settings_backend_unsubscribe (settings->priv->backend, | 
					
						
							|  |  |  |  |                                   settings->priv->path); | 
					
						
							| 
									
										
										
										
											2010-05-16 13:02:23 +02:00
										 |  |  |  |   g_main_context_unref (settings->priv->main_context); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |   g_object_unref (settings->priv->backend); | 
					
						
							| 
									
										
										
										
											2011-11-13 21:38:31 +01:00
										 |  |  |  |   g_settings_schema_unref (settings->priv->schema); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |   g_free (settings->priv->path); | 
					
						
							| 
									
										
										
										
											2010-07-10 17:12:31 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   G_OBJECT_CLASS (g_settings_parent_class)->finalize (object); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_init (GSettings *settings) | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2013-06-24 15:43:04 +01:00
										 |  |  |  |   settings->priv = g_settings_get_instance_private (settings); | 
					
						
							| 
									
										
										
										
											2011-10-05 10:46:57 -04:00
										 |  |  |  |   settings->priv->main_context = g_main_context_ref_thread_default (); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_class_init (GSettingsClass *class) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GObjectClass *object_class = G_OBJECT_CLASS (class); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   class->writable_change_event = g_settings_real_writable_change_event; | 
					
						
							|  |  |  |  |   class->change_event = g_settings_real_change_event; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   object_class->set_property = g_settings_set_property; | 
					
						
							|  |  |  |  |   object_class->get_property = g_settings_get_property; | 
					
						
							|  |  |  |  |   object_class->constructed = g_settings_constructed; | 
					
						
							|  |  |  |  |   object_class->finalize = g_settings_finalize; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   /**
 | 
					
						
							|  |  |  |  |    * GSettings::changed: | 
					
						
							|  |  |  |  |    * @settings: the object on which the signal was emitted | 
					
						
							| 
									
										
										
										
											2010-04-20 16:14:11 +01:00
										 |  |  |  |    * @key: the name of the key that changed | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * Emitted when a key has potentially changed. | 
					
						
							|  |  |  |  |    * | 
					
						
							|  |  |  |  |    * You should call one of the [method@Gio.Settings.get] calls to check the new | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * value. | 
					
						
							|  |  |  |  |    * | 
					
						
							|  |  |  |  |    * This signal supports detailed connections.  You can connect to the | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * detailed signal `changed::x` in order to only receive callbacks | 
					
						
							|  |  |  |  |    * when key `x` changes. | 
					
						
							| 
									
										
										
										
											2015-06-02 07:10:31 +02:00
										 |  |  |  |    * | 
					
						
							|  |  |  |  |    * Note that @settings only emits this signal if you have read @key at | 
					
						
							|  |  |  |  |    * least once while a signal handler was already connected for @key. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    */ | 
					
						
							|  |  |  |  |   g_settings_signals[SIGNAL_CHANGED] = | 
					
						
							| 
									
										
										
										
											2015-09-12 00:00:40 -04:00
										 |  |  |  |     g_signal_new (I_("changed"), G_TYPE_SETTINGS, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                   G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED, | 
					
						
							|  |  |  |  |                   G_STRUCT_OFFSET (GSettingsClass, changed), | 
					
						
							| 
									
										
										
										
											2019-05-30 19:13:37 -07:00
										 |  |  |  |                   NULL, NULL, NULL, G_TYPE_NONE, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                   1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   /**
 | 
					
						
							|  |  |  |  |    * GSettings::change-event: | 
					
						
							|  |  |  |  |    * @settings: the object on which the signal was emitted | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * @keys: (array length=n_keys) (element-type GQuark) (nullable): array of the | 
					
						
							|  |  |  |  |    *   keys which have changed | 
					
						
							|  |  |  |  |    * @n_keys: the length of the @keys array, or `0` | 
					
						
							|  |  |  |  |    * | 
					
						
							|  |  |  |  |    * Emitted once per change event that affects this settings object. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * You should connect to this signal | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * only if you are interested in viewing groups of changes before they | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * are split out into multiple emissions of the [signal@Gio.Settings::changed] signal. | 
					
						
							|  |  |  |  |    * For most use cases it is more appropriate to use the [signal@Gio.Settings::changed] signal. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * | 
					
						
							|  |  |  |  |    * In the event that the change event applies to one or more specified | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * keys, @keys will be an array of [alias@GLib.Quark]s of length @n_keys.  In the | 
					
						
							|  |  |  |  |    * event that the change event applies to the [class@Gio.Settings] object as a | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * whole (ie: potentially every key has been changed) then @keys will | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * be `NULL` and @n_keys will be `0`. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * The default handler for this signal invokes the [signal@Gio.Settings::changed] signal | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * for each affected key.  If any other connected handler returns | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * true then this default functionality will be suppressed. | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |    * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * Returns: true to stop other handlers from being invoked for the | 
					
						
							|  |  |  |  |    *   event, false to propagate the event further | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    */ | 
					
						
							|  |  |  |  |   g_settings_signals[SIGNAL_CHANGE_EVENT] = | 
					
						
							| 
									
										
										
										
											2015-09-12 00:00:40 -04:00
										 |  |  |  |     g_signal_new (I_("change-event"), G_TYPE_SETTINGS, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                   G_SIGNAL_RUN_LAST, | 
					
						
							|  |  |  |  |                   G_STRUCT_OFFSET (GSettingsClass, change_event), | 
					
						
							|  |  |  |  |                   g_signal_accumulator_true_handled, NULL, | 
					
						
							| 
									
										
										
										
											2019-05-30 19:29:18 -07:00
										 |  |  |  |                   _g_cclosure_marshal_BOOLEAN__POINTER_INT, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                   G_TYPE_BOOLEAN, 2, G_TYPE_POINTER, G_TYPE_INT); | 
					
						
							| 
									
										
										
										
											2019-05-30 19:29:18 -07:00
										 |  |  |  |   g_signal_set_va_marshaller (g_settings_signals[SIGNAL_CHANGE_EVENT], | 
					
						
							|  |  |  |  |                               G_TYPE_FROM_CLASS (class), | 
					
						
							|  |  |  |  |                               _g_cclosure_marshal_BOOLEAN__POINTER_INTv); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   /**
 | 
					
						
							|  |  |  |  |    * GSettings::writable-changed: | 
					
						
							|  |  |  |  |    * @settings: the object on which the signal was emitted | 
					
						
							|  |  |  |  |    * @key: the key | 
					
						
							|  |  |  |  |    * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * Emitted when the writability of a key has potentially changed. | 
					
						
							|  |  |  |  |    * | 
					
						
							|  |  |  |  |    * You should call [method@Gio.Settings.is_writable] in order to determine the | 
					
						
							|  |  |  |  |    * new status. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * | 
					
						
							|  |  |  |  |    * This signal supports detailed connections.  You can connect to the | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * detailed signal `writable-changed::x` in order to only receive | 
					
						
							|  |  |  |  |    * callbacks when the writability of `x` changes. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    */ | 
					
						
							|  |  |  |  |   g_settings_signals[SIGNAL_WRITABLE_CHANGED] = | 
					
						
							| 
									
										
										
										
											2015-09-12 00:00:40 -04:00
										 |  |  |  |     g_signal_new (I_("writable-changed"), G_TYPE_SETTINGS, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                   G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED, | 
					
						
							| 
									
										
										
										
											2011-01-09 16:43:28 -05:00
										 |  |  |  |                   G_STRUCT_OFFSET (GSettingsClass, writable_changed), | 
					
						
							| 
									
										
										
										
											2019-05-30 19:13:37 -07:00
										 |  |  |  |                   NULL, NULL, NULL, G_TYPE_NONE, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                   1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   /**
 | 
					
						
							|  |  |  |  |    * GSettings::writable-change-event: | 
					
						
							|  |  |  |  |    * @settings: the object on which the signal was emitted | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * @key: the quark of the key, or `0` | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * Emitted once per writability change event that affects this settings object. | 
					
						
							|  |  |  |  |    * | 
					
						
							|  |  |  |  |    * You should connect | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * to this signal if you are interested in viewing groups of changes | 
					
						
							|  |  |  |  |    * before they are split out into multiple emissions of the | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * [signal@Gio.Settings::writable-changed] signal.  For most use cases it is more | 
					
						
							|  |  |  |  |    * appropriate to use the [signal@Gio.Settings::writable-changed] signal. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * | 
					
						
							|  |  |  |  |    * In the event that the writability change applies only to a single | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * key, @key will be set to the [alias@GLib.Quark] for that key.  In the event | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * that the writability change affects the entire settings object, | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * @key will be `0`. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * The default handler for this signal invokes the [signal@Gio.Settings::writable-changed] | 
					
						
							|  |  |  |  |    * and [signal@Gio.Settings::changed] signals for each affected key.  This is done because | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * changes in writability might also imply changes in value (if for | 
					
						
							|  |  |  |  |    * example, a new mandatory setting is introduced).  If any other | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * connected handler returns true then this default functionality | 
					
						
							| 
									
										
										
										
											2011-08-29 14:49:32 -04:00
										 |  |  |  |    * will be suppressed. | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |    * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * Returns: true to stop other handlers from being invoked for the | 
					
						
							|  |  |  |  |    *   event, false to propagate the event further | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    */ | 
					
						
							|  |  |  |  |   g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT] = | 
					
						
							| 
									
										
										
										
											2015-09-12 00:00:40 -04:00
										 |  |  |  |     g_signal_new (I_("writable-change-event"), G_TYPE_SETTINGS, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                   G_SIGNAL_RUN_LAST, | 
					
						
							|  |  |  |  |                   G_STRUCT_OFFSET (GSettingsClass, writable_change_event), | 
					
						
							|  |  |  |  |                   g_signal_accumulator_true_handled, NULL, | 
					
						
							| 
									
										
										
										
											2019-05-30 19:29:18 -07:00
										 |  |  |  |                   _g_cclosure_marshal_BOOLEAN__UINT, | 
					
						
							|  |  |  |  |                   G_TYPE_BOOLEAN, 1, G_TYPE_UINT); | 
					
						
							|  |  |  |  |   g_signal_set_va_marshaller (g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT], | 
					
						
							|  |  |  |  |                               G_TYPE_FROM_CLASS (class), | 
					
						
							|  |  |  |  |                               _g_cclosure_marshal_BOOLEAN__UINTv); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   /**
 | 
					
						
							| 
									
										
										
										
											2017-09-11 21:28:40 +01:00
										 |  |  |  |    * GSettings:backend: | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |    * | 
					
						
							|  |  |  |  |    * The name of the context that the settings are stored in. | 
					
						
							|  |  |  |  |    */ | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |   g_object_class_install_property (object_class, PROP_BACKEND, | 
					
						
							| 
									
										
										
										
											2023-04-28 01:59:26 +02:00
										 |  |  |  |     g_param_spec_object ("backend", NULL, NULL, | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |                          G_TYPE_SETTINGS_BACKEND, G_PARAM_CONSTRUCT_ONLY | | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-15 12:16:50 +00:00
										 |  |  |  |   /**
 | 
					
						
							|  |  |  |  |    * GSettings:settings-schema: | 
					
						
							|  |  |  |  |    * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * The [struct@Gio.SettingsSchema] describing the types of keys for this | 
					
						
							|  |  |  |  |    * [class@Gio.Settings] object. | 
					
						
							| 
									
										
										
										
											2011-11-15 12:16:50 +00:00
										 |  |  |  |    * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * Ideally, this property would be called [property@Gio.Settings:schema]. | 
					
						
							|  |  |  |  |    * [struct@Gio.SettingsSchema] | 
					
						
							| 
									
										
										
										
											2011-11-15 12:16:50 +00:00
										 |  |  |  |    * has only existed since version 2.32, however, and before then the | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * [property@Gio.Settings:schema] property was used to refer to the ID of the schema rather | 
					
						
							| 
									
										
										
										
											2011-11-15 12:16:50 +00:00
										 |  |  |  |    * than the schema itself.  Take care. | 
					
						
							|  |  |  |  |    */ | 
					
						
							|  |  |  |  |   g_object_class_install_property (object_class, PROP_SCHEMA, | 
					
						
							| 
									
										
										
										
											2023-04-28 01:59:26 +02:00
										 |  |  |  |     g_param_spec_boxed ("settings-schema", NULL, NULL, | 
					
						
							| 
									
										
										
										
											2011-11-15 12:16:50 +00:00
										 |  |  |  |                         G_TYPE_SETTINGS_SCHEMA, | 
					
						
							|  |  |  |  |                         G_PARAM_CONSTRUCT_ONLY | | 
					
						
							|  |  |  |  |                         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-06-24 16:56:20 -04:00
										 |  |  |  |   /**
 | 
					
						
							|  |  |  |  |    * GSettings:schema: | 
					
						
							|  |  |  |  |    * | 
					
						
							|  |  |  |  |    * The name of the schema that describes the types of keys | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * for this [class@Gio.Settings] object. | 
					
						
							| 
									
										
										
										
											2014-06-24 16:56:20 -04:00
										 |  |  |  |    * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * The type of this property is *not* [struct@Gio.SettingsSchema]. | 
					
						
							|  |  |  |  |    * [struct@Gio.SettingsSchema] has only existed since version 2.32 and | 
					
						
							| 
									
										
										
										
											2014-06-24 16:56:20 -04:00
										 |  |  |  |    * unfortunately this name was used in previous versions to refer to | 
					
						
							|  |  |  |  |    * the schema ID rather than the schema itself.  Take care to use the | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * [property@Gio.Settings:settings-schema] property if you wish to pass in a | 
					
						
							|  |  |  |  |    * [struct@Gio.SettingsSchema]. | 
					
						
							| 
									
										
										
										
											2014-06-24 16:56:20 -04:00
										 |  |  |  |    * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * Deprecated:2.32:Use the [property@Gio.Settings:schema-id] property instead. | 
					
						
							|  |  |  |  |    *   In a future version, this property may instead refer to a [struct@Gio.SettingsSchema]. | 
					
						
							| 
									
										
										
										
											2014-06-24 16:56:20 -04:00
										 |  |  |  |    */ | 
					
						
							|  |  |  |  |   g_object_class_install_property (object_class, PROP_SCHEMA_ID, | 
					
						
							| 
									
										
										
										
											2023-04-28 01:59:26 +02:00
										 |  |  |  |     g_param_spec_string ("schema", NULL, NULL, | 
					
						
							| 
									
										
										
										
											2014-06-24 16:56:20 -04:00
										 |  |  |  |                          NULL, | 
					
						
							|  |  |  |  |                          G_PARAM_CONSTRUCT_ONLY | | 
					
						
							|  |  |  |  |                          G_PARAM_DEPRECATED | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-15 11:31:58 +00:00
										 |  |  |  |   /**
 | 
					
						
							| 
									
										
										
										
											2011-11-15 11:39:12 +00:00
										 |  |  |  |    * GSettings:schema-id: | 
					
						
							| 
									
										
										
										
											2011-11-15 11:31:58 +00:00
										 |  |  |  |    * | 
					
						
							|  |  |  |  |    * The name of the schema that describes the types of keys | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |    * for this [class@Gio.Settings] object. | 
					
						
							| 
									
										
										
										
											2011-11-15 11:31:58 +00:00
										 |  |  |  |    */ | 
					
						
							| 
									
										
										
										
											2011-11-15 11:39:12 +00:00
										 |  |  |  |   g_object_class_install_property (object_class, PROP_SCHEMA_ID, | 
					
						
							| 
									
										
										
										
											2023-04-28 01:59:26 +02:00
										 |  |  |  |     g_param_spec_string ("schema-id", NULL, NULL, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                          NULL, | 
					
						
							|  |  |  |  |                          G_PARAM_CONSTRUCT_ONLY | | 
					
						
							|  |  |  |  |                          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |    /**
 | 
					
						
							|  |  |  |  |     * GSettings:path: | 
					
						
							|  |  |  |  |     * | 
					
						
							|  |  |  |  |     * The path within the backend where the settings are stored. | 
					
						
							|  |  |  |  |     */ | 
					
						
							|  |  |  |  |    g_object_class_install_property (object_class, PROP_PATH, | 
					
						
							| 
									
										
										
										
											2023-04-28 01:59:26 +02:00
										 |  |  |  |      g_param_spec_string ("path", NULL, NULL, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                           NULL, | 
					
						
							|  |  |  |  |                           G_PARAM_CONSTRUCT_ONLY | | 
					
						
							|  |  |  |  |                           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |    /**
 | 
					
						
							|  |  |  |  |     * GSettings:has-unapplied: | 
					
						
							|  |  |  |  |     * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |     * Whether the [class@Gio.Settings] object has outstanding changes. | 
					
						
							|  |  |  |  |     * | 
					
						
							|  |  |  |  |     * These changes will be applied when [method@Gio.Settings.apply] is called. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |     */ | 
					
						
							|  |  |  |  |    g_object_class_install_property (object_class, PROP_HAS_UNAPPLIED, | 
					
						
							| 
									
										
										
										
											2023-04-28 01:59:26 +02:00
										 |  |  |  |      g_param_spec_boolean ("has-unapplied", NULL, NULL, | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |                            FALSE, | 
					
						
							|  |  |  |  |                            G_PARAM_READABLE | G_PARAM_STATIC_STRINGS)); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-12-20 09:16:05 -05:00
										 |  |  |  |    /**
 | 
					
						
							|  |  |  |  |     * GSettings:delay-apply: | 
					
						
							|  |  |  |  |     * | 
					
						
							| 
									
										
										
										
											2025-03-04 14:03:04 +00:00
										 |  |  |  |     * Whether the [class@Gio.Settings] object is in | 
					
						
							|  |  |  |  |     * [‘delay-apply’ mode](class.Settings.html#delay-apply-mode). | 
					
						
							| 
									
										
										
										
											2010-12-20 09:16:05 -05:00
										 |  |  |  |     * | 
					
						
							|  |  |  |  |     * Since: 2.28 | 
					
						
							|  |  |  |  |     */ | 
					
						
							|  |  |  |  |    g_object_class_install_property (object_class, PROP_DELAY_APPLY, | 
					
						
							| 
									
										
										
										
											2023-04-28 01:59:26 +02:00
										 |  |  |  |      g_param_spec_boolean ("delay-apply", NULL, NULL, | 
					
						
							| 
									
										
										
										
											2010-12-20 09:16:05 -05:00
										 |  |  |  |                            FALSE, | 
					
						
							|  |  |  |  |                            G_PARAM_READABLE | G_PARAM_STATIC_STRINGS)); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /* Construction (new, new_with_path, etc.) {{{1 */ | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * g_settings_new: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @schema_id: the ID of the schema | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Creates a new [class@Gio.Settings] object with the schema specified by | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  |  * @schema_id. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2020-08-24 09:02:43 +00:00
										 |  |  |  |  * It is an error for the schema to not exist: schemas are an | 
					
						
							|  |  |  |  |  * essential part of a program, as they provide type information. | 
					
						
							|  |  |  |  |  * If schemas need to be dynamically loaded (for example, from an | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * optional runtime dependency), [method@Gio.SettingsSchemaSource.lookup] | 
					
						
							| 
									
										
										
										
											2020-08-24 09:02:43 +00:00
										 |  |  |  |  * can be used to test for their existence before loading them. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Signals on the newly created [class@Gio.Settings] object will be dispatched | 
					
						
							|  |  |  |  |  * via the thread-default [struct@GLib.MainContext] in effect at the time of the | 
					
						
							|  |  |  |  |  * call to [ctor@Gio.Settings.new].  The new [class@Gio.Settings] will hold a reference | 
					
						
							|  |  |  |  |  * on the context.  See [method@GLib.MainContext.push_thread_default]. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: (not nullable) (transfer full): a new [class@Gio.Settings] object | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | GSettings * | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  | g_settings_new (const gchar *schema_id) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  |   g_return_val_if_fail (schema_id != NULL, NULL); | 
					
						
							| 
									
										
										
										
											2010-04-22 03:07:49 +02:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   return g_object_new (G_TYPE_SETTINGS, | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  |                        "schema-id", schema_id, | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |                        NULL); | 
					
						
							|  |  |  |  | } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2013-10-23 16:42:12 -04:00
										 |  |  |  | static gboolean | 
					
						
							|  |  |  |  | path_is_valid (const gchar *path) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   if (!path) | 
					
						
							|  |  |  |  |     return FALSE; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (path[0] != '/') | 
					
						
							|  |  |  |  |     return FALSE; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (!g_str_has_suffix (path, "/")) | 
					
						
							|  |  |  |  |     return FALSE; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return strstr (path, "//") == NULL; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_new_with_path: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @schema_id: the ID of the schema | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @path: the path to use | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Creates a new [class@Gio.Settings] object with the relocatable schema specified | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  |  * by @schema_id and a given path. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * You only need to do this if you want to directly create a settings | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * object with a schema that doesn’t have a specified path of its own. | 
					
						
							|  |  |  |  |  * That’s quite rare. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * It is a programmer error to call this function for a schema that | 
					
						
							|  |  |  |  |  * has an explicitly specified path. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2013-10-23 16:42:12 -04:00
										 |  |  |  |  * It is a programmer error if @path is not a valid path.  A valid path | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * begins and ends with `/` and does not contain two consecutive `/` | 
					
						
							| 
									
										
										
										
											2013-10-23 16:42:12 -04:00
										 |  |  |  |  * characters. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: (not nullable) (transfer full): a new [class@Gio.Settings] object | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | GSettings * | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  | g_settings_new_with_path (const gchar *schema_id, | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |                           const gchar *path) | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  |   g_return_val_if_fail (schema_id != NULL, NULL); | 
					
						
							| 
									
										
										
										
											2013-10-23 16:42:12 -04:00
										 |  |  |  |   g_return_val_if_fail (path_is_valid (path), NULL); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   return g_object_new (G_TYPE_SETTINGS, | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  |                        "schema-id", schema_id, | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |                        "path", path, | 
					
						
							|  |  |  |  |                        NULL); | 
					
						
							|  |  |  |  | } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |  * g_settings_new_with_backend: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @schema_id: the ID of the schema | 
					
						
							|  |  |  |  |  * @backend: the settings backend to use | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Creates a new [class@Gio.Settings] object with the schema specified by | 
					
						
							|  |  |  |  |  * @schema_id and a given [class@Gio.SettingsBackend]. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Creating a [class@Gio.Settings] object with a different backend allows accessing | 
					
						
							| 
									
										
										
										
											2011-04-14 20:41:54 -04:00
										 |  |  |  |  * settings from a database other than the usual one. For example, it may make | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * sense to pass a backend corresponding to the ‘defaults’ settings database on | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |  * the system to get a settings object that modifies the system default | 
					
						
							|  |  |  |  |  * settings instead of the settings for this user. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: (not nullable) (transfer full): a new [class@Gio.Settings] object | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | GSettings * | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  | g_settings_new_with_backend (const gchar      *schema_id, | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |                              GSettingsBackend *backend) | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  |   g_return_val_if_fail (schema_id != NULL, NULL); | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   return g_object_new (G_TYPE_SETTINGS, | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  |                        "schema-id", schema_id, | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |                        "backend", backend, | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |                        NULL); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |  * g_settings_new_with_backend_and_path: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @schema_id: the ID of the schema | 
					
						
							|  |  |  |  |  * @backend: the settings backend to use | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @path: the path to use | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Creates a new [class@Gio.Settings] object with the schema specified by | 
					
						
							|  |  |  |  |  * @schema_id and a given [class@Gio.SettingsBackend] and path. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * This is a mix of [ctor@Gio.Settings.new_with_backend] and | 
					
						
							|  |  |  |  |  * [ctor@Gio.Settings.new_with_path]. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: (not nullable) (transfer full): a new [class@Gio.Settings] object | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | GSettings * | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  | g_settings_new_with_backend_and_path (const gchar      *schema_id, | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |                                       GSettingsBackend *backend, | 
					
						
							|  |  |  |  |                                       const gchar      *path) | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  |   g_return_val_if_fail (schema_id != NULL, NULL); | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL); | 
					
						
							| 
									
										
										
										
											2013-10-23 16:42:12 -04:00
										 |  |  |  |   g_return_val_if_fail (path_is_valid (path), NULL); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   return g_object_new (G_TYPE_SETTINGS, | 
					
						
							| 
									
										
										
										
											2011-11-15 12:42:02 +00:00
										 |  |  |  |                        "schema-id", schema_id, | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |                        "backend", backend, | 
					
						
							|  |  |  |  |                        "path", path, | 
					
						
							|  |  |  |  |                        NULL); | 
					
						
							| 
									
										
										
										
											2011-11-15 12:38:01 +00:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_new_full: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @schema: the schema describing the settings | 
					
						
							|  |  |  |  |  * @backend: (nullable): the settings backend to use | 
					
						
							| 
									
										
										
										
											2016-10-28 18:29:02 -07:00
										 |  |  |  |  * @path: (nullable): the path to use | 
					
						
							| 
									
										
										
										
											2011-11-15 12:38:01 +00:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Creates a new [class@Gio.Settings] object with a given schema, backend and | 
					
						
							| 
									
										
										
										
											2011-11-15 12:38:01 +00:00
										 |  |  |  |  * path. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * It should be extremely rare that you ever want to use this function. | 
					
						
							|  |  |  |  |  * It is made available for advanced use-cases (such as plugin systems | 
					
						
							|  |  |  |  |  * that want to provide access to schemas loaded from custom locations, | 
					
						
							|  |  |  |  |  * etc). | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * At the most basic level, a [class@Gio.Settings] object is a pure composition of | 
					
						
							|  |  |  |  |  * four things: a [struct@Gio.SettingsSchema], a [class@Gio.SettingsBackend], a path within that | 
					
						
							|  |  |  |  |  * backend, and a [struct@GLib.MainContext] to which signals are dispatched. | 
					
						
							| 
									
										
										
										
											2011-11-15 12:38:01 +00:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * This constructor therefore gives you full control over constructing | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * [class@Gio.Settings] instances.  The first 3 parameters are given directly as | 
					
						
							| 
									
										
										
										
											2011-11-15 12:38:01 +00:00
										 |  |  |  |  * @schema, @backend and @path, and the main context is taken from the | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * thread-default (as per [ctor@Gio.Settings.new]). | 
					
						
							| 
									
										
										
										
											2011-11-15 12:38:01 +00:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * If @backend is `NULL` then the default backend is used. | 
					
						
							| 
									
										
										
										
											2011-11-17 17:33:19 +00:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * If @path is `NULL` then the path from the schema is used.  It is an | 
					
						
							|  |  |  |  |  * error if @path is `NULL` and the schema has no path of its own or if | 
					
						
							|  |  |  |  |  * @path is non-`NULL` and not equal to the path that the schema does | 
					
						
							| 
									
										
										
										
											2011-11-17 17:33:19 +00:00
										 |  |  |  |  * have. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: (not nullable) (transfer full): a new [class@Gio.Settings] object | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-11-15 12:38:01 +00:00
										 |  |  |  |  * Since: 2.32 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | GSettings * | 
					
						
							|  |  |  |  | g_settings_new_full (GSettingsSchema  *schema, | 
					
						
							|  |  |  |  |                      GSettingsBackend *backend, | 
					
						
							|  |  |  |  |                      const gchar      *path) | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2013-10-23 16:42:12 -04:00
										 |  |  |  |   g_return_val_if_fail (schema != NULL, NULL); | 
					
						
							|  |  |  |  |   g_return_val_if_fail (backend == NULL || G_IS_SETTINGS_BACKEND (backend), NULL); | 
					
						
							|  |  |  |  |   g_return_val_if_fail (path == NULL || path_is_valid (path), NULL); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-15 12:38:01 +00:00
										 |  |  |  |   return g_object_new (G_TYPE_SETTINGS, | 
					
						
							|  |  |  |  |                        "settings-schema", schema, | 
					
						
							|  |  |  |  |                        "backend", backend, | 
					
						
							| 
									
										
										
										
											2011-11-16 10:38:04 +00:00
										 |  |  |  |                        "path", path, | 
					
						
							|  |  |  |  |                        NULL); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-14 17:15:58 +01:00
										 |  |  |  | /* Internal read/write utilities {{{1 */ | 
					
						
							| 
									
										
										
										
											2019-01-23 15:15:53 +00:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  | /* @value will be sunk */ | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | static gboolean | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  | g_settings_write_to_backend (GSettings          *settings, | 
					
						
							|  |  |  |  |                              GSettingsSchemaKey *key, | 
					
						
							|  |  |  |  |                              GVariant           *value) | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | { | 
					
						
							|  |  |  |  |   gboolean success; | 
					
						
							|  |  |  |  |   gchar *path; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   path = g_strconcat (settings->priv->path, key->name, NULL); | 
					
						
							| 
									
										
										
										
											2011-11-13 23:35:27 +01:00
										 |  |  |  |   success = g_settings_backend_write (settings->priv->backend, path, value, NULL); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_free (path); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return success; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static GVariant * | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  | g_settings_read_from_backend (GSettings          *settings, | 
					
						
							| 
									
										
										
										
											2013-10-27 10:33:08 -07:00
										 |  |  |  |                               GSettingsSchemaKey *key, | 
					
						
							|  |  |  |  |                               gboolean            user_value_only, | 
					
						
							|  |  |  |  |                               gboolean            default_value) | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | { | 
					
						
							|  |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   GVariant *fixup; | 
					
						
							|  |  |  |  |   gchar *path; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   path = g_strconcat (settings->priv->path, key->name, NULL); | 
					
						
							| 
									
										
										
										
											2013-10-27 10:33:08 -07:00
										 |  |  |  |   if (user_value_only) | 
					
						
							|  |  |  |  |     value = g_settings_backend_read_user_value (settings->priv->backend, path, key->type); | 
					
						
							|  |  |  |  |   else | 
					
						
							|  |  |  |  |     value = g_settings_backend_read (settings->priv->backend, path, key->type, default_value); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_free (path); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (value != NULL) | 
					
						
							|  |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |       fixup = g_settings_schema_key_range_fixup (key, value); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       g_variant_unref (value); | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  |   else | 
					
						
							|  |  |  |  |     fixup = NULL; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return fixup; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  | /* Public Get/Set API {{{1 (get, get_value, set, set_value, get_mapped) */ | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get_value: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @key: the key to get the value for | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Gets the value that is stored in @settings for @key. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t contained in the | 
					
						
							| 
									
										
										
										
											2010-06-24 02:28:01 -04:00
										 |  |  |  |  * schema for @settings. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: (not nullable) (transfer full): a new [struct@GLib.Variant] | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | GVariant * | 
					
						
							|  |  |  |  | g_settings_get_value (GSettings   *settings, | 
					
						
							|  |  |  |  |                       const gchar *key) | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   GSettingsSchemaKey skey; | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL); | 
					
						
							|  |  |  |  |   g_return_val_if_fail (key != NULL, NULL); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-14 17:03:57 +01:00
										 |  |  |  |   g_settings_schema_key_init (&skey, settings->priv->schema, key); | 
					
						
							| 
									
										
										
										
											2013-10-27 10:33:08 -07:00
										 |  |  |  |   value = g_settings_read_from_backend (settings, &skey, FALSE, FALSE); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (value == NULL) | 
					
						
							| 
									
										
										
										
											2017-08-02 11:06:03 +01:00
										 |  |  |  |     value = g_settings_schema_key_get_default_value (&skey); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   g_settings_schema_key_clear (&skey); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   return value; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get_user_value: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2013-11-08 20:57:04 -05:00
										 |  |  |  |  * @key: the key to get the user value for | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Checks the ‘user value’ of a key, if there is one. | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * The user value of a key is the last value that was set by the user. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * After calling [method@Gio.Settings.reset] this function should always return | 
					
						
							|  |  |  |  |  * `NULL` (assuming something is not wrong with the system | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * configuration). | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is possible that [method@Gio.Settings.get_value] will return a different | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * value than this function.  This can happen in the case that the user | 
					
						
							|  |  |  |  |  * set a value for a key that was subsequently locked down by the system | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * administrator — this function will return the user’s old value. | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * This function may be useful for adding a ‘reset’ option to a UI or | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * for providing indication that a particular value has been changed. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t contained in the | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * schema for @settings. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: (nullable) (transfer full): the user’s value, if set | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.40 | 
					
						
							|  |  |  |  |  **/ | 
					
						
							|  |  |  |  | GVariant * | 
					
						
							|  |  |  |  | g_settings_get_user_value (GSettings   *settings, | 
					
						
							|  |  |  |  |                            const gchar *key) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsSchemaKey skey; | 
					
						
							|  |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL); | 
					
						
							|  |  |  |  |   g_return_val_if_fail (key != NULL, NULL); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_settings_schema_key_init (&skey, settings->priv->schema, key); | 
					
						
							|  |  |  |  |   value = g_settings_read_from_backend (settings, &skey, TRUE, FALSE); | 
					
						
							|  |  |  |  |   g_settings_schema_key_clear (&skey); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return value; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get_default_value: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2013-11-08 20:57:04 -05:00
										 |  |  |  |  * @key: the key to get the default value for | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Gets the ‘default value’ of a key. | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * This is the value that would be read if [method@Gio.Settings.reset] were to be | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * called on the key. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Note that this may be a different value than returned by | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * [method@Gio.SettingsSchemaKey.get_default_value] if the system administrator | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * has provided a default value. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Comparing the return values of [method@Gio.Settings.get_default_value] and | 
					
						
							|  |  |  |  |  * [method@Gio.Settings.get_value] is not sufficient for determining if a value | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * has been set because the user may have explicitly set the value to | 
					
						
							|  |  |  |  |  * something that happens to be equal to the default.  The difference | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * here is that if the default changes in the future, the user’s key | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * will still be set. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * This function may be useful for adding an indication to a UI of what | 
					
						
							|  |  |  |  |  * the default value was before the user set it. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t contained in the | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * schema for @settings. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2016-10-28 18:29:02 -07:00
										 |  |  |  |  * Returns: (nullable) (transfer full): the default value | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.40 | 
					
						
							|  |  |  |  |  **/ | 
					
						
							|  |  |  |  | GVariant * | 
					
						
							|  |  |  |  | g_settings_get_default_value (GSettings   *settings, | 
					
						
							|  |  |  |  |                               const gchar *key) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsSchemaKey skey; | 
					
						
							|  |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL); | 
					
						
							|  |  |  |  |   g_return_val_if_fail (key != NULL, NULL); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_settings_schema_key_init (&skey, settings->priv->schema, key); | 
					
						
							|  |  |  |  |   value = g_settings_read_from_backend (settings, &skey, FALSE, TRUE); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (value == NULL) | 
					
						
							| 
									
										
										
										
											2017-08-02 11:06:03 +01:00
										 |  |  |  |     value = g_settings_schema_key_get_default_value (&skey); | 
					
						
							| 
									
										
										
										
											2013-10-27 10:34:01 -07:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_settings_schema_key_clear (&skey); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return value; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get_enum: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @key: the key to get the value for | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Gets the value that is stored in @settings for @key and converts it | 
					
						
							|  |  |  |  |  * to the enum value that it represents. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * In order to use this function the type of the value must be a string | 
					
						
							|  |  |  |  |  * and it must be marked in the schema file as an enumerated type. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t contained in the | 
					
						
							| 
									
										
										
										
											2010-06-24 02:28:01 -04:00
										 |  |  |  |  * schema for @settings or is not marked as an enumerated type. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * If the value stored in the configuration database is not a valid | 
					
						
							|  |  |  |  |  * value for the enumerated type then this function will return the | 
					
						
							|  |  |  |  |  * default value. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * Returns: the enum value | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  **/ | 
					
						
							|  |  |  |  | gint | 
					
						
							|  |  |  |  | g_settings_get_enum (GSettings   *settings, | 
					
						
							|  |  |  |  |                      const gchar *key) | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   GSettingsSchemaKey skey; | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   gint result; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS (settings), -1); | 
					
						
							|  |  |  |  |   g_return_val_if_fail (key != NULL, -1); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-14 17:03:57 +01:00
										 |  |  |  |   g_settings_schema_key_init (&skey, settings->priv->schema, key); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   if (!skey.is_enum) | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2013-05-20 17:54:48 -03:00
										 |  |  |  |       g_critical ("g_settings_get_enum() called on key '%s' which is not " | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |                   "associated with an enumerated type", skey.name); | 
					
						
							|  |  |  |  |       g_settings_schema_key_clear (&skey); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       return -1; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2013-10-27 10:33:08 -07:00
										 |  |  |  |   value = g_settings_read_from_backend (settings, &skey, FALSE, FALSE); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (value == NULL) | 
					
						
							| 
									
										
										
										
											2017-08-02 11:06:03 +01:00
										 |  |  |  |     value = g_settings_schema_key_get_default_value (&skey); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   result = g_settings_schema_key_to_enum (&skey, value); | 
					
						
							|  |  |  |  |   g_settings_schema_key_clear (&skey); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_variant_unref (value); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return result; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_set_enum: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * @key: the key to set the value for | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @value: an enumerated value | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Looks up the enumerated type nick for @value and writes it to @key, | 
					
						
							|  |  |  |  |  * within @settings. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t contained in the | 
					
						
							| 
									
										
										
										
											2010-06-24 02:28:01 -04:00
										 |  |  |  |  * schema for @settings or is not marked as an enumerated type, or for | 
					
						
							|  |  |  |  |  * @value not to be a valid value for the named type. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |  * After performing the write, accessing @key directly with | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * [method@Gio.Settings.get_string] will return the ‘nick’ associated with | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @value. | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if the set succeeds, false otherwise | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  **/ | 
					
						
							|  |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_set_enum (GSettings   *settings, | 
					
						
							|  |  |  |  |                      const gchar *key, | 
					
						
							|  |  |  |  |                      gint         value) | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   GSettingsSchemaKey skey; | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GVariant *variant; | 
					
						
							|  |  |  |  |   gboolean success; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE); | 
					
						
							|  |  |  |  |   g_return_val_if_fail (key != NULL, FALSE); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-14 17:03:57 +01:00
										 |  |  |  |   g_settings_schema_key_init (&skey, settings->priv->schema, key); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   if (!skey.is_enum) | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2013-05-20 17:54:48 -03:00
										 |  |  |  |       g_critical ("g_settings_set_enum() called on key '%s' which is not " | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |                   "associated with an enumerated type", skey.name); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       return FALSE; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   if (!(variant = g_settings_schema_key_from_enum (&skey, value))) | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2013-05-20 17:54:48 -03:00
										 |  |  |  |       g_critical ("g_settings_set_enum(): invalid enum value %d for key '%s' " | 
					
						
							|  |  |  |  |                   "in schema '%s'.  Doing nothing.", value, skey.name, | 
					
						
							| 
									
										
										
										
											2011-11-15 11:39:12 +00:00
										 |  |  |  |                   g_settings_schema_get_id (skey.schema)); | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |       g_settings_schema_key_clear (&skey); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       return FALSE; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2019-01-23 15:15:53 +00:00
										 |  |  |  |   success = g_settings_write_to_backend (settings, &skey, g_steal_pointer (&variant)); | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   g_settings_schema_key_clear (&skey); | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   return success; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get_flags: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |  * @key: the key to get the value for | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Gets the value that is stored in @settings for @key and converts it | 
					
						
							|  |  |  |  |  * to the flags value that it represents. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * In order to use this function the type of the value must be an array | 
					
						
							| 
									
										
										
										
											2019-08-23 21:45:16 +00:00
										 |  |  |  |  * of strings and it must be marked in the schema file as a flags type. | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t contained in the | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |  * schema for @settings or is not marked as a flags type. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * If the value stored in the configuration database is not a valid | 
					
						
							|  |  |  |  |  * value for the flags type then this function will return the default | 
					
						
							|  |  |  |  |  * value. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * Returns: the flags value | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  **/ | 
					
						
							|  |  |  |  | guint | 
					
						
							|  |  |  |  | g_settings_get_flags (GSettings   *settings, | 
					
						
							|  |  |  |  |                       const gchar *key) | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   GSettingsSchemaKey skey; | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   guint result; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS (settings), -1); | 
					
						
							|  |  |  |  |   g_return_val_if_fail (key != NULL, -1); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-14 17:03:57 +01:00
										 |  |  |  |   g_settings_schema_key_init (&skey, settings->priv->schema, key); | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   if (!skey.is_flags) | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2013-05-20 17:54:48 -03:00
										 |  |  |  |       g_critical ("g_settings_get_flags() called on key '%s' which is not " | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |                   "associated with a flags type", skey.name); | 
					
						
							|  |  |  |  |       g_settings_schema_key_clear (&skey); | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |       return -1; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2013-10-27 10:33:08 -07:00
										 |  |  |  |   value = g_settings_read_from_backend (settings, &skey, FALSE, FALSE); | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (value == NULL) | 
					
						
							| 
									
										
										
										
											2017-08-02 11:06:03 +01:00
										 |  |  |  |     value = g_settings_schema_key_get_default_value (&skey); | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   result = g_settings_schema_key_to_flags (&skey, value); | 
					
						
							|  |  |  |  |   g_settings_schema_key_clear (&skey); | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |   g_variant_unref (value); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return result; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_set_flags: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * @key: the key to set the value for | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |  * @value: a flags value | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Looks up the flags type nicks for the bits specified by @value, puts | 
					
						
							| 
									
										
										
										
											2011-08-29 14:49:32 -04:00
										 |  |  |  |  * them in an array of strings and writes the array to @key, within | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |  * @settings. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t contained in the | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |  * schema for @settings or is not marked as a flags type, or for @value | 
					
						
							|  |  |  |  |  * to contain any bits that are not value for the named type. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * After performing the write, accessing @key directly with | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * [method@Gio.Settings.get_strv] will return an array of ‘nicks’; one for each | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |  * bit in @value. | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if the set succeeds, false otherwise | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |  **/ | 
					
						
							|  |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_set_flags (GSettings   *settings, | 
					
						
							|  |  |  |  |                       const gchar *key, | 
					
						
							|  |  |  |  |                       guint        value) | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   GSettingsSchemaKey skey; | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |   GVariant *variant; | 
					
						
							|  |  |  |  |   gboolean success; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE); | 
					
						
							|  |  |  |  |   g_return_val_if_fail (key != NULL, FALSE); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-14 17:03:57 +01:00
										 |  |  |  |   g_settings_schema_key_init (&skey, settings->priv->schema, key); | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   if (!skey.is_flags) | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2013-05-20 17:54:48 -03:00
										 |  |  |  |       g_critical ("g_settings_set_flags() called on key '%s' which is not " | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |                   "associated with a flags type", skey.name); | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |       return FALSE; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   if (!(variant = g_settings_schema_key_from_flags (&skey, value))) | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |     { | 
					
						
							|  |  |  |  |       g_critical ("g_settings_set_flags(): invalid flags value 0x%08x " | 
					
						
							| 
									
										
										
										
											2013-05-20 17:54:48 -03:00
										 |  |  |  |                   "for key '%s' in schema '%s'.  Doing nothing.", | 
					
						
							| 
									
										
										
										
											2011-11-15 11:39:12 +00:00
										 |  |  |  |                   value, skey.name, g_settings_schema_get_id (skey.schema)); | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |       g_settings_schema_key_clear (&skey); | 
					
						
							| 
									
										
										
										
											2010-07-01 18:58:56 -04:00
										 |  |  |  |       return FALSE; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2019-01-23 15:15:53 +00:00
										 |  |  |  |   success = g_settings_write_to_backend (settings, &skey, g_steal_pointer (&variant)); | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   g_settings_schema_key_clear (&skey); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   return success; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_set_value: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * @key: the key to set the value for | 
					
						
							|  |  |  |  |  * @value: a [struct@GLib.Variant] of the correct type | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Sets @key in @settings to @value. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t contained in the | 
					
						
							| 
									
										
										
										
											2010-06-24 02:28:01 -04:00
										 |  |  |  |  * schema for @settings or for @value to have the incorrect type, per | 
					
						
							|  |  |  |  |  * the schema. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * If @value is floating then this function consumes the reference. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if setting the key succeeded, | 
					
						
							|  |  |  |  |  *   false if the key was not writable | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  **/ | 
					
						
							|  |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_set_value (GSettings   *settings, | 
					
						
							|  |  |  |  |                       const gchar *key, | 
					
						
							|  |  |  |  |                       GVariant    *value) | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   GSettingsSchemaKey skey; | 
					
						
							| 
									
										
										
										
											2012-01-27 03:00:23 -05:00
										 |  |  |  |   gboolean success; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-04-22 03:07:49 +02:00
										 |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_return_val_if_fail (key != NULL, FALSE); | 
					
						
							| 
									
										
										
										
											2010-04-22 03:07:49 +02:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-02-27 10:04:39 +00:00
										 |  |  |  |   g_variant_ref_sink (value); | 
					
						
							| 
									
										
										
										
											2011-11-14 17:03:57 +01:00
										 |  |  |  |   g_settings_schema_key_init (&skey, settings->priv->schema, key); | 
					
						
							| 
									
										
										
										
											2010-11-05 09:31:36 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   if (!g_settings_schema_key_type_check (&skey, value)) | 
					
						
							| 
									
										
										
										
											2010-11-05 09:31:36 -04:00
										 |  |  |  |     { | 
					
						
							|  |  |  |  |       g_critical ("g_settings_set_value: key '%s' in '%s' expects type '%s', but a GVariant of type '%s' was given", | 
					
						
							|  |  |  |  |                   key, | 
					
						
							| 
									
										
										
										
											2011-11-15 11:56:18 +00:00
										 |  |  |  |                   g_settings_schema_get_id (settings->priv->schema), | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |                   g_variant_type_peek_string (skey.type), | 
					
						
							| 
									
										
										
										
											2010-11-05 09:31:36 -04:00
										 |  |  |  |                   g_variant_get_type_string (value)); | 
					
						
							| 
									
										
										
										
											2017-02-27 10:04:39 +00:00
										 |  |  |  |       success = FALSE; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  |   else if (!g_settings_schema_key_range_check (&skey, value)) | 
					
						
							| 
									
										
										
										
											2010-11-05 09:31:36 -04:00
										 |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2010-11-07 12:56:08 -05:00
										 |  |  |  |       g_warning ("g_settings_set_value: value for key '%s' in schema '%s' " | 
					
						
							| 
									
										
										
										
											2010-11-05 09:31:36 -04:00
										 |  |  |  |                  "is outside of valid range", | 
					
						
							|  |  |  |  |                  key, | 
					
						
							| 
									
										
										
										
											2011-11-15 11:56:18 +00:00
										 |  |  |  |                  g_settings_schema_get_id (settings->priv->schema)); | 
					
						
							| 
									
										
										
										
											2017-02-27 10:04:39 +00:00
										 |  |  |  |       success = FALSE; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  |   else | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       success = g_settings_write_to_backend (settings, &skey, value); | 
					
						
							| 
									
										
										
										
											2010-11-05 09:31:36 -04:00
										 |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   g_settings_schema_key_clear (&skey); | 
					
						
							| 
									
										
										
										
											2017-02-27 10:04:39 +00:00
										 |  |  |  |   g_variant_unref (value); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2012-01-27 03:00:23 -05:00
										 |  |  |  |   return success; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * @key: the key to get the value for | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @format: a [struct@GLib.Variant] format string | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * @...: arguments as per @format | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Gets the value that is stored at @key in @settings. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience function that combines [method@Gio.Settings.get_value] with | 
					
						
							|  |  |  |  |  * [method@GLib.Variant.get]. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t contained in the | 
					
						
							|  |  |  |  |  * schema for @settings or for the [struct@GLib.VariantType] of @format to mismatch | 
					
						
							| 
									
										
										
										
											2010-06-24 02:28:01 -04:00
										 |  |  |  |  * the type given in the schema. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | void | 
					
						
							|  |  |  |  | g_settings_get (GSettings   *settings, | 
					
						
							|  |  |  |  |                 const gchar *key, | 
					
						
							|  |  |  |  |                 const gchar *format, | 
					
						
							|  |  |  |  |                 ...) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   va_list ap; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   value = g_settings_get_value (settings, key); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2013-12-08 17:30:33 +01:00
										 |  |  |  |   if (strchr (format, '&')) | 
					
						
							| 
									
										
										
										
											2013-12-06 16:01:48 +01:00
										 |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2013-12-08 17:30:33 +01:00
										 |  |  |  |       g_critical ("%s: the format string may not contain '&' (key '%s' from schema '%s'). " | 
					
						
							| 
									
										
										
										
											2013-12-06 16:01:48 +01:00
										 |  |  |  |                   "This call will probably stop working with a future version of glib.", | 
					
						
							|  |  |  |  |                   G_STRFUNC, key, g_settings_schema_get_id (settings->priv->schema)); | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |   va_start (ap, format); | 
					
						
							|  |  |  |  |   g_variant_get_va (value, format, NULL, &ap); | 
					
						
							|  |  |  |  |   va_end (ap); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_variant_unref (value); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_set: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * @key: the key to set the value for | 
					
						
							|  |  |  |  |  * @format: a [struct@GLib.Variant] format string | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * @...: arguments as per @format | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Sets @key in @settings to @value. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience function that combines [method@Gio.Settings.set_value] with | 
					
						
							|  |  |  |  |  * [ctor@GLib.Variant.new]. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t contained in the | 
					
						
							|  |  |  |  |  * schema for @settings or for the [struct@GLib.VariantType] of @format to mismatch | 
					
						
							| 
									
										
										
										
											2010-06-24 02:28:01 -04:00
										 |  |  |  |  * the type given in the schema. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if setting the key succeeded, | 
					
						
							|  |  |  |  |  *   false if the key was not writable | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_set (GSettings   *settings, | 
					
						
							|  |  |  |  |                 const gchar *key, | 
					
						
							|  |  |  |  |                 const gchar *format, | 
					
						
							|  |  |  |  |                 ...) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   va_list ap; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   va_start (ap, format); | 
					
						
							|  |  |  |  |   value = g_variant_new_va (format, NULL, &ap); | 
					
						
							|  |  |  |  |   va_end (ap); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2019-01-23 15:15:53 +00:00
										 |  |  |  |   return g_settings_set_value (settings, key, g_steal_pointer (&value)); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get_mapped: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  |  * @key: the key to get the value for | 
					
						
							| 
									
										
										
										
											2011-01-07 09:38:35 +01:00
										 |  |  |  |  * @mapping: (scope call): the function to map the value in the | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  *   settings database to the value used by the application | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  |  * @user_data: user data for @mapping | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Gets the value that is stored at @key in @settings, subject to | 
					
						
							|  |  |  |  |  * application-level validation/mapping. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * You should use this function when the application needs to perform | 
					
						
							|  |  |  |  |  * some processing on the value of the key (for example, parsing).  The | 
					
						
							|  |  |  |  |  * @mapping function performs that processing.  If the function | 
					
						
							|  |  |  |  |  * indicates that the processing was unsuccessful (due to a parse error, | 
					
						
							|  |  |  |  |  * for example) then the mapping is tried again with another value. | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * This allows a robust ‘fall back to defaults’ behaviour to be | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  |  * implemented somewhat automatically. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * The first value that is tried is the user’s setting for the key.  If | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  |  * the mapping function fails to map this value, other values may be | 
					
						
							|  |  |  |  |  * tried in an unspecified order (system or site defaults, translated | 
					
						
							|  |  |  |  |  * schema default values, untranslated schema default values, etc). | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * If the mapping function fails for all possible values, one additional | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * attempt is made: the mapping function is called with a `NULL` value. | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  |  * If the mapping function still indicates failure at this point then | 
					
						
							|  |  |  |  |  * the application will be aborted. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * The result parameter for the @mapping function is pointed to a | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * `gpointer` which is initially set to `NULL`.  The same pointer is given | 
					
						
							|  |  |  |  |  * to each invocation of @mapping.  The final value of that `gpointer` is | 
					
						
							|  |  |  |  |  * what is returned by this function.  `NULL` is valid; it is returned | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  |  * just as any other value would be. | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: (nullable) (transfer full): the result, which may be `NULL` | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  |  **/ | 
					
						
							|  |  |  |  | gpointer | 
					
						
							|  |  |  |  | g_settings_get_mapped (GSettings           *settings, | 
					
						
							|  |  |  |  |                        const gchar         *key, | 
					
						
							|  |  |  |  |                        GSettingsGetMapping  mapping, | 
					
						
							|  |  |  |  |                        gpointer             user_data) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   gpointer result = NULL; | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   GSettingsSchemaKey skey; | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   gboolean okay; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL); | 
					
						
							|  |  |  |  |   g_return_val_if_fail (key != NULL, NULL); | 
					
						
							|  |  |  |  |   g_return_val_if_fail (mapping != NULL, NULL); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-14 17:03:57 +01:00
										 |  |  |  |   g_settings_schema_key_init (&skey, settings->priv->schema, key); | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2013-10-27 10:33:08 -07:00
										 |  |  |  |   if ((value = g_settings_read_from_backend (settings, &skey, FALSE, FALSE))) | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  |     { | 
					
						
							|  |  |  |  |       okay = mapping (value, &result, user_data); | 
					
						
							|  |  |  |  |       g_variant_unref (value); | 
					
						
							|  |  |  |  |       if (okay) goto okay; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   if ((value = g_settings_schema_key_get_translated_default (&skey))) | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  |     { | 
					
						
							|  |  |  |  |       okay = mapping (value, &result, user_data); | 
					
						
							|  |  |  |  |       g_variant_unref (value); | 
					
						
							|  |  |  |  |       if (okay) goto okay; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-08-02 11:08:17 +01:00
										 |  |  |  |   if ((value = g_settings_schema_key_get_per_desktop_default (&skey))) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       okay = mapping (value, &result, user_data); | 
					
						
							|  |  |  |  |       g_variant_unref (value); | 
					
						
							|  |  |  |  |       if (okay) goto okay; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   if (mapping (skey.default_value, &result, user_data)) | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  |     goto okay; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (!mapping (NULL, &result, user_data)) | 
					
						
							|  |  |  |  |     g_error ("The mapping function given to g_settings_get_mapped() for key " | 
					
						
							| 
									
										
										
										
											2013-05-20 17:54:48 -03:00
										 |  |  |  |              "'%s' in schema '%s' returned FALSE when given a NULL value.", | 
					
						
							| 
									
										
										
										
											2011-11-15 11:56:18 +00:00
										 |  |  |  |              key, g_settings_schema_get_id (settings->priv->schema)); | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |  okay: | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   g_settings_schema_key_clear (&skey); | 
					
						
							| 
									
										
										
										
											2010-06-28 10:18:45 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   return result; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /* Convenience API (get, set_string, int, double, boolean, strv) {{{1 */ | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * g_settings_get_string: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @key: the key to get the value for | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Gets the value that is stored at @key in @settings. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.get] for strings. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having an `s` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2021-09-07 18:47:11 +10:00
										 |  |  |  |  * Returns: (not nullable) (transfer full): a newly-allocated string | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | gchar * | 
					
						
							|  |  |  |  | g_settings_get_string (GSettings   *settings, | 
					
						
							|  |  |  |  |                        const gchar *key) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   gchar *result; | 
					
						
							| 
									
										
										
										
											2010-04-22 03:07:49 +02:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   value = g_settings_get_value (settings, key); | 
					
						
							|  |  |  |  |   result = g_variant_dup_string (value, NULL); | 
					
						
							|  |  |  |  |   g_variant_unref (value); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   return result; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * g_settings_set_string: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * @key: the key to set the value for | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @value: the value to set it to | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Sets @key in @settings to @value. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.set] for strings. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having an `s` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if setting the key succeeded, | 
					
						
							|  |  |  |  |  *   false if the key was not writable | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_set_string (GSettings   *settings, | 
					
						
							|  |  |  |  |                        const gchar *key, | 
					
						
							|  |  |  |  |                        const gchar *value) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   return g_settings_set_value (settings, key, g_variant_new_string (value)); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * g_settings_get_int: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @key: the key to get the value for | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Gets the value that is stored at @key in @settings. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.get] for 32-bit integers. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having an `i` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2010-05-16 13:02:23 +02:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * Returns: an integer | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | gint | 
					
						
							|  |  |  |  | g_settings_get_int (GSettings   *settings, | 
					
						
							|  |  |  |  |                     const gchar *key) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   gint result; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   value = g_settings_get_value (settings, key); | 
					
						
							|  |  |  |  |   result = g_variant_get_int32 (value); | 
					
						
							|  |  |  |  |   g_variant_unref (value); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return result; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * g_settings_set_int: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * @key: the key to set the value for | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @value: the value to set it to | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Sets @key in @settings to @value. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.set] for 32-bit integers. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having an `i` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if setting the key succeeded, | 
					
						
							|  |  |  |  |  *   false if the key was not writable | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_set_int (GSettings   *settings, | 
					
						
							|  |  |  |  |                     const gchar *key, | 
					
						
							|  |  |  |  |                     gint         value) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   return g_settings_set_value (settings, key, g_variant_new_int32 (value)); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get_int64: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * @key: the key to get the value for | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Gets the value that is stored at @key in @settings. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.get] for 64-bit integers. | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having an `x` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Returns: a 64-bit integer | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.50 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | gint64 | 
					
						
							|  |  |  |  | g_settings_get_int64 (GSettings   *settings, | 
					
						
							|  |  |  |  |                       const gchar *key) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   gint64 result; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   value = g_settings_get_value (settings, key); | 
					
						
							|  |  |  |  |   result = g_variant_get_int64 (value); | 
					
						
							|  |  |  |  |   g_variant_unref (value); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return result; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_set_int64: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * @key: the key to set the value for | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * @value: the value to set it to | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Sets @key in @settings to @value. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.set] for 64-bit integers. | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having an `x` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if setting the key succeeded, | 
					
						
							|  |  |  |  |  *   false if the key was not writable | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.50 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_set_int64 (GSettings   *settings, | 
					
						
							|  |  |  |  |                       const gchar *key, | 
					
						
							|  |  |  |  |                       gint64       value) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   return g_settings_set_value (settings, key, g_variant_new_int64 (value)); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-03-31 12:44:40 +05:30
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get_uint: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2011-03-31 12:44:40 +05:30
										 |  |  |  |  * @key: the key to get the value for | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Gets the value that is stored at @key in @settings. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.get] for 32-bit unsigned | 
					
						
							| 
									
										
										
										
											2011-03-31 12:44:40 +05:30
										 |  |  |  |  * integers. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having a `u` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2011-03-31 12:44:40 +05:30
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * Returns: an unsigned integer | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-03-31 12:44:40 +05:30
										 |  |  |  |  * Since: 2.30 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | guint | 
					
						
							|  |  |  |  | g_settings_get_uint (GSettings   *settings, | 
					
						
							|  |  |  |  |                      const gchar *key) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   guint result; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   value = g_settings_get_value (settings, key); | 
					
						
							|  |  |  |  |   result = g_variant_get_uint32 (value); | 
					
						
							|  |  |  |  |   g_variant_unref (value); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return result; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_set_uint: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * @key: the key to set the value for | 
					
						
							| 
									
										
										
										
											2011-03-31 12:44:40 +05:30
										 |  |  |  |  * @value: the value to set it to | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Sets @key in @settings to @value. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.set] for 32-bit unsigned | 
					
						
							| 
									
										
										
										
											2011-03-31 12:44:40 +05:30
										 |  |  |  |  * integers. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having a `u` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2011-03-31 12:44:40 +05:30
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if setting the key succeeded, | 
					
						
							|  |  |  |  |  *   false if the key was not writable | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-03-31 12:44:40 +05:30
										 |  |  |  |  * Since: 2.30 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_set_uint (GSettings   *settings, | 
					
						
							|  |  |  |  |                      const gchar *key, | 
					
						
							|  |  |  |  |                      guint        value) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   return g_settings_set_value (settings, key, g_variant_new_uint32 (value)); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get_uint64: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * @key: the key to get the value for | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Gets the value that is stored at @key in @settings. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.get] for 64-bit unsigned | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * integers. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having a `t` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Returns: a 64-bit unsigned integer | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.50 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | guint64 | 
					
						
							|  |  |  |  | g_settings_get_uint64 (GSettings   *settings, | 
					
						
							|  |  |  |  |                        const gchar *key) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   guint64 result; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   value = g_settings_get_value (settings, key); | 
					
						
							|  |  |  |  |   result = g_variant_get_uint64 (value); | 
					
						
							|  |  |  |  |   g_variant_unref (value); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return result; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_set_uint64: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * @key: the key to set the value for | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * @value: the value to set it to | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Sets @key in @settings to @value. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.set] for 64-bit unsigned | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * integers. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having a `t` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if setting the key succeeded, | 
					
						
							|  |  |  |  |  *   false if the key was not writable | 
					
						
							| 
									
										
										
										
											2015-09-21 13:02:45 +02:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.50 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_set_uint64 (GSettings   *settings, | 
					
						
							|  |  |  |  |                        const gchar *key, | 
					
						
							|  |  |  |  |                        guint64      value) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   return g_settings_set_value (settings, key, g_variant_new_uint64 (value)); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * g_settings_get_double: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @key: the key to get the value for | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Gets the value that is stored at @key in @settings. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.get] for doubles. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having a `d` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * Returns: a double | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | gdouble | 
					
						
							|  |  |  |  | g_settings_get_double (GSettings   *settings, | 
					
						
							|  |  |  |  |                        const gchar *key) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   gdouble result; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   value = g_settings_get_value (settings, key); | 
					
						
							|  |  |  |  |   result = g_variant_get_double (value); | 
					
						
							|  |  |  |  |   g_variant_unref (value); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return result; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * g_settings_set_double: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * @key: the key to set the value for | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @value: the value to set it to | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Sets @key in @settings to @value. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.set] for doubles. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having a `d` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if setting the key succeeded, | 
					
						
							|  |  |  |  |  *   false if the key was not writable | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_set_double (GSettings   *settings, | 
					
						
							|  |  |  |  |                        const gchar *key, | 
					
						
							|  |  |  |  |                        gdouble      value) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   return g_settings_set_value (settings, key, g_variant_new_double (value)); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get_boolean: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @key: the key to get the value for | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Gets the value that is stored at @key in @settings. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.get] for booleans. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having a `b` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * Returns: a boolean | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_get_boolean (GSettings  *settings, | 
					
						
							|  |  |  |  |                        const gchar *key) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   gboolean result; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   value = g_settings_get_value (settings, key); | 
					
						
							|  |  |  |  |   result = g_variant_get_boolean (value); | 
					
						
							|  |  |  |  |   g_variant_unref (value); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   return result; | 
					
						
							|  |  |  |  | } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_set_boolean: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * @key: the key to set the value for | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @value: the value to set it to | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Sets @key in @settings to @value. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.set] for booleans. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having a `b` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if setting the key succeeded, | 
					
						
							|  |  |  |  |  *   false if the key was not writable | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_set_boolean (GSettings  *settings, | 
					
						
							|  |  |  |  |                        const gchar *key, | 
					
						
							|  |  |  |  |                        gboolean     value) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   return g_settings_set_value (settings, key, g_variant_new_boolean (value)); | 
					
						
							|  |  |  |  | } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get_strv: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @key: the key to get the value for | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.get] for string arrays. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having an `as` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2021-09-07 18:47:11 +10:00
										 |  |  |  |  * Returns: (array zero-terminated=1) (not nullable) (transfer full): a | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  *   newly-allocated, `NULL`-terminated array of strings, the value that | 
					
						
							|  |  |  |  |  *   is stored at @key in @settings. | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | gchar ** | 
					
						
							|  |  |  |  | g_settings_get_strv (GSettings   *settings, | 
					
						
							|  |  |  |  |                      const gchar *key) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  |   gchar **result; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   value = g_settings_get_value (settings, key); | 
					
						
							|  |  |  |  |   result = g_variant_dup_strv (value, NULL); | 
					
						
							|  |  |  |  |   g_variant_unref (value); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   return result; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_set_strv: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * @key: the key to set the value for | 
					
						
							|  |  |  |  |  * @value: (nullable) (array zero-terminated=1): the value to set it to | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Sets @key in @settings to @value. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * A convenience variant of [method@Gio.Settings.set] for string arrays.  If | 
					
						
							|  |  |  |  |  * @value is `NULL`, then @key is set to be the empty array. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * It is a programmer error to give a @key that isn’t specified as | 
					
						
							| 
									
										
										
										
											2025-03-04 13:47:48 +00:00
										 |  |  |  |  * having an `as` type in the schema for @settings (see [struct@GLib.VariantType]). | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if setting the key succeeded, | 
					
						
							|  |  |  |  |  *   false if the key was not writable | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_set_strv (GSettings           *settings, | 
					
						
							|  |  |  |  |                      const gchar         *key, | 
					
						
							|  |  |  |  |                      const gchar * const *value) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GVariant *array; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   if (value != NULL) | 
					
						
							|  |  |  |  |     array = g_variant_new_strv (value, -1); | 
					
						
							|  |  |  |  |   else | 
					
						
							|  |  |  |  |     array = g_variant_new_strv (NULL, 0); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   return g_settings_set_value (settings, key, array); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							| 
									
										
										
										
											2010-06-24 02:28:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /* Delayed apply (delay, apply, revert, get_has_unapplied) {{{1 */ | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_delay: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 14:03:04 +00:00
										 |  |  |  |  * Changes the [class@Gio.Settings] object into | 
					
						
							|  |  |  |  |  * [‘delay-apply’ mode](class.Settings.html#delay-apply-mode). | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * In this | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * mode, changes to @settings are not immediately propagated to the | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * backend, but kept locally until [method@Gio.Settings.apply] is called. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | void | 
					
						
							|  |  |  |  | g_settings_delay (GSettings *settings) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2021-10-26 14:29:31 +01:00
										 |  |  |  |   GDelayedSettingsBackend *delayed = NULL; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_return_if_fail (G_IS_SETTINGS (settings)); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-10-26 14:29:31 +01:00
										 |  |  |  |   if (G_IS_DELAYED_SETTINGS_BACKEND (settings->priv->backend)) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |     return; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-10-26 14:29:31 +01:00
										 |  |  |  |   delayed = g_delayed_settings_backend_new (settings->priv->backend, | 
					
						
							|  |  |  |  |                                             settings, | 
					
						
							|  |  |  |  |                                             settings->priv->main_context); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_settings_backend_unwatch (settings->priv->backend, G_OBJECT (settings)); | 
					
						
							|  |  |  |  |   g_object_unref (settings->priv->backend); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-10-26 14:29:31 +01:00
										 |  |  |  |   settings->priv->backend = G_SETTINGS_BACKEND (delayed); | 
					
						
							| 
									
										
										
										
											2010-09-09 15:45:53 -04:00
										 |  |  |  |   g_settings_backend_watch (settings->priv->backend, | 
					
						
							|  |  |  |  |                             &listener_vtable, G_OBJECT (settings), | 
					
						
							|  |  |  |  |                             settings->priv->main_context); | 
					
						
							| 
									
										
										
										
											2010-12-20 09:16:05 -05:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_object_notify (G_OBJECT (settings), "delay-apply"); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_apply: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Applies any changes that have been made to the settings. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 14:03:04 +00:00
										 |  |  |  |  * This function does nothing unless @settings is in | 
					
						
							|  |  |  |  |  * [‘delay-apply’ mode](class.Settings.html#delay-apply-mode).  In the normal | 
					
						
							|  |  |  |  |  * case settings are always applied immediately. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  **/ | 
					
						
							|  |  |  |  | void | 
					
						
							|  |  |  |  | g_settings_apply (GSettings *settings) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2021-10-26 14:29:31 +01:00
										 |  |  |  |   if (G_IS_DELAYED_SETTINGS_BACKEND (settings->priv->backend)) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       GDelayedSettingsBackend *delayed; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend); | 
					
						
							|  |  |  |  |       g_delayed_settings_backend_apply (delayed); | 
					
						
							|  |  |  |  |     } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * g_settings_revert: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 14:03:04 +00:00
										 |  |  |  |  * Reverts all unapplied changes to the settings. | 
					
						
							| 
									
										
										
										
											2010-04-20 15:13:07 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 14:03:04 +00:00
										 |  |  |  |  * This function does nothing unless @settings is in | 
					
						
							|  |  |  |  |  * [‘delay-apply’ mode](class.Settings.html#delay-apply-mode).  In the normal | 
					
						
							|  |  |  |  |  * case settings are always applied immediately. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Change notifications will be emitted for affected keys. | 
					
						
							|  |  |  |  |  **/ | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | void | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | g_settings_revert (GSettings *settings) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2021-10-26 14:29:31 +01:00
										 |  |  |  |   if (G_IS_DELAYED_SETTINGS_BACKEND (settings->priv->backend)) | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |     { | 
					
						
							|  |  |  |  |       GDelayedSettingsBackend *delayed; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |       delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend); | 
					
						
							|  |  |  |  |       g_delayed_settings_backend_revert (delayed); | 
					
						
							|  |  |  |  |     } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * g_settings_get_has_unapplied: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns whether the [class@Gio.Settings] object has any unapplied | 
					
						
							|  |  |  |  |  * changes. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 14:03:04 +00:00
										 |  |  |  |  * This can only be the case if it is in | 
					
						
							|  |  |  |  |  * [‘delay-apply’ mode](class.Settings.html#delay-apply-mode). | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Returns: true if @settings has unapplied changes, false otherwise | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_get_has_unapplied (GSettings *settings) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-10-26 14:29:31 +01:00
										 |  |  |  |   return G_IS_DELAYED_SETTINGS_BACKEND (settings->priv->backend) && | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |          g_delayed_settings_backend_get_has_unapplied ( | 
					
						
							|  |  |  |  |            G_DELAYED_SETTINGS_BACKEND (settings->priv->backend)); | 
					
						
							|  |  |  |  | } | 
					
						
							| 
									
										
										
										
											2010-04-21 12:31:33 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-10-04 03:33:06 -04:00
										 |  |  |  | /* Extra API (reset, sync, get_child, is_writable, list_*, ranges) {{{1 */ | 
					
						
							| 
									
										
										
										
											2010-07-22 17:49:40 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_reset: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-07-22 17:49:40 -04:00
										 |  |  |  |  * @key: the name of a key | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Resets @key to its default value. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * This call resets the key, as much as possible, to its default value. | 
					
						
							| 
									
										
										
										
											2019-07-10 13:51:53 +00:00
										 |  |  |  |  * That might be the value specified in the schema or the one set by the | 
					
						
							| 
									
										
										
										
											2010-07-22 17:49:40 -04:00
										 |  |  |  |  * administrator. | 
					
						
							|  |  |  |  |  **/ | 
					
						
							|  |  |  |  | void | 
					
						
							|  |  |  |  | g_settings_reset (GSettings *settings, | 
					
						
							|  |  |  |  |                   const gchar *key) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   gchar *path; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-02-19 12:21:48 -05:00
										 |  |  |  |   g_return_if_fail (G_IS_SETTINGS (settings)); | 
					
						
							|  |  |  |  |   g_return_if_fail (key != NULL); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-07-22 17:49:40 -04:00
										 |  |  |  |   path = g_strconcat (settings->priv->path, key, NULL); | 
					
						
							|  |  |  |  |   g_settings_backend_reset (settings->priv->backend, path, NULL); | 
					
						
							|  |  |  |  |   g_free (path); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_sync: | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2017-04-30 22:04:17 +01:00
										 |  |  |  |  * Ensures that all pending operations are complete for the default backend. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Writes made to a [class@Gio.Settings] are handled asynchronously.  For this | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * reason, it is very unlikely that the changes have it to disk by the | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * time [method@Gio.Settings.set] returns. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * This call will block until all of the writes have made it to the | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * backend.  Since the main loop is not running, no change notifications | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * will be dispatched during this call (but some may be queued by the | 
					
						
							|  |  |  |  |  * time the call is done). | 
					
						
							|  |  |  |  |  **/ | 
					
						
							|  |  |  |  | void | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  | g_settings_sync (void) | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-17 14:05:40 -04:00
										 |  |  |  |   g_settings_backend_sync_default (); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_is_writable: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @name: the name of a key | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Finds out if a key can be written. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if the key @name is writable, false otherwise | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_is_writable (GSettings   *settings, | 
					
						
							|  |  |  |  |                         const gchar *name) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   gboolean writable; | 
					
						
							|  |  |  |  |   gchar *path; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   path = g_strconcat (settings->priv->path, name, NULL); | 
					
						
							|  |  |  |  |   writable = g_settings_backend_get_writable (settings->priv->backend, path); | 
					
						
							|  |  |  |  |   g_free (path); | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   return writable; | 
					
						
							|  |  |  |  | } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get_child: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2014-02-06 16:49:29 -05:00
										 |  |  |  |  * @name: the name of the child schema | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2014-02-06 16:49:29 -05:00
										 |  |  |  |  * Creates a child settings object which has a base path of | 
					
						
							| 
									
										
										
										
											2025-03-04 14:14:02 +00:00
										 |  |  |  |  * `base-path/name`, where `base-path` is the base path of | 
					
						
							|  |  |  |  |  * @settings and `name` is as specified by the caller. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * The schema for the child settings object must have been declared | 
					
						
							| 
									
										
										
										
											2021-10-26 14:02:54 +01:00
										 |  |  |  |  * in the schema of @settings using a `<child>` element. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * The created child settings object will inherit the | 
					
						
							|  |  |  |  |  * [property@Gio.Settings:delay-apply] mode from @settings. | 
					
						
							| 
									
										
										
										
											2021-10-26 14:10:19 +01:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: (not nullable) (transfer full): a ‘child’ settings object | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | GSettings * | 
					
						
							|  |  |  |  | g_settings_get_child (GSettings   *settings, | 
					
						
							|  |  |  |  |                       const gchar *name) | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2021-06-04 12:09:24 +00:00
										 |  |  |  |   GSettingsSchema *child_schema; | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   gchar *child_path; | 
					
						
							|  |  |  |  |   GSettings *child; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-06-04 12:09:24 +00:00
										 |  |  |  |   child_schema = g_settings_schema_get_child_schema (settings->priv->schema, | 
					
						
							|  |  |  |  |                                                      name); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   if (child_schema == NULL) | 
					
						
							| 
									
										
										
										
											2021-06-04 12:09:24 +00:00
										 |  |  |  |     g_error ("Schema '%s' has no child '%s' or child schema not found", | 
					
						
							| 
									
										
										
										
											2011-11-15 11:56:18 +00:00
										 |  |  |  |              g_settings_schema_get_id (settings->priv->schema), name); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-06-04 12:09:24 +00:00
										 |  |  |  |   child_path = g_strconcat (settings->priv->path, name, "/", NULL); | 
					
						
							|  |  |  |  |   child = g_settings_new_full (child_schema, | 
					
						
							|  |  |  |  |                                settings->priv->backend, | 
					
						
							|  |  |  |  |                                child_path); | 
					
						
							|  |  |  |  |   g_settings_schema_unref (child_schema); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_free (child_path); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   return child; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-24 02:15:15 -04:00
										 |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-09-06 12:47:37 -04:00
										 |  |  |  |  * g_settings_list_keys: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-06-24 02:15:15 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-09-06 12:47:37 -04:00
										 |  |  |  |  * Introspects the list of keys on @settings. | 
					
						
							| 
									
										
										
										
											2010-06-24 02:15:15 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * You should probably not be calling this function from ‘normal’ code | 
					
						
							| 
									
										
										
										
											2010-06-24 02:15:15 -04:00
										 |  |  |  |  * (since you should already know what keys are in your schema).  This | 
					
						
							|  |  |  |  |  * function is intended for introspection reasons. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * You should free the return value with [func@GLib.strfreev] when you are done | 
					
						
							| 
									
										
										
										
											2010-09-06 12:47:37 -04:00
										 |  |  |  |  * with it. | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2021-09-07 18:47:11 +10:00
										 |  |  |  |  * Returns: (not nullable) (transfer full) (element-type utf8): a list | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  *   of the keys on @settings, in no defined order | 
					
						
							|  |  |  |  |  * Deprecated: 2.46: Use [method@Gio.SettingsSchema.list_keys] instead. | 
					
						
							| 
									
										
										
										
											2010-06-24 02:15:15 -04:00
										 |  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2010-09-06 12:47:37 -04:00
										 |  |  |  | gchar ** | 
					
						
							|  |  |  |  | g_settings_list_keys (GSettings *settings) | 
					
						
							| 
									
										
										
										
											2010-06-24 02:15:15 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2014-11-19 12:40:22 -05:00
										 |  |  |  |   return g_settings_schema_list_keys (settings->priv->schema); | 
					
						
							| 
									
										
										
										
											2010-09-06 12:47:37 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_list_children: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-09-06 12:47:37 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Gets the list of children on @settings. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * The list is exactly the list of strings for which it is not an error | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * to call [method@Gio.Settings.get_child]. | 
					
						
							| 
									
										
										
										
											2010-09-06 12:47:37 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * There is little reason to call this function from ‘normal’ code, since | 
					
						
							| 
									
										
										
										
											2018-11-12 08:07:52 -05:00
										 |  |  |  |  * you should already know what children are in your schema. This function | 
					
						
							|  |  |  |  |  * may still be useful there for introspection reasons, however. | 
					
						
							| 
									
										
										
										
											2010-09-06 12:47:37 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * You should free the return value with [func@GLib.strfreev] when you are done | 
					
						
							| 
									
										
										
										
											2010-09-06 12:47:37 -04:00
										 |  |  |  |  * with it. | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2021-09-07 18:47:11 +10:00
										 |  |  |  |  * Returns: (not nullable) (transfer full) (element-type utf8): a list of the children | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  *   on @settings, in no defined order | 
					
						
							| 
									
										
										
										
											2010-09-06 12:47:37 -04:00
										 |  |  |  |  */ | 
					
						
							|  |  |  |  | gchar ** | 
					
						
							|  |  |  |  | g_settings_list_children (GSettings *settings) | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2015-01-26 10:13:26 +00:00
										 |  |  |  |   return g_settings_schema_list_children (settings->priv->schema); | 
					
						
							| 
									
										
										
										
											2010-06-24 02:15:15 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-10-04 02:58:46 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_get_range: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-10-04 02:58:46 -04:00
										 |  |  |  |  * @key: the key to query the range of | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Queries the range of a key. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.28 | 
					
						
							| 
									
										
										
										
											2013-10-27 17:03:04 -07:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Deprecated:2.40:Use [method@Gio.SettingsSchemaKey.get_range] instead. | 
					
						
							| 
									
										
										
										
											2010-10-04 02:58:46 -04:00
										 |  |  |  |  **/ | 
					
						
							|  |  |  |  | GVariant * | 
					
						
							|  |  |  |  | g_settings_get_range (GSettings   *settings, | 
					
						
							|  |  |  |  |                       const gchar *key) | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   GSettingsSchemaKey skey; | 
					
						
							| 
									
										
										
										
											2010-10-04 02:58:46 -04:00
										 |  |  |  |   GVariant *range; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-14 17:03:57 +01:00
										 |  |  |  |   g_settings_schema_key_init (&skey, settings->priv->schema, key); | 
					
						
							| 
									
										
										
										
											2013-10-27 17:03:04 -07:00
										 |  |  |  |   range = g_settings_schema_key_get_range (&skey); | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   g_settings_schema_key_clear (&skey); | 
					
						
							| 
									
										
										
										
											2010-10-04 02:58:46 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2013-10-27 17:03:04 -07:00
										 |  |  |  |   return range; | 
					
						
							| 
									
										
										
										
											2010-10-04 02:58:46 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-10-04 03:33:06 -04:00
										 |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_range_check: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-10-04 03:33:06 -04:00
										 |  |  |  |  * @key: the key to check | 
					
						
							|  |  |  |  |  * @value: the value to check | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Checks if the given @value is of the correct type and within the | 
					
						
							|  |  |  |  |  * permitted range for @key. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: true if @value is valid for @key, false otherwise | 
					
						
							| 
									
										
										
										
											2011-11-21 12:02:02 -05:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-10-04 03:33:06 -04:00
										 |  |  |  |  * Since: 2.28 | 
					
						
							| 
									
										
										
										
											2013-10-27 17:03:04 -07:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Deprecated:2.40:Use [method@Gio.SettingsSchemaKey.range_check] instead. | 
					
						
							| 
									
										
										
										
											2010-10-04 03:33:06 -04:00
										 |  |  |  |  **/ | 
					
						
							|  |  |  |  | gboolean | 
					
						
							|  |  |  |  | g_settings_range_check (GSettings   *settings, | 
					
						
							|  |  |  |  |                         const gchar *key, | 
					
						
							|  |  |  |  |                         GVariant    *value) | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   GSettingsSchemaKey skey; | 
					
						
							| 
									
										
										
										
											2010-10-04 03:33:06 -04:00
										 |  |  |  |   gboolean good; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-14 17:03:57 +01:00
										 |  |  |  |   g_settings_schema_key_init (&skey, settings->priv->schema, key); | 
					
						
							| 
									
										
										
										
											2013-10-27 17:03:04 -07:00
										 |  |  |  |   good = g_settings_schema_key_range_check (&skey, value); | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   g_settings_schema_key_clear (&skey); | 
					
						
							| 
									
										
										
										
											2010-10-04 03:33:06 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   return good; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /* Binding {{{1 */ | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | typedef struct | 
					
						
							|  |  |  |  | { | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   GSettingsSchemaKey key; | 
					
						
							| 
									
										
										
										
											2011-11-13 23:35:27 +01:00
										 |  |  |  |   GSettings *settings; | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GObject *object; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   GSettingsBindGetMapping get_mapping; | 
					
						
							|  |  |  |  |   GSettingsBindSetMapping set_mapping; | 
					
						
							|  |  |  |  |   gpointer user_data; | 
					
						
							|  |  |  |  |   GDestroyNotify destroy; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   guint writable_handler_id; | 
					
						
							|  |  |  |  |   guint property_handler_id; | 
					
						
							|  |  |  |  |   const GParamSpec *property; | 
					
						
							|  |  |  |  |   guint key_handler_id; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   /* prevent recursion */ | 
					
						
							|  |  |  |  |   gboolean running; | 
					
						
							|  |  |  |  | } GSettingsBinding; | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | g_settings_binding_free (gpointer data) | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GSettingsBinding *binding = data; | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_assert (!binding->running); | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   if (binding->writable_handler_id) | 
					
						
							| 
									
										
										
										
											2011-11-13 23:35:27 +01:00
										 |  |  |  |     g_signal_handler_disconnect (binding->settings, | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |                                  binding->writable_handler_id); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (binding->key_handler_id) | 
					
						
							| 
									
										
										
										
											2011-11-13 23:35:27 +01:00
										 |  |  |  |     g_signal_handler_disconnect (binding->settings, | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |                                  binding->key_handler_id); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (g_signal_handler_is_connected (binding->object, | 
					
						
							|  |  |  |  |                                      binding->property_handler_id)) | 
					
						
							|  |  |  |  |   g_signal_handler_disconnect (binding->object, | 
					
						
							|  |  |  |  |                                binding->property_handler_id); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   g_settings_schema_key_clear (&binding->key); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (binding->destroy) | 
					
						
							|  |  |  |  |     binding->destroy (binding->user_data); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:35:27 +01:00
										 |  |  |  |   g_object_unref (binding->settings); | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_slice_free (GSettingsBinding, binding); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static GQuark | 
					
						
							|  |  |  |  | g_settings_binding_quark (const char *property) | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GQuark quark; | 
					
						
							|  |  |  |  |   gchar *tmp; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   tmp = g_strdup_printf ("gsettingsbinding-%s", property); | 
					
						
							|  |  |  |  |   quark = g_quark_from_string (tmp); | 
					
						
							|  |  |  |  |   g_free (tmp); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return quark; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_binding_key_changed (GSettings   *settings, | 
					
						
							|  |  |  |  |                                 const gchar *key, | 
					
						
							|  |  |  |  |                                 gpointer     user_data) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsBinding *binding = user_data; | 
					
						
							| 
									
										
										
										
											2011-09-30 17:08:15 +01:00
										 |  |  |  |   GValue value = G_VALUE_INIT; | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GVariant *variant; | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:35:27 +01:00
										 |  |  |  |   g_assert (settings == binding->settings); | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   g_assert (key == binding->key.name); | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   if (binding->running) | 
					
						
							|  |  |  |  |     return; | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   binding->running = TRUE; | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_value_init (&value, binding->property->value_type); | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2013-10-27 10:33:08 -07:00
										 |  |  |  |   variant = g_settings_read_from_backend (binding->settings, &binding->key, FALSE, FALSE); | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |   if (variant && !binding->get_mapping (&value, variant, binding->user_data)) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       /* silently ignore errors in the user's config database */ | 
					
						
							|  |  |  |  |       g_variant_unref (variant); | 
					
						
							|  |  |  |  |       variant = NULL; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (variant == NULL) | 
					
						
							|  |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |       variant = g_settings_schema_key_get_translated_default (&binding->key); | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |       if (variant && | 
					
						
							|  |  |  |  |           !binding->get_mapping (&value, variant, binding->user_data)) | 
					
						
							|  |  |  |  |         { | 
					
						
							|  |  |  |  |           /* flag translation errors with a warning */ | 
					
						
							| 
									
										
										
										
											2013-05-20 17:54:48 -03:00
										 |  |  |  |           g_warning ("Translated default '%s' for key '%s' in schema '%s' " | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |                      "was rejected by the binding mapping function", | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |                      binding->key.unparsed, binding->key.name, | 
					
						
							| 
									
										
										
										
											2011-11-15 11:39:12 +00:00
										 |  |  |  |                      g_settings_schema_get_id (binding->key.schema)); | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |           g_variant_unref (variant); | 
					
						
							|  |  |  |  |           variant = NULL; | 
					
						
							|  |  |  |  |         } | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-08-02 11:08:17 +01:00
										 |  |  |  |   if (variant == NULL) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       variant = g_settings_schema_key_get_per_desktop_default (&binding->key); | 
					
						
							|  |  |  |  |       if (variant && | 
					
						
							|  |  |  |  |           !binding->get_mapping (&value, variant, binding->user_data)) | 
					
						
							|  |  |  |  |         { | 
					
						
							|  |  |  |  |           g_error ("Per-desktop default value for key '%s' in schema '%s' " | 
					
						
							|  |  |  |  |                    "was rejected by the binding mapping function.", | 
					
						
							|  |  |  |  |                    binding->key.name, g_settings_schema_get_id (binding->key.schema)); | 
					
						
							|  |  |  |  |           g_variant_unref (variant); | 
					
						
							|  |  |  |  |           variant = NULL; | 
					
						
							|  |  |  |  |         } | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |   if (variant == NULL) | 
					
						
							|  |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |       variant = g_variant_ref (binding->key.default_value); | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |       if (!binding->get_mapping (&value, variant, binding->user_data)) | 
					
						
							| 
									
										
										
										
											2013-05-20 17:54:48 -03:00
										 |  |  |  |         g_error ("The schema default value for key '%s' in schema '%s' " | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |                  "was rejected by the binding mapping function.", | 
					
						
							| 
									
										
										
										
											2011-11-15 11:39:12 +00:00
										 |  |  |  |                  binding->key.name, g_settings_schema_get_id (binding->key.schema)); | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_object_set_property (binding->object, binding->property->name, &value); | 
					
						
							| 
									
										
										
										
											2010-06-16 18:36:24 -04:00
										 |  |  |  |   g_variant_unref (variant); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_value_unset (&value); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   binding->running = FALSE; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_binding_property_changed (GObject          *object, | 
					
						
							|  |  |  |  |                                      const GParamSpec *pspec, | 
					
						
							|  |  |  |  |                                      gpointer          user_data) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsBinding *binding = user_data; | 
					
						
							| 
									
										
										
										
											2011-09-30 17:08:15 +01:00
										 |  |  |  |   GValue value = G_VALUE_INIT; | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GVariant *variant; | 
					
						
							| 
									
										
										
										
											2018-03-29 13:29:21 +02:00
										 |  |  |  |   gboolean valid = TRUE; | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_assert (object == binding->object); | 
					
						
							|  |  |  |  |   g_assert (pspec == binding->property); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (binding->running) | 
					
						
							|  |  |  |  |     return; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   binding->running = TRUE; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_value_init (&value, pspec->value_type); | 
					
						
							|  |  |  |  |   g_object_get_property (object, pspec->name, &value); | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |   if ((variant = binding->set_mapping (&value, binding->key.type, | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |                                        binding->user_data))) | 
					
						
							|  |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2011-07-11 14:27:53 +02:00
										 |  |  |  |       g_variant_take_ref (variant); | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |       if (!g_settings_schema_key_type_check (&binding->key, variant)) | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |         { | 
					
						
							| 
									
										
										
										
											2018-03-29 13:29:21 +02:00
										 |  |  |  |           gchar *type_str; | 
					
						
							|  |  |  |  |           type_str = g_variant_type_dup_string (binding->key.type); | 
					
						
							| 
									
										
										
										
											2013-05-20 17:54:48 -03:00
										 |  |  |  |           g_critical ("binding mapping function for key '%s' returned " | 
					
						
							|  |  |  |  |                       "GVariant of type '%s' when type '%s' was requested", | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |                       binding->key.name, g_variant_get_type_string (variant), | 
					
						
							| 
									
										
										
										
											2018-03-29 13:29:21 +02:00
										 |  |  |  |                       type_str); | 
					
						
							|  |  |  |  |           g_free (type_str); | 
					
						
							|  |  |  |  |           valid = FALSE; | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |         } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-03-29 13:29:21 +02:00
										 |  |  |  |       if (valid && !g_settings_schema_key_range_check (&binding->key, variant)) | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |         { | 
					
						
							| 
									
										
										
										
											2018-03-29 13:29:21 +02:00
										 |  |  |  |           gchar *variant_str; | 
					
						
							|  |  |  |  |           variant_str = g_variant_print (variant, TRUE); | 
					
						
							| 
									
										
										
										
											2013-05-20 17:54:48 -03:00
										 |  |  |  |           g_critical ("GObject property '%s' on a '%s' object is out of " | 
					
						
							|  |  |  |  |                       "schema-specified range for key '%s' of '%s': %s", | 
					
						
							| 
									
										
										
										
											2011-11-14 17:08:31 +01:00
										 |  |  |  |                       binding->property->name, g_type_name (binding->property->owner_type), | 
					
						
							| 
									
										
										
										
											2011-11-15 11:39:12 +00:00
										 |  |  |  |                       binding->key.name, g_settings_schema_get_id (binding->key.schema), | 
					
						
							| 
									
										
										
										
											2018-03-29 13:29:21 +02:00
										 |  |  |  |                       variant_str); | 
					
						
							|  |  |  |  |           g_free (variant_str); | 
					
						
							|  |  |  |  |           valid = FALSE; | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |         } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-03-29 13:29:21 +02:00
										 |  |  |  |       if (valid) | 
					
						
							|  |  |  |  |         { | 
					
						
							|  |  |  |  |           g_settings_write_to_backend (binding->settings, &binding->key, variant); | 
					
						
							|  |  |  |  |         } | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       g_variant_unref (variant); | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  |   g_value_unset (&value); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   binding->running = FALSE; | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-08-03 02:08:03 -04:00
										 |  |  |  | static gboolean | 
					
						
							|  |  |  |  | g_settings_bind_invert_boolean_get_mapping (GValue   *value, | 
					
						
							|  |  |  |  |                                             GVariant *variant, | 
					
						
							|  |  |  |  |                                             gpointer  user_data) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   g_value_set_boolean (value, !g_variant_get_boolean (variant)); | 
					
						
							|  |  |  |  |   return TRUE; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static GVariant * | 
					
						
							|  |  |  |  | g_settings_bind_invert_boolean_set_mapping (const GValue       *value, | 
					
						
							|  |  |  |  |                                             const GVariantType *expected_type, | 
					
						
							|  |  |  |  |                                             gpointer            user_data) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   return g_variant_new_boolean (!g_value_get_boolean (value)); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-04-20 15:13:07 -04:00
										 |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * g_settings_bind: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-04-20 15:13:07 -04:00
										 |  |  |  |  * @key: the key to bind | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @object: (type GObject.Object): the object with property to bind | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @property: the name of the property to bind | 
					
						
							|  |  |  |  |  * @flags: flags for the binding | 
					
						
							| 
									
										
										
										
											2010-04-20 15:13:07 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Create a binding between the @key in the @settings object | 
					
						
							|  |  |  |  |  * and the property @property of @object. | 
					
						
							| 
									
										
										
										
											2010-04-20 15:13:07 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * The binding uses the default GIO mapping functions to map | 
					
						
							|  |  |  |  |  * between the settings and property values. These functions | 
					
						
							|  |  |  |  |  * handle booleans, numeric types and string types in a | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * straightforward way. Use [method@Gio.Settings.bind_with_mapping] if | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * you need a custom mapping, or map between types that are not | 
					
						
							|  |  |  |  |  * supported by the default mapping functions. | 
					
						
							| 
									
										
										
										
											2010-04-20 15:13:07 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Unless the @flags include [flags@Gio.SettingsBindFlags.NO_SENSITIVITY], this | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * function also establishes a binding between the writability of | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @key and the `sensitive` property of @object (if @object has | 
					
						
							|  |  |  |  |  * a boolean property by that name). See [method@Gio.Settings.bind_writable] | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * for more details about writable bindings. | 
					
						
							| 
									
										
										
										
											2010-04-20 15:13:07 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2017-10-20 21:19:26 +08:00
										 |  |  |  |  * Note that the lifecycle of the binding is tied to @object, | 
					
						
							| 
									
										
										
										
											2010-04-20 15:13:07 -04:00
										 |  |  |  |  * and that you can have only one binding per object property. | 
					
						
							|  |  |  |  |  * If you bind the same property twice on the same object, the second | 
					
						
							|  |  |  |  |  * binding overrides the first one. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | void | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | g_settings_bind (GSettings          *settings, | 
					
						
							|  |  |  |  |                  const gchar        *key, | 
					
						
							|  |  |  |  |                  gpointer            object, | 
					
						
							|  |  |  |  |                  const gchar        *property, | 
					
						
							|  |  |  |  |                  GSettingsBindFlags  flags) | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-08-03 02:08:03 -04:00
										 |  |  |  |   GSettingsBindGetMapping get_mapping = NULL; | 
					
						
							|  |  |  |  |   GSettingsBindSetMapping set_mapping = NULL; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (flags & G_SETTINGS_BIND_INVERT_BOOLEAN) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       get_mapping = g_settings_bind_invert_boolean_get_mapping; | 
					
						
							|  |  |  |  |       set_mapping = g_settings_bind_invert_boolean_set_mapping; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |       /* can't pass this flag to g_settings_bind_with_mapping() */ | 
					
						
							|  |  |  |  |       flags &= ~G_SETTINGS_BIND_INVERT_BOOLEAN; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_settings_bind_with_mapping (settings, key, object, property, flags, | 
					
						
							|  |  |  |  |                                 get_mapping, set_mapping, NULL, NULL); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2011-01-07 09:38:35 +01:00
										 |  |  |  |  * g_settings_bind_with_mapping: (skip) | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @key: the key to bind | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @object: (type GObject.Object): the object with property to bind | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @property: the name of the property to bind | 
					
						
							|  |  |  |  |  * @flags: flags for the binding | 
					
						
							| 
									
										
										
										
											2025-03-04 13:26:47 +00:00
										 |  |  |  |  * @get_mapping: (nullable): a function that gets called to convert values | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  *   from @settings to @object, or `NULL` to use the default GIO mapping | 
					
						
							| 
									
										
										
										
											2025-03-04 13:26:47 +00:00
										 |  |  |  |  * @set_mapping: (nullable): a function that gets called to convert values | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  *   from @object to @settings, or `NULL` to use the default GIO mapping | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @user_data: data that gets passed to @get_mapping and @set_mapping | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @destroy: destroy notify function for @user_data | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Create a binding between the @key in the @settings object | 
					
						
							|  |  |  |  |  * and the property @property of @object. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * The binding uses the provided mapping functions to map between | 
					
						
							|  |  |  |  |  * settings and property values. | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2017-10-20 21:19:26 +08:00
										 |  |  |  |  * Note that the lifecycle of the binding is tied to @object, | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * and that you can have only one binding per object property. | 
					
						
							|  |  |  |  |  * If you bind the same property twice on the same object, the second | 
					
						
							|  |  |  |  |  * binding overrides the first one. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | void | 
					
						
							|  |  |  |  | g_settings_bind_with_mapping (GSettings               *settings, | 
					
						
							|  |  |  |  |                               const gchar             *key, | 
					
						
							|  |  |  |  |                               gpointer                 object, | 
					
						
							|  |  |  |  |                               const gchar             *property, | 
					
						
							|  |  |  |  |                               GSettingsBindFlags       flags, | 
					
						
							|  |  |  |  |                               GSettingsBindGetMapping  get_mapping, | 
					
						
							|  |  |  |  |                               GSettingsBindSetMapping  set_mapping, | 
					
						
							|  |  |  |  |                               gpointer                 user_data, | 
					
						
							|  |  |  |  |                               GDestroyNotify           destroy) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsBinding *binding; | 
					
						
							|  |  |  |  |   GObjectClass *objectclass; | 
					
						
							| 
									
										
										
										
											2010-04-20 12:30:12 -04:00
										 |  |  |  |   gchar *detailed_signal; | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GQuark binding_quark; | 
					
						
							| 
									
										
										
										
											2010-04-21 12:31:33 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-04-22 03:07:49 +02:00
										 |  |  |  |   g_return_if_fail (G_IS_SETTINGS (settings)); | 
					
						
							| 
									
										
										
										
											2011-08-15 10:42:35 -04:00
										 |  |  |  |   g_return_if_fail (key != NULL); | 
					
						
							|  |  |  |  |   g_return_if_fail (G_IS_OBJECT (object)); | 
					
						
							|  |  |  |  |   g_return_if_fail (property != NULL); | 
					
						
							| 
									
										
										
										
											2010-08-03 02:08:03 -04:00
										 |  |  |  |   g_return_if_fail (~flags & G_SETTINGS_BIND_INVERT_BOOLEAN); | 
					
						
							| 
									
										
										
										
											2010-04-22 03:07:49 +02:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   objectclass = G_OBJECT_GET_CLASS (object); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   binding = g_slice_new0 (GSettingsBinding); | 
					
						
							| 
									
										
										
										
											2011-11-14 17:03:57 +01:00
										 |  |  |  |   g_settings_schema_key_init (&binding->key, settings->priv->schema, key); | 
					
						
							| 
									
										
										
										
											2011-11-13 23:35:27 +01:00
										 |  |  |  |   binding->settings = g_object_ref (settings); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   binding->object = object; | 
					
						
							|  |  |  |  |   binding->property = g_object_class_find_property (objectclass, property); | 
					
						
							|  |  |  |  |   binding->user_data = user_data; | 
					
						
							|  |  |  |  |   binding->destroy = destroy; | 
					
						
							|  |  |  |  |   binding->get_mapping = get_mapping ? get_mapping : g_settings_get_mapping; | 
					
						
							|  |  |  |  |   binding->set_mapping = set_mapping ? set_mapping : g_settings_set_mapping; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (!(flags & (G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET))) | 
					
						
							|  |  |  |  |     flags |= G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (binding->property == NULL) | 
					
						
							| 
									
										
										
										
											2010-04-21 12:31:33 -04:00
										 |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       g_critical ("g_settings_bind: no property '%s' on class '%s'", | 
					
						
							| 
									
										
										
										
											2010-04-21 12:31:33 -04:00
										 |  |  |  |                   property, G_OBJECT_TYPE_NAME (object)); | 
					
						
							|  |  |  |  |       return; | 
					
						
							|  |  |  |  |     } | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |   if ((flags & G_SETTINGS_BIND_GET) && | 
					
						
							|  |  |  |  |       (binding->property->flags & G_PARAM_WRITABLE) == 0) | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |       g_critical ("g_settings_bind: property '%s' on class '%s' is not " | 
					
						
							| 
									
										
										
										
											2012-10-15 19:28:28 -04:00
										 |  |  |  |                   "writable", binding->property->name, G_OBJECT_TYPE_NAME (object)); | 
					
						
							| 
									
										
										
										
											2010-04-21 12:31:33 -04:00
										 |  |  |  |       return; | 
					
						
							|  |  |  |  |     } | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |   if ((flags & G_SETTINGS_BIND_SET) && | 
					
						
							|  |  |  |  |       (binding->property->flags & G_PARAM_READABLE) == 0) | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2010-06-25 10:52:32 -04:00
										 |  |  |  |       g_critical ("g_settings_bind: property '%s' on class '%s' is not " | 
					
						
							| 
									
										
										
										
											2012-10-15 19:28:28 -04:00
										 |  |  |  |                   "readable", binding->property->name, G_OBJECT_TYPE_NAME (object)); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       return; | 
					
						
							|  |  |  |  |     } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-08-03 02:08:03 -04:00
										 |  |  |  |   if (get_mapping == g_settings_bind_invert_boolean_get_mapping) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       /* g_settings_bind_invert_boolean_get_mapping() is a private
 | 
					
						
							|  |  |  |  |        * function, so if we are here it means that g_settings_bind() was | 
					
						
							|  |  |  |  |        * called with G_SETTINGS_BIND_INVERT_BOOLEAN. | 
					
						
							|  |  |  |  |        * | 
					
						
							|  |  |  |  |        * Ensure that both sides are boolean. | 
					
						
							|  |  |  |  |        */ | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |       if (binding->property->value_type != G_TYPE_BOOLEAN) | 
					
						
							|  |  |  |  |         { | 
					
						
							|  |  |  |  |           g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN " | 
					
						
							| 
									
										
										
										
											2013-05-20 17:54:48 -03:00
										 |  |  |  |                       "was specified, but property '%s' on type '%s' has " | 
					
						
							|  |  |  |  |                       "type '%s'", binding->property->name, G_OBJECT_TYPE_NAME (object), | 
					
						
							| 
									
										
										
										
											2010-08-03 02:08:03 -04:00
										 |  |  |  |                       g_type_name ((binding->property->value_type))); | 
					
						
							|  |  |  |  |           return; | 
					
						
							|  |  |  |  |         } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |       if (!g_variant_type_equal (binding->key.type, G_VARIANT_TYPE_BOOLEAN)) | 
					
						
							| 
									
										
										
										
											2010-08-03 02:08:03 -04:00
										 |  |  |  |         { | 
					
						
							| 
									
										
										
										
											2018-07-17 12:14:07 +02:00
										 |  |  |  |           gchar *type_string = g_variant_type_dup_string (binding->key.type); | 
					
						
							| 
									
										
										
										
											2010-08-03 02:08:03 -04:00
										 |  |  |  |           g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN " | 
					
						
							| 
									
										
										
										
											2013-05-20 17:54:48 -03:00
										 |  |  |  |                       "was specified, but key '%s' on schema '%s' has " | 
					
						
							|  |  |  |  |                       "type '%s'", key, g_settings_schema_get_id (settings->priv->schema), | 
					
						
							| 
									
										
										
										
											2018-07-17 12:14:07 +02:00
										 |  |  |  |                       type_string); | 
					
						
							|  |  |  |  |           g_free (type_string); | 
					
						
							| 
									
										
										
										
											2010-08-03 02:08:03 -04:00
										 |  |  |  |           return; | 
					
						
							|  |  |  |  |         } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   else if (((get_mapping == NULL && (flags & G_SETTINGS_BIND_GET)) || | 
					
						
							|  |  |  |  |             (set_mapping == NULL && (flags & G_SETTINGS_BIND_SET))) && | 
					
						
							|  |  |  |  |            !g_settings_mapping_is_compatible (binding->property->value_type, | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |                                               binding->key.type)) | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2018-07-17 12:14:07 +02:00
										 |  |  |  |       gchar *type_string = g_variant_type_dup_string (binding->key.type); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       g_critical ("g_settings_bind: property '%s' on class '%s' has type " | 
					
						
							|  |  |  |  |                   "'%s' which is not compatible with type '%s' of key '%s' " | 
					
						
							| 
									
										
										
										
											2012-10-15 19:28:28 -04:00
										 |  |  |  |                   "on schema '%s'", binding->property->name, G_OBJECT_TYPE_NAME (object), | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |                   g_type_name (binding->property->value_type), | 
					
						
							| 
									
										
										
										
											2018-07-17 12:14:07 +02:00
										 |  |  |  |                   type_string, key, | 
					
						
							| 
									
										
										
										
											2011-11-15 11:56:18 +00:00
										 |  |  |  |                   g_settings_schema_get_id (settings->priv->schema)); | 
					
						
							| 
									
										
										
										
											2018-07-17 12:14:07 +02:00
										 |  |  |  |       g_free (type_string); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       return; | 
					
						
							|  |  |  |  |     } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   if ((flags & G_SETTINGS_BIND_SET) && | 
					
						
							|  |  |  |  |       (~flags & G_SETTINGS_BIND_NO_SENSITIVITY)) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       GParamSpec *sensitive; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       sensitive = g_object_class_find_property (objectclass, "sensitive"); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       if (sensitive && sensitive->value_type == G_TYPE_BOOLEAN && | 
					
						
							|  |  |  |  |           (sensitive->flags & G_PARAM_WRITABLE)) | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |         g_settings_bind_writable (settings, binding->key.name, object, "sensitive", FALSE); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |     } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   if (flags & G_SETTINGS_BIND_SET) | 
					
						
							|  |  |  |  |     { | 
					
						
							| 
									
										
										
										
											2012-10-15 19:28:28 -04:00
										 |  |  |  |       detailed_signal = g_strdup_printf ("notify::%s", binding->property->name); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       binding->property_handler_id = | 
					
						
							|  |  |  |  |         g_signal_connect (object, detailed_signal, | 
					
						
							|  |  |  |  |                           G_CALLBACK (g_settings_binding_property_changed), | 
					
						
							|  |  |  |  |                           binding); | 
					
						
							|  |  |  |  |       g_free (detailed_signal); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |       if (~flags & G_SETTINGS_BIND_GET) | 
					
						
							|  |  |  |  |         g_settings_binding_property_changed (object, | 
					
						
							|  |  |  |  |                                              binding->property, | 
					
						
							|  |  |  |  |                                              binding); | 
					
						
							|  |  |  |  |     } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   if (flags & G_SETTINGS_BIND_GET) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       if (~flags & G_SETTINGS_BIND_GET_NO_CHANGES) | 
					
						
							|  |  |  |  |         { | 
					
						
							|  |  |  |  |           detailed_signal = g_strdup_printf ("changed::%s", key); | 
					
						
							|  |  |  |  |           binding->key_handler_id = | 
					
						
							|  |  |  |  |             g_signal_connect (settings, detailed_signal, | 
					
						
							|  |  |  |  |                               G_CALLBACK (g_settings_binding_key_changed), | 
					
						
							|  |  |  |  |                               binding); | 
					
						
							|  |  |  |  |           g_free (detailed_signal); | 
					
						
							|  |  |  |  |         } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2011-11-13 23:47:49 +01:00
										 |  |  |  |       g_settings_binding_key_changed (settings, binding->key.name, binding); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |     } | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2012-10-15 19:28:28 -04:00
										 |  |  |  |   binding_quark = g_settings_binding_quark (binding->property->name); | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_object_set_qdata_full (object, binding_quark, | 
					
						
							|  |  |  |  |                            binding, g_settings_binding_free); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-03-17 21:15:46 -07:00
										 |  |  |  | typedef struct _BindWithMappingClosuresData | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GClosure *get_mapping_closure; | 
					
						
							|  |  |  |  |   GClosure *set_mapping_closure; | 
					
						
							|  |  |  |  | } BindWithMappingClosuresData; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static BindWithMappingClosuresData * | 
					
						
							|  |  |  |  | bind_with_mapping_closures_data_new (GClosure *get_mapping_closure, | 
					
						
							|  |  |  |  |                                      GClosure *set_mapping_closure) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   BindWithMappingClosuresData *data; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   data = g_new0 (BindWithMappingClosuresData, 1); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (get_mapping_closure != NULL) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       data->get_mapping_closure = g_closure_ref (get_mapping_closure); | 
					
						
							|  |  |  |  |       g_closure_sink (get_mapping_closure); | 
					
						
							|  |  |  |  |       if (G_CLOSURE_NEEDS_MARSHAL (get_mapping_closure)) | 
					
						
							|  |  |  |  |         g_closure_set_marshal (get_mapping_closure, g_cclosure_marshal_generic); | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (set_mapping_closure != NULL) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       data->set_mapping_closure = g_closure_ref (set_mapping_closure); | 
					
						
							|  |  |  |  |       g_closure_sink (set_mapping_closure); | 
					
						
							|  |  |  |  |       if (G_CLOSURE_NEEDS_MARSHAL (set_mapping_closure)) | 
					
						
							|  |  |  |  |         g_closure_set_marshal (set_mapping_closure, g_cclosure_marshal_generic); | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return data; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | bind_with_mapping_closures_data_free (BindWithMappingClosuresData *data) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   if (data->get_mapping_closure != NULL) | 
					
						
							|  |  |  |  |     g_closure_unref (data->get_mapping_closure); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (data->set_mapping_closure != NULL) | 
					
						
							|  |  |  |  |     g_closure_unref (data->set_mapping_closure); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_free (data); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static gboolean | 
					
						
							|  |  |  |  | bind_with_mapping_invoke_get (GValue *value, | 
					
						
							|  |  |  |  |                               GVariant *variant, | 
					
						
							|  |  |  |  |                               void *user_data) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   BindWithMappingClosuresData *data = (BindWithMappingClosuresData *) user_data; | 
					
						
							|  |  |  |  |   GValue params[2] = { G_VALUE_INIT, G_VALUE_INIT }; | 
					
						
							|  |  |  |  |   GValue out = G_VALUE_INIT; | 
					
						
							|  |  |  |  |   gboolean retval; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_value_init (¶ms[0], G_TYPE_VALUE); | 
					
						
							|  |  |  |  |   g_value_set_boxed (¶ms[0], value); | 
					
						
							|  |  |  |  |   g_value_init (¶ms[1], G_TYPE_VARIANT); | 
					
						
							|  |  |  |  |   g_value_set_variant (¶ms[1], variant); | 
					
						
							|  |  |  |  |   g_value_init (&out, G_TYPE_BOOLEAN); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_closure_invoke (data->get_mapping_closure, &out, 2, params, /* hint = */ NULL); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   retval = g_value_get_boolean (&out); | 
					
						
							| 
									
										
										
										
											2025-06-17 18:17:46 +02:00
										 |  |  |  |   if (retval) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       const GValue *out_value = g_value_get_boxed (¶ms[0]); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |       g_assert (out_value != NULL); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |       g_value_copy (out_value, value); | 
					
						
							|  |  |  |  |     } | 
					
						
							| 
									
										
										
										
											2024-03-17 21:15:46 -07:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_value_unset (&out); | 
					
						
							|  |  |  |  |   g_value_unset (¶ms[0]); | 
					
						
							|  |  |  |  |   g_value_unset (¶ms[1]); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return retval; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static GVariant * | 
					
						
							|  |  |  |  | bind_with_mapping_invoke_set (const GValue *value, | 
					
						
							|  |  |  |  |                               const GVariantType *expected_type, | 
					
						
							|  |  |  |  |                               void *user_data) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   BindWithMappingClosuresData *data = (BindWithMappingClosuresData *) user_data; | 
					
						
							|  |  |  |  |   GValue params[2] = { G_VALUE_INIT, G_VALUE_INIT }; | 
					
						
							|  |  |  |  |   GValue out = G_VALUE_INIT; | 
					
						
							|  |  |  |  |   GVariant *retval; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_value_init (¶ms[0], G_TYPE_VALUE); | 
					
						
							|  |  |  |  |   g_value_set_boxed (¶ms[0], value); | 
					
						
							|  |  |  |  |   g_value_init (¶ms[1], G_TYPE_VARIANT_TYPE); | 
					
						
							|  |  |  |  |   g_value_set_boxed (¶ms[1], expected_type); | 
					
						
							|  |  |  |  |   g_value_init (&out, G_TYPE_VARIANT); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_closure_invoke (data->set_mapping_closure, &out, 2, params, /* hint = */ NULL); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   retval = g_value_dup_variant (&out); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_value_unset (&out); | 
					
						
							|  |  |  |  |   g_value_unset (¶ms[0]); | 
					
						
							|  |  |  |  |   g_value_unset (¶ms[1]); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return retval; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | bind_with_mapping_destroy (void *user_data) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   BindWithMappingClosuresData *data = (BindWithMappingClosuresData *) user_data; | 
					
						
							|  |  |  |  |   bind_with_mapping_closures_data_free (data); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_bind_with_mapping_closures: (rename-to g_settings_bind_with_mapping): | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2024-03-17 21:15:46 -07:00
										 |  |  |  |  * @key: the key to bind | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @object: the object with property to bind | 
					
						
							| 
									
										
										
										
											2024-03-17 21:15:46 -07:00
										 |  |  |  |  * @property: the name of the property to bind | 
					
						
							|  |  |  |  |  * @flags: flags for the binding | 
					
						
							|  |  |  |  |  * @get_mapping: (nullable): a function that gets called to convert values | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  *   from @settings to @object, or `NULL` to use the default GIO mapping | 
					
						
							| 
									
										
										
										
											2024-03-17 21:15:46 -07:00
										 |  |  |  |  * @set_mapping: (nullable): a function that gets called to convert values | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  *   from @object to @settings, or `NULL` to use the default GIO mapping | 
					
						
							| 
									
										
										
										
											2024-03-17 21:15:46 -07:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Version of [method@Gio.Settings.bind_with_mapping] using closures instead of | 
					
						
							|  |  |  |  |  * callbacks for easier binding in other languages. | 
					
						
							| 
									
										
										
										
											2024-03-17 21:15:46 -07:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.82 | 
					
						
							|  |  |  |  |  */ | 
					
						
							|  |  |  |  | void | 
					
						
							|  |  |  |  | g_settings_bind_with_mapping_closures (GSettings *settings, | 
					
						
							|  |  |  |  |                                        const char *key, | 
					
						
							|  |  |  |  |                                        GObject *object, | 
					
						
							|  |  |  |  |                                        const char *property, | 
					
						
							|  |  |  |  |                                        GSettingsBindFlags flags, | 
					
						
							|  |  |  |  |                                        GClosure *get_mapping, | 
					
						
							|  |  |  |  |                                        GClosure *set_mapping) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   BindWithMappingClosuresData *data; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   data = bind_with_mapping_closures_data_new (get_mapping, set_mapping); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_settings_bind_with_mapping (settings, key, object, property, flags, | 
					
						
							|  |  |  |  |                                 bind_with_mapping_invoke_get, | 
					
						
							|  |  |  |  |                                 bind_with_mapping_invoke_set, data, | 
					
						
							|  |  |  |  |                                 bind_with_mapping_destroy); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /* Writability binding {{{1 */ | 
					
						
							|  |  |  |  | typedef struct | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GSettings *settings; | 
					
						
							|  |  |  |  |   gpointer object; | 
					
						
							|  |  |  |  |   const gchar *key; | 
					
						
							|  |  |  |  |   const gchar *property; | 
					
						
							|  |  |  |  |   gboolean inverted; | 
					
						
							|  |  |  |  |   gulong handler_id; | 
					
						
							|  |  |  |  | } GSettingsWritableBinding; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_writable_binding_free (gpointer data) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GSettingsWritableBinding *binding = data; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_signal_handler_disconnect (binding->settings, binding->handler_id); | 
					
						
							|  |  |  |  |   g_object_unref (binding->settings); | 
					
						
							|  |  |  |  |   g_slice_free (GSettingsWritableBinding, binding); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_binding_writable_changed (GSettings   *settings, | 
					
						
							|  |  |  |  |                                      const gchar *key, | 
					
						
							|  |  |  |  |                                      gpointer     user_data) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GSettingsWritableBinding *binding = user_data; | 
					
						
							|  |  |  |  |   gboolean writable; | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_assert (settings == binding->settings); | 
					
						
							|  |  |  |  |   g_assert (key == binding->key); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   writable = g_settings_is_writable (settings, key); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   if (binding->inverted) | 
					
						
							|  |  |  |  |     writable = !writable; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_object_set (binding->object, binding->property, writable, NULL); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * g_settings_bind_writable: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @key: the key to bind | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @object: (type GObject.Object): the object with property to bind | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @property: the name of a boolean property to bind | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @inverted: whether to ‘invert’ the value | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Create a binding between the writability of @key in the | 
					
						
							|  |  |  |  |  * @settings object and the property @property of @object. | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * The property must be boolean; `sensitive` or `visible` | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * properties of widgets are the most likely candidates. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Writable bindings are always uni-directional; changes of the | 
					
						
							|  |  |  |  |  * writability of the setting will be propagated to the object | 
					
						
							|  |  |  |  |  * property, not the other way. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * When the @inverted argument is true, the binding inverts the | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * value as it passes from the setting to the object, i.e. @property | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * will be set to true if the key is not writable. | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2017-10-20 21:19:26 +08:00
										 |  |  |  |  * Note that the lifecycle of the binding is tied to @object, | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * and that you can have only one binding per object property. | 
					
						
							|  |  |  |  |  * If you bind the same property twice on the same object, the second | 
					
						
							|  |  |  |  |  * binding overrides the first one. | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | void | 
					
						
							|  |  |  |  | g_settings_bind_writable (GSettings   *settings, | 
					
						
							|  |  |  |  |                           const gchar *key, | 
					
						
							|  |  |  |  |                           gpointer     object, | 
					
						
							|  |  |  |  |                           const gchar *property, | 
					
						
							|  |  |  |  |                           gboolean     inverted) | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GSettingsWritableBinding *binding; | 
					
						
							|  |  |  |  |   gchar *detailed_signal; | 
					
						
							|  |  |  |  |   GParamSpec *pspec; | 
					
						
							| 
									
										
										
										
											2010-06-02 04:00:58 +02:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   g_return_if_fail (G_IS_SETTINGS (settings)); | 
					
						
							| 
									
										
										
										
											2010-06-02 04:00:58 +02:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property); | 
					
						
							|  |  |  |  |   if (pspec == NULL) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       g_critical ("g_settings_bind_writable: no property '%s' on class '%s'", | 
					
						
							|  |  |  |  |                   property, G_OBJECT_TYPE_NAME (object)); | 
					
						
							|  |  |  |  |       return; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  |   if ((pspec->flags & G_PARAM_WRITABLE) == 0) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       g_critical ("g_settings_bind_writable: property '%s' on class '%s' is not writable", | 
					
						
							|  |  |  |  |                   property, G_OBJECT_TYPE_NAME (object)); | 
					
						
							|  |  |  |  |       return; | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   binding = g_slice_new (GSettingsWritableBinding); | 
					
						
							|  |  |  |  |   binding->settings = g_object_ref (settings); | 
					
						
							|  |  |  |  |   binding->object = object; | 
					
						
							|  |  |  |  |   binding->key = g_intern_string (key); | 
					
						
							|  |  |  |  |   binding->property = g_intern_string (property); | 
					
						
							|  |  |  |  |   binding->inverted = inverted; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   detailed_signal = g_strdup_printf ("writable-changed::%s", key); | 
					
						
							|  |  |  |  |   binding->handler_id = | 
					
						
							|  |  |  |  |     g_signal_connect (settings, detailed_signal, | 
					
						
							|  |  |  |  |                       G_CALLBACK (g_settings_binding_writable_changed), | 
					
						
							|  |  |  |  |                       binding); | 
					
						
							|  |  |  |  |   g_free (detailed_signal); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_object_set_qdata_full (object, g_settings_binding_quark (property), | 
					
						
							|  |  |  |  |                            binding, g_settings_writable_binding_free); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_settings_binding_writable_changed (settings, binding->key, binding); | 
					
						
							| 
									
										
										
										
											2010-04-16 23:17:01 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-10 22:30:44 -04:00
										 |  |  |  | /**
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * g_settings_unbind: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @object: (type GObject.Object): the object with property to unbind | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * @property: the property whose binding is removed | 
					
						
							| 
									
										
										
										
											2010-06-10 22:30:44 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Removes an existing binding for @property on @object. | 
					
						
							| 
									
										
										
										
											2010-06-10 22:30:44 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Note that bindings are automatically removed when the | 
					
						
							|  |  |  |  |  * object is finalized, so it is rarely necessary to call this | 
					
						
							|  |  |  |  |  * function. | 
					
						
							| 
									
										
										
										
											2010-06-10 22:30:44 -04:00
										 |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |  * Since: 2.26 | 
					
						
							|  |  |  |  |  */ | 
					
						
							| 
									
										
										
										
											2010-06-10 22:30:44 -04:00
										 |  |  |  | void | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | g_settings_unbind (gpointer     object, | 
					
						
							|  |  |  |  |                    const gchar *property) | 
					
						
							| 
									
										
										
										
											2010-06-10 22:30:44 -04:00
										 |  |  |  | { | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   GQuark binding_quark; | 
					
						
							| 
									
										
										
										
											2010-06-10 22:30:44 -04:00
										 |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  |   binding_quark = g_settings_binding_quark (property); | 
					
						
							|  |  |  |  |   g_object_set_qdata (object, binding_quark, NULL); | 
					
						
							| 
									
										
										
										
											2010-06-10 22:30:44 -04:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2012-01-19 09:40:24 -05:00
										 |  |  |  | /* GAction {{{1 */ | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | typedef struct | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GObject parent_instance; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   GSettingsSchemaKey key; | 
					
						
							|  |  |  |  |   GSettings *settings; | 
					
						
							|  |  |  |  | } GSettingsAction; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | typedef GObjectClass GSettingsActionClass; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static GType g_settings_action_get_type (void); | 
					
						
							|  |  |  |  | static void g_settings_action_iface_init (GActionInterface *iface); | 
					
						
							|  |  |  |  | G_DEFINE_TYPE_WITH_CODE (GSettingsAction, g_settings_action, G_TYPE_OBJECT, | 
					
						
							|  |  |  |  |                          G_IMPLEMENT_INTERFACE (G_TYPE_ACTION, g_settings_action_iface_init)) | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | enum | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   ACTION_PROP_0, | 
					
						
							|  |  |  |  |   ACTION_PROP_NAME, | 
					
						
							|  |  |  |  |   ACTION_PROP_PARAMETER_TYPE, | 
					
						
							|  |  |  |  |   ACTION_PROP_ENABLED, | 
					
						
							|  |  |  |  |   ACTION_PROP_STATE_TYPE, | 
					
						
							|  |  |  |  |   ACTION_PROP_STATE | 
					
						
							|  |  |  |  | }; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static const gchar * | 
					
						
							|  |  |  |  | g_settings_action_get_name (GAction *action) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsAction *gsa = (GSettingsAction *) action; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return gsa->key.name; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static const GVariantType * | 
					
						
							|  |  |  |  | g_settings_action_get_parameter_type (GAction *action) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsAction *gsa = (GSettingsAction *) action; | 
					
						
							|  |  |  |  |   const GVariantType *type; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   type = g_variant_get_type (gsa->key.default_value); | 
					
						
							|  |  |  |  |   if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN)) | 
					
						
							|  |  |  |  |     type = NULL; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return type; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static gboolean | 
					
						
							|  |  |  |  | g_settings_action_get_enabled (GAction *action) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsAction *gsa = (GSettingsAction *) action; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return g_settings_is_writable (gsa->settings, gsa->key.name); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static const GVariantType * | 
					
						
							|  |  |  |  | g_settings_action_get_state_type (GAction *action) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsAction *gsa = (GSettingsAction *) action; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return g_variant_get_type (gsa->key.default_value); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static GVariant * | 
					
						
							|  |  |  |  | g_settings_action_get_state (GAction *action) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsAction *gsa = (GSettingsAction *) action; | 
					
						
							|  |  |  |  |   GVariant *value; | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2013-10-27 10:33:08 -07:00
										 |  |  |  |   value = g_settings_read_from_backend (gsa->settings, &gsa->key, FALSE, FALSE); | 
					
						
							| 
									
										
										
										
											2012-01-19 09:40:24 -05:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (value == NULL) | 
					
						
							| 
									
										
										
										
											2023-01-13 22:14:56 +00:00
										 |  |  |  |     value = g_settings_schema_key_get_default_value (&gsa->key); | 
					
						
							| 
									
										
										
										
											2012-01-19 09:40:24 -05:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   return value; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static GVariant * | 
					
						
							|  |  |  |  | g_settings_action_get_state_hint (GAction *action) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsAction *gsa = (GSettingsAction *) action; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   /* no point in reimplementing this... */ | 
					
						
							| 
									
										
										
										
											2013-10-27 17:03:04 -07:00
										 |  |  |  |   return g_settings_schema_key_get_range (&gsa->key); | 
					
						
							| 
									
										
										
										
											2012-01-19 09:40:24 -05:00
										 |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_action_change_state (GAction  *action, | 
					
						
							|  |  |  |  |                                 GVariant *value) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsAction *gsa = (GSettingsAction *) action; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (g_settings_schema_key_type_check (&gsa->key, value) && g_settings_schema_key_range_check (&gsa->key, value)) | 
					
						
							|  |  |  |  |     g_settings_write_to_backend (gsa->settings, &gsa->key, value); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_action_activate (GAction  *action, | 
					
						
							|  |  |  |  |                             GVariant *parameter) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsAction *gsa = (GSettingsAction *) action; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   if (g_variant_is_of_type (gsa->key.default_value, G_VARIANT_TYPE_BOOLEAN)) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |       GVariant *old; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |       if (parameter != NULL) | 
					
						
							|  |  |  |  |         return; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |       old = g_settings_action_get_state (action); | 
					
						
							|  |  |  |  |       parameter = g_variant_new_boolean (!g_variant_get_boolean (old)); | 
					
						
							|  |  |  |  |       g_variant_unref (old); | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_action_change_state (action, parameter); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_action_get_property (GObject *object, guint prop_id, | 
					
						
							|  |  |  |  |                                 GValue *value, GParamSpec *pspec) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GAction *action = G_ACTION (object); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   switch (prop_id) | 
					
						
							|  |  |  |  |     { | 
					
						
							|  |  |  |  |     case ACTION_PROP_NAME: | 
					
						
							|  |  |  |  |       g_value_set_string (value, g_settings_action_get_name (action)); | 
					
						
							|  |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |     case ACTION_PROP_PARAMETER_TYPE: | 
					
						
							|  |  |  |  |       g_value_set_boxed (value, g_settings_action_get_parameter_type (action)); | 
					
						
							|  |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |     case ACTION_PROP_ENABLED: | 
					
						
							|  |  |  |  |       g_value_set_boolean (value, g_settings_action_get_enabled (action)); | 
					
						
							|  |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |     case ACTION_PROP_STATE_TYPE: | 
					
						
							|  |  |  |  |       g_value_set_boxed (value, g_settings_action_get_state_type (action)); | 
					
						
							|  |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |     case ACTION_PROP_STATE: | 
					
						
							| 
									
										
										
										
											2020-12-15 10:54:41 +00:00
										 |  |  |  |       g_value_take_variant (value, g_settings_action_get_state (action)); | 
					
						
							| 
									
										
										
										
											2012-01-19 09:40:24 -05:00
										 |  |  |  |       break; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |     default: | 
					
						
							|  |  |  |  |       g_assert_not_reached (); | 
					
						
							|  |  |  |  |     } | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_action_finalize (GObject *object) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsAction *gsa = (GSettingsAction *) object; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_signal_handlers_disconnect_by_data (gsa->settings, gsa); | 
					
						
							|  |  |  |  |   g_object_unref (gsa->settings); | 
					
						
							| 
									
										
										
										
											2017-02-27 10:05:58 +00:00
										 |  |  |  |   g_settings_schema_key_clear (&gsa->key); | 
					
						
							| 
									
										
										
										
											2012-01-19 09:40:24 -05:00
										 |  |  |  | 
 | 
					
						
							|  |  |  |  |   G_OBJECT_CLASS (g_settings_action_parent_class) | 
					
						
							|  |  |  |  |     ->finalize (object); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_action_init (GSettingsAction *gsa) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_action_iface_init (GActionInterface *iface) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   iface->get_name = g_settings_action_get_name; | 
					
						
							|  |  |  |  |   iface->get_parameter_type = g_settings_action_get_parameter_type; | 
					
						
							|  |  |  |  |   iface->get_enabled = g_settings_action_get_enabled; | 
					
						
							|  |  |  |  |   iface->get_state_type = g_settings_action_get_state_type; | 
					
						
							|  |  |  |  |   iface->get_state = g_settings_action_get_state; | 
					
						
							|  |  |  |  |   iface->get_state_hint = g_settings_action_get_state_hint; | 
					
						
							|  |  |  |  |   iface->change_state = g_settings_action_change_state; | 
					
						
							|  |  |  |  |   iface->activate = g_settings_action_activate; | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_action_class_init (GSettingsActionClass *class) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   class->get_property = g_settings_action_get_property; | 
					
						
							|  |  |  |  |   class->finalize = g_settings_action_finalize; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_object_class_override_property (class, ACTION_PROP_NAME, "name"); | 
					
						
							|  |  |  |  |   g_object_class_override_property (class, ACTION_PROP_PARAMETER_TYPE, "parameter-type"); | 
					
						
							|  |  |  |  |   g_object_class_override_property (class, ACTION_PROP_ENABLED, "enabled"); | 
					
						
							|  |  |  |  |   g_object_class_override_property (class, ACTION_PROP_STATE_TYPE, "state-type"); | 
					
						
							|  |  |  |  |   g_object_class_override_property (class, ACTION_PROP_STATE, "state"); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_action_changed (GSettings   *settings, | 
					
						
							|  |  |  |  |                            const gchar *key, | 
					
						
							|  |  |  |  |                            gpointer     user_data) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   g_object_notify (user_data, "state"); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | static void | 
					
						
							|  |  |  |  | g_settings_action_enabled_changed (GSettings   *settings, | 
					
						
							|  |  |  |  |                                    const gchar *key, | 
					
						
							|  |  |  |  |                                    gpointer     user_data) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   g_object_notify (user_data, "enabled"); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /**
 | 
					
						
							|  |  |  |  |  * g_settings_create_action: | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * @settings: the settings object | 
					
						
							| 
									
										
										
										
											2012-01-19 09:40:24 -05:00
										 |  |  |  |  * @key: the name of a key in @settings | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Creates a [iface@Gio.Action] corresponding to a given [class@Gio.Settings] key. | 
					
						
							| 
									
										
										
										
											2012-01-19 09:40:24 -05:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * The action has the same name as the key. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * The value of the key becomes the state of the action and the action | 
					
						
							|  |  |  |  |  * is enabled when the key is writable.  Changing the state of the | 
					
						
							|  |  |  |  |  * action results in the key being written to.  Changes to the value or | 
					
						
							|  |  |  |  |  * writability of the key cause appropriate change notifications to be | 
					
						
							|  |  |  |  |  * emitted for the action. | 
					
						
							|  |  |  |  |  * | 
					
						
							|  |  |  |  |  * For boolean-valued keys, action activations take no parameter and | 
					
						
							|  |  |  |  |  * result in the toggling of the value.  For all other types, | 
					
						
							|  |  |  |  |  * activations take the new value for the key (which must have the | 
					
						
							|  |  |  |  |  * correct type). | 
					
						
							|  |  |  |  |  * | 
					
						
							| 
									
										
										
										
											2025-03-04 12:41:56 +00:00
										 |  |  |  |  * Returns: (not nullable) (transfer full): a new [iface@Gio.Action] | 
					
						
							| 
									
										
										
										
											2012-01-19 09:40:24 -05:00
										 |  |  |  |  * | 
					
						
							|  |  |  |  |  * Since: 2.32 | 
					
						
							|  |  |  |  |  **/ | 
					
						
							|  |  |  |  | GAction * | 
					
						
							|  |  |  |  | g_settings_create_action (GSettings   *settings, | 
					
						
							|  |  |  |  |                           const gchar *key) | 
					
						
							|  |  |  |  | { | 
					
						
							|  |  |  |  |   GSettingsAction *gsa; | 
					
						
							|  |  |  |  |   gchar *detailed_signal; | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL); | 
					
						
							|  |  |  |  |   g_return_val_if_fail (key != NULL, NULL); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   gsa = g_object_new (g_settings_action_get_type (), NULL); | 
					
						
							|  |  |  |  |   gsa->settings = g_object_ref (settings); | 
					
						
							|  |  |  |  |   g_settings_schema_key_init (&gsa->key, settings->priv->schema, key); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   detailed_signal = g_strdup_printf ("changed::%s", key); | 
					
						
							|  |  |  |  |   g_signal_connect (settings, detailed_signal, G_CALLBACK (g_settings_action_changed), gsa); | 
					
						
							|  |  |  |  |   g_free (detailed_signal); | 
					
						
							|  |  |  |  |   detailed_signal = g_strdup_printf ("writable-changed::%s", key); | 
					
						
							|  |  |  |  |   g_signal_connect (settings, detailed_signal, G_CALLBACK (g_settings_action_enabled_changed), gsa); | 
					
						
							|  |  |  |  |   g_free (detailed_signal); | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  |   return G_ACTION (gsa); | 
					
						
							|  |  |  |  | } | 
					
						
							|  |  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-06-14 17:29:41 -04:00
										 |  |  |  | /* Epilogue {{{1 */ | 
					
						
							|  |  |  |  | 
 | 
					
						
							|  |  |  |  | /* vim:set foldmethod=marker: */ |