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_with_mapping (key, object, property, flags, get_mapping, set_mapping)
	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
delay-apply	bool	r
has-unapplied	bool	r
path	str	r/w/co
schema	str	d/r/w/co	deprecated
schema-id	str	r/w/co
settings-schema	Gio.SettingsSchema	r/w/co

Signals

Inherited:

GObject.Object (1)

Name	Short Description
change-event	Emitted once per change event that affects this settings object.
changed	Emitted when a key has potentially changed.
writable-change-event	Emitted once per writability change event that affects this settings object.
writable-changed	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()

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

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)

Parameters:

schema_id (str) – the ID of the schema

Returns:

a new [class`Gio`.Settings] object

Return type:

Gio.Settings

Creates a new [class`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), [method`Gio`.SettingsSchemaSource.lookup] can be used to test for their existence before loading them.

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

New in version 2.26.

classmethod new_full(schema, backend, path)

Parameters:

• schema (Gio.SettingsSchema) – the schema describing the settings

• backend (Gio.SettingsBackend or None) – the settings backend to use

• path (str or None) – the path to use

Returns:

a new [class`Gio`.Settings] object

Return type:

Gio.Settings

Creates a new [class`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 [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.

This constructor therefore gives you full control over constructing [class`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 [ctor`Gio`.Settings.new]).

If backend is NULL then the default backend is used.

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

New in version 2.32.

classmethod new_with_backend(schema_id, backend)

Parameters:

• schema_id (str) – the ID of the schema

• backend (Gio.SettingsBackend) – the settings backend to use

Returns:

a new [class`Gio`.Settings] object

Return type:

Gio.Settings

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

Creating a [class`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)

Parameters:

• schema_id (str) – the ID of the schema

• backend (Gio.SettingsBackend) – the settings backend to use

• path (str) – the path to use

Returns:

a new [class`Gio`.Settings] object

Return type:

Gio.Settings

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

This is a mix of [ctor`Gio`.Settings.new_with_backend] and [ctor`Gio`.Settings.new_with_path].

New in version 2.26.

classmethod new_with_path(schema_id, path)

Parameters:

• schema_id (str) – the ID of the schema

• path (str) – the path to use

Returns:

a new [class`Gio`.Settings] object

Return type:

Gio.Settings

Creates a new [class`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()

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

Writes made to a [class`Gio`.Settings] are handled asynchronously. For this reason, it is very unlikely that the changes have it to disk by the time [method`Gio`.Settings.set] returns.

This call will block until all of the writes have made it to the backend. Since the main loop 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)

Parameters:

• object (GObject.Object) – the object with property to unbind

• 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()

Applies any changes that have been made to the settings.

This function does nothing unless self is in ‘delay-apply’ mode. In the normal case settings are always applied immediately.

bind(key, object, property, flags)

Parameters:

• key (str) – the key to bind

• object (GObject.Object) – the object with property to bind

• 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 [method`Gio`.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 [flags`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 [method`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_with_mapping(key, object, property, flags, get_mapping, set_mapping)

Parameters:

• key (str) – the key to bind

• object (GObject.Object) – the object with property to bind

• property (str) – the name of the property to bind

• flags (Gio.SettingsBindFlags) – flags for the binding

• get_mapping (GObject.Closure or None) – a function that gets called to convert values from self to object, or NULL to use the default GIO mapping

• set_mapping (GObject.Closure or None) – a function that gets called to convert values from object to self, or NULL to use the default GIO mapping

Version of [method`Gio`.Settings.bind_with_mapping] using closures instead of callbacks for easier binding in other languages.

New in version 2.82.

bind_writable(key, object, property, inverted)

Parameters:

• key (str) – the key to bind

• object (GObject.Object) – the object with property to bind

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

Parameters:

key (str) – the name of a key in self

Returns:

a new [iface`Gio`.Action]

Return type:

Gio.Action

Creates a [iface`Gio`.Action] corresponding to a given [class`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()

Changes the [class`Gio`.Settings] object into ‘delay-apply’ mode.

In this mode, changes to self are not immediately propagated to the backend, but kept locally until [method`Gio`.Settings.apply] is called.

New in version 2.26.

get_boolean(key)

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 [method`Gio`.Settings.get] for booleans.

It is a programmer error to give a key that isn’t specified as having a b type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.26.

get_child(name)

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 and name is as specified by the caller.

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 [property`Gio`.Settings:delay-apply] mode from self.

New in version 2.26.

get_default_value(key)

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 [method`Gio`.Settings.reset] were to be called on the key.

Note that this may be a different value than returned by [method`Gio`.SettingsSchemaKey.get_default_value] if the system administrator has provided a default value.

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

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 [method`Gio`.Settings.get] for doubles.

It is a programmer error to give a key that isn’t specified as having a d type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.26.

get_enum(key)

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)

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

Returns:

true if self has unapplied changes, false otherwise

Return type:

bool

Returns whether the [class`Gio`.Settings] object has any unapplied changes.

This can only be the case if it is in ‘delay-apply’ mode.

New in version 2.26.

get_int(key)

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 [method`Gio`.Settings.get] for 32-bit integers.

It is a programmer error to give a key that isn’t specified as having an i type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.26.

get_int64(key)

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 [method`Gio`.Settings.get] for 64-bit integers.

It is a programmer error to give a key that isn’t specified as having an x type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.50.

get_mapped(key, mapping, *user_data)

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 NULL

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 NULL 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 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 just as any other value would be.

get_range(key)

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 [method`Gio`.SettingsSchemaKey.get_range] instead.

get_string(key)

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 [method`Gio`.Settings.get] for strings.

It is a programmer error to give a key that isn’t specified as having an s type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.26.

get_strv(key)

Parameters:

key (str) – the key to get the value for

Returns:

a newly-allocated, NULL-terminated array of strings, the value that is stored at key in self.

Return type:

[str]

A convenience variant of [method`Gio`.Settings.get] for string arrays.

It is a programmer error to give a key that isn’t specified as having an as type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.26.

get_uint(key)

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 [method`Gio`.Settings.get] for 32-bit unsigned integers.

It is a programmer error to give a key that isn’t specified as having a u type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.30.

get_uint64(key)

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 [method`Gio`.Settings.get] for 64-bit unsigned integers.

It is a programmer error to give a key that isn’t specified as having a t type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.50.

get_user_value(key)

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 [method`Gio`.Settings.reset] this function should always return NULL (assuming something is not wrong with the system configuration).

It is possible that [method`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)

Parameters:

key (str) – the key to get the value for

Returns:

a new [struct`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)

Parameters:

name (str) – the name of a key

Returns:

true if the key name is writable, false otherwise

Return type:

bool

Finds out if a key can be written.

New in version 2.26.

keys()

The type of the None singleton.

list_children()

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 [method`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 [func`GLib`.strfreev] when you are done with it.

list_keys()

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 [func`GLib`.strfreev] when you are done with it.

Deprecated since version 2.46: Use [method`Gio`.SettingsSchema.list_keys] instead.

range_check(key, value)

Parameters:

• key (str) – the key to check

• value (GLib.Variant) – the value to check

Returns:

true if value is valid for key, false otherwise

Return type:

bool

Checks if the given value is of the correct type and within the permitted range for key.

New in version 2.28.

Deprecated since version 2.40: Use [method`Gio`.SettingsSchemaKey.range_check] instead.

reset(key)

Parameters:

key (str) – the name of a key

Resets key to its default value.

This call resets the key, as much as possible, to its default value. That might be the value specified in the schema or the one set by the administrator.

revert()

Reverts all unapplied changes to the settings.

This function does nothing unless self is in ‘delay-apply’ mode. In the normal case settings are always applied immediately.

Change notifications will be emitted for affected keys.

set_boolean(key, value)

Parameters:

• key (str) – the key to set the value for

• value (bool) – the value to set it to

Returns:

true if setting the key succeeded, false if the key was not writable

Return type:

bool

Sets key in self to value.

A convenience variant of [method`Gio`.Settings.set] for booleans.

It is a programmer error to give a key that isn’t specified as having a b type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.26.

set_double(key, value)

Parameters:

• key (str) – the key to set the value for

• value (float) – the value to set it to

Returns:

true if setting the key succeeded, false if the key was not writable

Return type:

bool

Sets key in self to value.

A convenience variant of [method`Gio`.Settings.set] for doubles.

It is a programmer error to give a key that isn’t specified as having a d type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.26.

set_enum(key, value)

Parameters:

• key (str) – the key to set the value for

• value (int) – an enumerated value

Returns:

true if the set succeeds, false otherwise

Return type:

bool

Looks up the enumerated type nick for value and writes it to key, within self.

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, or for value not to be a valid value for the named type.

After performing the write, accessing key directly with [method`Gio`.Settings.get_string] will return the ‘nick’ associated with value.

set_flags(key, value)

Parameters:

• key (str) – the key to set the value for

• value (int) – a flags value

Returns:

true if the set succeeds, false otherwise

Return type:

bool

Looks up the flags type nicks for the bits specified by value, puts them in an array of strings and writes the array to key, within self.

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, or for value to contain any bits that are not value for the named type.

After performing the write, accessing key directly with [method`Gio`.Settings.get_strv] will return an array of ‘nicks’; one for each bit in value.

set_int(key, value)

Parameters:

• key (str) – the key to set the value for

• value (int) – the value to set it to

Returns:

true if setting the key succeeded, false if the key was not writable

Return type:

bool

Sets key in self to value.

A convenience variant of [method`Gio`.Settings.set] for 32-bit integers.

It is a programmer error to give a key that isn’t specified as having an i type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.26.

set_int64(key, value)

Parameters:

• key (str) – the key to set the value for

• value (int) – the value to set it to

Returns:

true if setting the key succeeded, false if the key was not writable

Return type:

bool

Sets key in self to value.

A convenience variant of [method`Gio`.Settings.set] for 64-bit integers.

It is a programmer error to give a key that isn’t specified as having an x type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.50.

set_string(key, value)

Parameters:

• key (str) – the key to set the value for

• value (str) – the value to set it to

Returns:

true if setting the key succeeded, false if the key was not writable

Return type:

bool

Sets key in self to value.

A convenience variant of [method`Gio`.Settings.set] for strings.

It is a programmer error to give a key that isn’t specified as having an s type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.26.

set_strv(key, value)

Parameters:

• key (str) – the key to set the value for

• value ([str] or None) – the value to set it to

Returns:

true if setting the key succeeded, false if the key was not writable

Return type:

bool

Sets key in self to value.

A convenience variant of [method`Gio`.Settings.set] for string arrays. If value is NULL, then key is set to be the empty array.

It is a programmer error to give a key that isn’t specified as having an as type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.26.

set_uint(key, value)

Parameters:

• key (str) – the key to set the value for

• value (int) – the value to set it to

Returns:

true if setting the key succeeded, false if the key was not writable

Return type:

bool

Sets key in self to value.

A convenience variant of [method`Gio`.Settings.set] for 32-bit unsigned integers.

It is a programmer error to give a key that isn’t specified as having a u type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.30.

set_uint64(key, value)

Parameters:

• key (str) – the key to set the value for

• value (int) – the value to set it to

Returns:

true if setting the key succeeded, false if the key was not writable

Return type:

bool

Sets key in self to value.

A convenience variant of [method`Gio`.Settings.set] for 64-bit unsigned integers.

It is a programmer error to give a key that isn’t specified as having a t type in the schema for self (see [struct`GLib`.VariantType]).

New in version 2.50.

set_value(key, value)

Parameters:

• key (str) – the key to set the value for

• value (GLib.Variant) – a [struct`GLib`.Variant] of the correct type

Returns:

true if setting the key succeeded, false if the key was not writable

Return type:

bool

Sets key in self to value.

It is a programmer error to give a key that isn’t contained in the schema for self or for value to have the incorrect type, per the schema.

If value is floating then this function consumes the reference.

New in version 2.26.

do_change_event(keys, n_keys) virtual

Parameters:

• keys (int) –

• n_keys (int) –

Return type:

bool

do_changed(key) virtual

Parameters:

key (str) –

do_writable_change_event(key) virtual

Parameters:

key (int) –

Return type:

bool

do_writable_changed(key) virtual

Parameters:

key (str) –

Signal Details

Gio.Settings.signals.change_event(settings, keys)

Signal Name:

change-event

Flags:

RUN_LAST

Parameters:

• settings (Gio.Settings) – The object which received the signal

• keys ([int] or None) – array of the keys which have changed

Returns:

true to stop other handlers from being invoked for the event, false to propagate the event further

Return type:

bool

Emitted once per change event that affects this settings object.

You should connect to this signal only if you are interested in viewing groups of changes before they 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.

In the event that the change event applies to one or more specified 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 whole (ie: potentially every key has been changed) then keys will be NULL and n_keys will be 0.

The default handler for this signal invokes the [signal`Gio`.Settings::changed] signal for each affected key. If any other connected handler returns true then this default functionality will be suppressed.

Gio.Settings.signals.changed(settings, key)

Signal Name:

changed

Flags:

RUN_LAST, DETAILED

Parameters:

• settings (Gio.Settings) – The object which received the signal

• key (str) – the name of the key that changed

Emitted when a key has potentially changed.

You should call one of the [method`Gio`.Settings.get] calls to check the new value.

This signal supports detailed connections. You can connect to the detailed signal changed::x in order to only receive callbacks when key x changes.

Note that settings only emits this signal if you have read key at least once while a signal handler was already connected for key.

Gio.Settings.signals.writable_change_event(settings, key)

Signal Name:

writable-change-event

Flags:

RUN_LAST

Parameters:

• settings (Gio.Settings) – The object which received the signal

• key (int) – the quark of the key, or 0

Returns:

true to stop other handlers from being invoked for the event, false to propagate the event further

Return type:

bool

Emitted once per writability change event that affects this settings object.

You should connect to this signal if you are interested in viewing groups of changes before they are split out into multiple emissions of the [signal`Gio`.Settings::writable-changed] signal. For most use cases it is more appropriate to use the [signal`Gio`.Settings::writable-changed] signal.

In the event that the writability change applies only to a single key, key will be set to the [alias`GLib`.Quark] for that key. In the event that the writability change affects the entire settings object, key will be 0.

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 changes in writability might also imply changes in value (if for example, a new mandatory setting is introduced). If any other connected handler returns true then this default functionality will be suppressed.

Gio.Settings.signals.writable_changed(settings, key)

Signal Name:

writable-changed

Flags:

RUN_LAST, DETAILED

Parameters:

• settings (Gio.Settings) – The object which received the signal

• key (str) – the key

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.

This signal supports detailed connections. You can connect to the detailed signal writable-changed::x in order to only receive callbacks when the writability of x changes.

Property Details

Gio.Settings.props.backend

Name:

backend

Type:

Gio.SettingsBackend

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The name of the context that the settings are stored in.

Gio.Settings.props.delay_apply

Name:

delay-apply

Type:

bool

Default Value:

False

Flags:

READABLE

Whether the [class`Gio`.Settings] object is in ‘delay-apply’ mode.

New in version 2.28.

Gio.Settings.props.has_unapplied

Name:

has-unapplied

Type:

bool

Default Value:

False

Flags:

READABLE

Whether the [class`Gio`.Settings] object has outstanding changes.

These changes will be applied when [method`Gio`.Settings.apply] is called.

Gio.Settings.props.path

Name:

path

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The path within the backend where the settings are stored.

Gio.Settings.props.schema

Name:

schema

Type:

str

Default Value:

None

Flags:

DEPRECATED, READABLE, WRITABLE, CONSTRUCT_ONLY

The name of the schema that describes the types of keys for this [class`Gio`.Settings] object.

The type of this property is *not* [struct`Gio`.SettingsSchema]. [struct`Gio`.SettingsSchema] has only existed since version 2.32 and unfortunately this name was used in previous versions to refer to the schema ID rather than the schema itself. Take care to use the [property`Gio`.Settings:settings-schema] property if you wish to pass in a [struct`Gio`.SettingsSchema].

Deprecated since version 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].

Gio.Settings.props.schema_id

Name:

schema-id

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The name of the schema that describes the types of keys for this [class`Gio`.Settings] object.

Gio.Settings.props.settings_schema

Name:

settings-schema

Type:

Gio.SettingsSchema

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The [struct`Gio`.SettingsSchema] describing the types of keys for this [class`Gio`.Settings] object.

Ideally, this property would be called [property`Gio`.Settings:schema]. [struct`Gio`.SettingsSchema] has only existed since version 2.32, however, and before then the [property`Gio`.Settings:schema] property was used to refer to the ID of the schema rather than the schema itself. Take care.