Gio.Settings¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`list_relocatable_schemas` ()
class	`list_schemas` ()
class	`new` (schema_id)
class	`new_full` (schema, backend, path)
class	`new_with_backend` (schema_id, backend)
class	`new_with_backend_and_path` (schema_id, backend, path)
class	`new_with_path` (schema_id, path)
class	`sync` ()
class	`unbind` (object, property)
	`apply` ()
	`bind` (key, object, property, flags)
	`bind_writable` (key, object, property, inverted)
	`create_action` (key)
	`delay` ()
	`get_boolean` (key)
	`get_child` (name)
	`get_default_value` (key)
	`get_double` (key)
	`get_enum` (key)
	`get_flags` (key)
	`get_has_unapplied` ()
	`get_int` (key)
	`get_int64` (key)
	`get_mapped` (key, mapping, *user_data)
	`get_range` (key)
	`get_string` (key)
	`get_strv` (key)
	`get_uint` (key)
	`get_uint64` (key)
	`get_user_value` (key)
	`get_value` (key)
	`is_writable` (name)
	`keys` ()
	`list_children` ()
	`list_keys` ()
	`range_check` (key, value)
	`reset` (key)
	`revert` ()
	`set_boolean` (key, value)
	`set_double` (key, value)
	`set_enum` (key, value)
	`set_flags` (key, value)
	`set_int` (key, value)
	`set_int64` (key, value)
	`set_string` (key, value)
	`set_strv` (key, value)
	`set_uint` (key, value)
	`set_uint64` (key, value)
	`set_value` (key, value)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_change_event` (keys, n_keys)
	`do_changed` (key)
	`do_writable_change_event` (key)
	`do_writable_changed` (key)

Properties¶

Name	Type	Flags	Short Description
`backend`	`Gio.SettingsBackend`	r/w/co	The `Gio.SettingsBackend` for this settings object
`delay-apply`	`bool`	r	Whether this settings object is in “delay-apply” mode
`has-unapplied`	`bool`	r	`True` if there are outstanding changes to apply()
`path`	`str`	r/w/co	The path within the backend where the settings are
`schema`	`str`	d/r/w/co	The name of the schema for this settings object `deprecated`
`schema-id`	`str`	r/w/co	The name of the schema for this settings object
`settings-schema`	`Gio.SettingsSchema`	r/w/co	The `Gio.SettingsSchema` for this settings object

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`change-event`	The “change-event” signal is emitted once per change event that affects this settings object.
`changed`	The “changed” signal is emitted when a key has potentially changed.
`writable-change-event`	The “writable-change-event” signal is emitted once per writability change event that affects this settings object.
`writable-changed`	The “writable-changed” signal is emitted when the writability of a key has potentially changed.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Gio.Settings(*args, **kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Gio.SettingsClass

Provide dictionary-like access to GLib.Settings.

classmethod list_relocatable_schemas()[source]¶

Returns:: a list of relocatable Gio.Settings schemas that are available, in no defined order. The list must not be modified or freed.
Return type:: [str]

Deprecated.

New in version 2.28.

Deprecated since version 2.40: Use Gio.SettingsSchemaSource.list_schemas() instead

classmethod list_schemas()[source]¶

Returns:: a list of Gio.Settings schemas that are available, in no defined order. The list must not be modified or freed.
Return type:: [str]

Deprecated.

New in version 2.26.

Deprecated since version 2.40: Use Gio.SettingsSchemaSource.list_schemas() instead. If you used Gio.Settings.list_schemas() to check for the presence of a particular schema, use Gio.SettingsSchemaSource.lookup() instead of your whole loop.

classmethod new(schema_id)[source]¶

Parameters:: schema_id (str) – the id of the schema
Returns:: a new Gio.Settings object
Return type:: Gio.Settings

Creates a new Gio.Settings object with the schema specified by schema_id.

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 optional runtime dependency), Gio.SettingsSchemaSource.lookup() can be used to test for their existence before loading them.

Signals on the newly created Gio.Settings object will be dispatched via the thread-default GLib.MainContext in effect at the time of the call to Gio.Settings.new(). The new Gio.Settings will hold a reference on the context. See GLib.MainContext.push_thread_default().

New in version 2.26.

classmethod new_full(schema, backend, path)[source]¶

Parameters:

schema (Gio.SettingsSchema) – a Gio.SettingsSchema
backend (Gio.SettingsBackend or None) – a Gio.SettingsBackend
path (str or None) – the path to use

Returns:

a new Gio.Settings object

Return type:

Gio.Settings

Creates a new Gio.Settings object with a given schema, backend and 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).

At the most basic level, a Gio.Settings object is a pure composition of 4 things: a Gio.SettingsSchema, a Gio.SettingsBackend, a path within that backend, and a GLib.MainContext to which signals are dispatched.

This constructor therefore gives you full control over constructing Gio.Settings instances. The first 3 parameters are given directly as schema, backend and path, and the main context is taken from the thread-default (as per Gio.Settings.new()).

If backend is None then the default backend is used.

If path is None then the path from the schema is used. It is an error if path is None and the schema has no path of its own or if path is non-None and not equal to the path that the schema does have.

New in version 2.32.

classmethod new_with_backend(schema_id, backend)[source]¶

Parameters:

schema_id (str) – the id of the schema
backend (Gio.SettingsBackend) – the Gio.SettingsBackend to use

Returns:

a new Gio.Settings object

Return type:

Gio.Settings

Creates a new Gio.Settings object with the schema specified by schema_id and a given Gio.SettingsBackend.

Creating a Gio.Settings object with a different backend allows accessing settings from a database other than the usual one. For example, it may make sense to pass a backend corresponding to the “defaults” settings database on the system to get a settings object that modifies the system default settings instead of the settings for this user.

New in version 2.26.

classmethod new_with_backend_and_path(schema_id, backend, path)[source]¶

Parameters:

schema_id (str) – the id of the schema
backend (Gio.SettingsBackend) – the Gio.SettingsBackend to use
path (str) – the path to use

Returns:

a new Gio.Settings object

Return type:

Gio.Settings

Creates a new Gio.Settings object with the schema specified by schema_id and a given Gio.SettingsBackend and path.

This is a mix of Gio.Settings.new_with_backend() and Gio.Settings.new_with_path().

New in version 2.26.

classmethod new_with_path(schema_id, path)[source]¶

Parameters:

schema_id (str) – the id of the schema
path (str) – the path to use

Returns:

a new Gio.Settings object

Return type:

Gio.Settings

Creates a new Gio.Settings object with the relocatable schema specified by schema_id and a given path.

You only need to do this if you want to directly create a settings object with a schema that doesn’t have a specified path of its own. That’s quite rare.

It is a programmer error to call this function for a schema that has an explicitly specified path.

It is a programmer error if path is not a valid path. A valid path begins and ends with ‘/’ and does not contain two consecutive ‘/’ characters.

New in version 2.26.

classmethod sync()[source]¶

Ensures that all pending operations are complete for the default backend.

Writes made to a Gio.Settings are handled asynchronously. For this reason, it is very unlikely that the changes have it to disk by the time g_settings_set() returns.

This call will block until all of the writes have made it to the backend. Since the mainloop is not running, no change notifications will be dispatched during this call (but some may be queued by the time the call is done).

classmethod unbind(object, property)[source]¶

Parameters:

object (GObject.Object) – the object
property (str) – the property whose binding is removed

Removes an existing binding for property on object.

Note that bindings are automatically removed when the object is finalized, so it is rarely necessary to call this function.

New in version 2.26.

apply()[source]¶: Applies any changes that have been made to the settings. This function does nothing unless self is in ‘delay-apply’ mode; see Gio.Settings.delay(). In the normal case settings are always applied immediately.

bind(key, object, property, flags)[source]¶

Parameters:

key (str) – the key to bind
object (GObject.Object) – a GObject.Object
property (str) – the name of the property to bind
flags (Gio.SettingsBindFlags) – flags for the binding

Create a binding between the key in the self object and the property property of object.

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 straightforward way. Use g_settings_bind_with_mapping() if you need a custom mapping, or map between types that are not supported by the default mapping functions.

Unless the flags include Gio.SettingsBindFlags.NO_SENSITIVITY, this function also establishes a binding between the writability of key and the “sensitive” property of object (if object has a boolean property by that name). See Gio.Settings.bind_writable() for more details about writable bindings.

Note that the lifecycle of the binding is tied to object, 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.

New in version 2.26.

bind_writable(key, object, property, inverted)[source]¶

Parameters:

key (str) – the key to bind
object (GObject.Object) – a GObject.Object
property (str) – the name of a boolean property to bind
inverted (bool) – whether to ‘invert’ the value

Create a binding between the writability of key in the self object and the property property of object. The property must be boolean; “sensitive” or “visible” properties of widgets are the most likely candidates.

Writable bindings are always uni-directional; changes of the writability of the setting will be propagated to the object property, not the other way.

When the inverted argument is True, the binding inverts the value as it passes from the setting to the object, i.e. property will be set to True if the key is not writable.

Note that the lifecycle of the binding is tied to object, 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.

New in version 2.26.

create_action(key)[source]¶

Parameters:: key (str) – the name of a key in self
Returns:: a new Gio.Action
Return type:: Gio.Action

Creates a Gio.Action corresponding to a given Gio.Settings key.

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).

New in version 2.32.

delay()[source]¶: Changes the Gio.Settings object into ‘delay-apply’ mode. In this mode, changes to self are not immediately propagated to the backend, but kept locally until Gio.Settings.apply() is called.

New in version 2.26.

get_boolean(key)[source]¶

Parameters:: key (str) – the key to get the value for
Returns:: a boolean
Return type:: bool

Gets the value that is stored at key in self.

A convenience variant of g_settings_get() for booleans.

It is a programmer error to give a key that isn’t specified as having a boolean type in the schema for self.

New in version 2.26.

get_child(name)[source]¶

Parameters:: name (str) – the name of the child schema
Returns:: a ‘child’ settings object
Return type:: Gio.Settings

Creates a child settings object which has a base path of base-path/@name, where base-path is the base path of self.

The schema for the child settings object must have been declared in the schema of self using a <child> element.

The created child settings object will inherit the Gio.Settings :delay-apply mode from self.

New in version 2.26.

get_default_value(key)[source]¶

Parameters:: key (str) – the key to get the default value for
Returns:: the default value
Return type:: GLib.Variant or None

Gets the “default value” of a key.

This is the value that would be read if Gio.Settings.reset() were to be called on the key.

Note that this may be a different value than returned by Gio.SettingsSchemaKey.get_default_value() if the system administrator has provided a default value.

Comparing the return values of Gio.Settings.get_default_value() and Gio.Settings.get_value() is not sufficient for determining if a value has been set because the user may have explicitly set the value to something that happens to be equal to the default. The difference here is that if the default changes in the future, the user’s key 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.

It is a programmer error to give a key that isn’t contained in the schema for self.

New in version 2.40.

get_double(key)[source]¶

Parameters:: key (str) – the key to get the value for
Returns:: a double
Return type:: float

Gets the value that is stored at key in self.

A convenience variant of g_settings_get() for doubles.

It is a programmer error to give a key that isn’t specified as having a ‘double’ type in the schema for self.

New in version 2.26.

get_enum(key)[source]¶

Parameters:: key (str) – the key to get the value for
Returns:: the enum value
Return type:: int

Gets the value that is stored in self 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.

It is a programmer error to give a key that isn’t contained in the schema for self or is not marked as an enumerated type.

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.

New in version 2.26.

get_flags(key)[source]¶

Parameters:: key (str) – the key to get the value for
Returns:: the flags value
Return type:: int

Gets the value that is stored in self 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 of strings and it must be marked in the schema file as a flags type.

It is a programmer error to give a key that isn’t contained in the schema for self 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.

New in version 2.26.

get_has_unapplied()[source]¶

Returns:: True if self has unapplied changes
Return type:: bool

Returns whether the Gio.Settings object has any unapplied changes. This can only be the case if it is in ‘delayed-apply’ mode.

New in version 2.26.

get_int(key)[source]¶

Parameters:: key (str) – the key to get the value for
Returns:: an integer
Return type:: int

Gets the value that is stored at key in self.

A convenience variant of g_settings_get() for 32-bit integers.

It is a programmer error to give a key that isn’t specified as having a int32 type in the schema for self.

New in version 2.26.

get_int64(key)[source]¶

Parameters:: key (str) – the key to get the value for
Returns:: a 64-bit integer
Return type:: int

Gets the value that is stored at key in self.

A convenience variant of g_settings_get() for 64-bit integers.

It is a programmer error to give a key that isn’t specified as having a int64 type in the schema for self.

New in version 2.50.

get_mapped(key, mapping, *user_data)[source]¶

Parameters:

key (str) – the key to get the value for
mapping (Gio.SettingsGetMapping) – the function to map the value in the settings database to the value used by the application
user_data (object or None) – user data for mapping

Returns:

the result, which may be None

Return type:

object or None

Gets the value that is stored at key in self, 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.

This allows a robust ‘fall back to defaults’ behaviour to be implemented somewhat automatically.

The first value that is tried is the user’s setting for the key. If 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 attempt is made: the mapping function is called with a None value. 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 object which is initially set to None. The same pointer is given to each invocation of mapping. The final value of that object is what is returned by this function. None is valid; it is returned just as any other value would be.

get_range(key)[source]¶

Parameters:: key (str) – the key to query the range of
Return type:: GLib.Variant

Queries the range of a key.

New in version 2.28.

Deprecated since version 2.40: Use Gio.SettingsSchemaKey.get_range() instead.

get_string(key)[source]¶

Parameters:: key (str) – the key to get the value for
Returns:: a newly-allocated string
Return type:: str

Gets the value that is stored at key in self.

A convenience variant of g_settings_get() for strings.

It is a programmer error to give a key that isn’t specified as having a string type in the schema for self.

New in version 2.26.

get_strv(key)[source]¶

Parameters:: key (str) – the key to get the value for
Returns:: a newly-allocated, None-terminated array of strings, the value that is stored at key in self.
Return type:: [str]

A convenience variant of g_settings_get() for string arrays.

It is a programmer error to give a key that isn’t specified as having an array of strings type in the schema for self.

New in version 2.26.

get_uint(key)[source]¶

Parameters:: key (str) – the key to get the value for
Returns:: an unsigned integer
Return type:: int

Gets the value that is stored at key in self.

A convenience variant of g_settings_get() for 32-bit unsigned integers.

It is a programmer error to give a key that isn’t specified as having a uint32 type in the schema for self.

New in version 2.30.

get_uint64(key)[source]¶

Parameters:: key (str) – the key to get the value for
Returns:: a 64-bit unsigned integer
Return type:: int

Gets the value that is stored at key in self.

A convenience variant of g_settings_get() for 64-bit unsigned integers.

It is a programmer error to give a key that isn’t specified as having a uint64 type in the schema for self.

New in version 2.50.

get_user_value(key)[source]¶

Parameters:: key (str) – the key to get the user value for
Returns:: the user’s value, if set
Return type:: GLib.Variant or None

Checks the “user value” of a key, if there is one.

The user value of a key is the last value that was set by the user.

After calling Gio.Settings.reset() this function should always return None (assuming something is not wrong with the system configuration).

It is possible that Gio.Settings.get_value() will return a different 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 administrator – this function will return the user’s old value.

This function may be useful for adding a “reset” option to a UI or for providing indication that a particular value has been changed.

It is a programmer error to give a key that isn’t contained in the schema for self.

New in version 2.40.

get_value(key)[source]¶

Parameters:: key (str) – the key to get the value for
Returns:: a new GLib.Variant
Return type:: GLib.Variant

Gets the value that is stored in self for key.

It is a programmer error to give a key that isn’t contained in the schema for self.

New in version 2.26.

is_writable(name)[source]¶

Parameters:: name (str) – the name of a key
Returns:: True if the key name is writable
Return type:: bool

Finds out if a key can be written or not

New in version 2.26.

keys()¶

list_children()[source]¶

Returns:: a list of the children on self, in no defined order
Return type:: [str]

Gets the list of children on self.

The list is exactly the list of strings for which it is not an error to call Gio.Settings.get_child().

There is little reason to call this function from “normal” code, since you should already know what children are in your schema. This function may still be useful there for introspection reasons, however.

You should free the return value with GLib.strfreev() when you are done with it.

list_keys()[source]¶

Returns:: a list of the keys on self, in no defined order
Return type:: [str]

Introspects the list of keys on self.

You should probably not be calling this function from “normal” code (since you should already know what keys are in your schema). This function is intended for introspection reasons.

You should free the return value with GLib.strfreev() when you are done with it.

Deprecated since version 2.46: Use Gio.SettingsSchema.list_keys() instead.

range_check(key, value)[source]¶

Parameters:

key (str) – the key to check
value (GLib.Variant) – the value to check

Returns:

True if value is valid for key

Return type:

Gio.Settings¶

Methods¶

Virtual Methods¶

Properties¶

Signals¶

Fields¶

Class Details¶

Signal Details¶

Property Details¶