Class: Gio::Settings

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Instance Method Summary collapse

Instance Method Details

#applynil

Applies any changes that have been made to the settings. This function does nothing unless settings is in ‘delay-apply’ mode; see g_settings_delay(). In the normal case settings are always applied immediately.

Returns:

  • (nil)

#backendGio::SettingsBackend

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

Returns:

#backend=(backend) ⇒ Gio::SettingsBackend

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

Parameters:

Returns:

#bind(key, object, property, flags) ⇒ nil

Create a binding between the key in the settings 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 %G_SETTINGS_BIND_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 g_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.

Parameters:

  • key (String)

    the key to bind

  • object (GObject::Object)

    a #GObject

  • property (String)

    the name of the property to bind

  • flags (Gio::SettingsBindFlags)

    flags for the binding

Returns:

  • (nil)

#bind_with_mapping(key, object, property, flags, get_mapping, set_mapping, user_data, destroy) ⇒ nil

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.

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.

Parameters:

  • key (String)

    the key to bind

  • object (GObject::Object)

    a #GObject

  • property (String)

    the name of the property to bind

  • flags (Gio::SettingsBindFlags)

    flags for the binding

  • get_mapping (Gio::SettingsBindGetMapping)

    a function that gets called to convert values from settings to object, or nil to use the default GIO mapping

  • set_mapping (Gio::SettingsBindSetMapping)

    a function that gets called to convert values from object to settings, or nil to use the default GIO mapping

  • user_data (GObject)

    data that gets passed to get_mapping and set_mapping

  • destroy (GLib::DestroyNotify)

    GDestroy::Notify function for user_data

Returns:

  • (nil)

#bind_writable(key, object, property, inverted) ⇒ nil

Create a binding between the writability of key in the settings 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.

Parameters:

  • key (String)

    the key to bind

  • object (GObject::Object)

    a #GObject

  • property (String)

    the name of a boolean property to bind

  • inverted (TrueClass)

    whether to ‘invert’ the value

Returns:

  • (nil)

#create_action(key) ⇒ Gio::Action

Creates a #GAction corresponding to a given #GSettings 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).

Parameters:

  • key (String)

    the name of a key in settings

Returns:

#delaynil

Changes the #GSettings object into ‘delay-apply’ mode. In this mode, changes to settings are not immediately propagated to the backend, but kept locally until g_settings_apply() is called.

Returns:

  • (nil)

#delay_apply=(delay_apply) ⇒ TrueClass

Whether the #GSettings object is in ‘delay-apply’ mode. See g_settings_delay() for details.

Parameters:

  • delay_apply (TrueClass)

Returns:

  • (TrueClass)

    delay-apply

  • (TrueClass)

    delay-apply

#delay_apply?TrueClass

Whether the #GSettings object is in ‘delay-apply’ mode. See g_settings_delay() for details.

Returns:

  • (TrueClass)

    delay-apply

#get(key, format, array) ⇒ nil

Gets the value that is stored at key in settings.

A convenience function that combines g_settings_get_value() with g_variant_get().

It is a programmer error to give a key that isn’t contained in the schema for settings or for the GVariant::Type of format to mismatch the type given in the schema.

Parameters:

  • key (String)

    the key to get the value for

  • format (String)

    a #GVariant format string

  • array (Array)

    arguments as per format

Returns:

  • (nil)

#get_boolean(key) ⇒ TrueClass

Gets the value that is stored at key in settings.

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

Parameters:

  • key (String)

    the key to get the value for

Returns:

  • (TrueClass)

    a boolean

#get_child(name) ⇒ Gio::Settings

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

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

Parameters:

  • name (String)

    the name of the child schema

Returns:

#get_default_value(key) ⇒ GLib::Variant

Gets the “default value” of a key.

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

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

Comparing the return values of g_settings_get_default_value() and g_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 settings.

Parameters:

  • key (String)

    the key to get the default value for

Returns:

  • (GLib::Variant)

    the default value

#get_double(key) ⇒ Float

Gets the value that is stored at key in settings.

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

Parameters:

  • key (String)

    the key to get the value for

Returns:

  • (Float)

    a double

#get_enum(key) ⇒ Integer

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.

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

Parameters:

  • key (String)

    the key to get the value for

Returns:

  • (Integer)

    the enum value

#get_flags(key) ⇒ Integer

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

Parameters:

  • key (String)

    the key to get the value for

Returns:

  • (Integer)

    the flags value

#get_int(key) ⇒ Integer

Gets the value that is stored at key in settings.

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

Parameters:

  • key (String)

    the key to get the value for

Returns:

  • (Integer)

    an integer

#get_int64(key) ⇒ Integer

Gets the value that is stored at key in settings.

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

Parameters:

  • key (String)

    the key to get the value for

Returns:

  • (Integer)

    a 64-bit integer

#get_mapped(key, mapping, user_data) ⇒ GObject

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.

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 nil 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 nil. The same pointer is given to each invocation of mapping. The final value of that #gpointer is what is returned by this function. nil is valid; it is returned just as any other value would be.

Parameters:

  • key (String)

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

    user data for mapping

Returns:

  • (GObject)

    the result, which may be nil

#get_range(key) ⇒ GLib::Variant

Queries the range of a key.

Parameters:

  • key (String)

    the key to query the range of

Returns:

  • (GLib::Variant)

#get_string(key) ⇒ String

Gets the value that is stored at key in settings.

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

Parameters:

  • key (String)

    the key to get the value for

Returns:

  • (String)

    a newly-allocated string

#get_strv(key) ⇒ Array<String>

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 settings. newly-allocated, nil-terminated array of strings, the value that is stored at key in settings.

Parameters:

  • key (String)

    the key to get the value for

Returns:

  • (Array<String>)

    a

#get_uint(key) ⇒ Integer

Gets the value that is stored at key in settings.

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

Parameters:

  • key (String)

    the key to get the value for

Returns:

  • (Integer)

    an unsigned integer

#get_uint64(key) ⇒ Integer

Gets the value that is stored at key in settings.

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

Parameters:

  • key (String)

    the key to get the value for

Returns:

  • (Integer)

    a 64-bit unsigned integer

#get_user_value(key) ⇒ GLib::Variant

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 g_settings_reset() this function should always return nil (assuming something is not wrong with the system configuration).

It is possible that g_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 settings.

Parameters:

  • key (String)

    the key to get the user value for

Returns:

  • (GLib::Variant)

    the user’s value, if set

#get_value(key) ⇒ GLib::Variant

Gets the value that is stored in settings for key.

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

Parameters:

  • key (String)

    the key to get the value for

Returns:

  • (GLib::Variant)

    a new #GVariant

#has_unappliedTrueClass

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

Returns:

  • (TrueClass)

    true if settings has unapplied changes

#has_unapplied=(has_unapplied) ⇒ TrueClass

If this property is true, the #GSettings object has outstanding changes that will be applied when g_settings_apply() is called.

Parameters:

  • has_unapplied (TrueClass)

Returns:

  • (TrueClass)

    has-unapplied

  • (TrueClass)

    has-unapplied

#has_unapplied?TrueClass

If this property is true, the #GSettings object has outstanding changes that will be applied when g_settings_apply() is called.

Returns:

  • (TrueClass)

    has-unapplied

#is_writable(name) ⇒ TrueClass

Finds out if a key can be written or not

Parameters:

  • name (String)

    the name of a key

Returns:

  • (TrueClass)

    true if the key name is writable

#list_childrenArray<String>

Gets the list of children on settings.

The list is exactly the list of strings for which it is not an error to call g_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 g_strfreev() when you are done with it.

Returns:

  • (Array<String>)

    a list of the children on settings, in no defined order

#list_keysArray<String>

Introspects the list of keys on settings.

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 g_strfreev() when you are done with it.

Returns:

  • (Array<String>)

    a list of the keys on settings, in no defined order

#new(schema_id) ⇒ Gio::Settings

Creates a new #GSettings object with the schema specified by schema_id.

Signals on the newly created #GSettings object will be dispatched via the thread-default GMain::Context in effect at the time of the call to g_settings_new(). The new #GSettings will hold a reference on the context. See g_main_context_push_thread_default().

Parameters:

  • schema_id (String)

    the id of the schema

Returns:

#new_full(schema, backend, path) ⇒ Gio::Settings

Creates a new #GSettings 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 #GSettings object is a pure composition of 4 things: a GSettings::Schema, a #GSettingsBackend, a path within that backend, and a GMain::Context to which signals are dispatched.

This constructor therefore gives you full control over constructing #GSettings 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 g_settings_new()).

If backend is nil then the default backend is used.

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

Parameters:

  • schema (Gio::SettingsSchema)

    a GSettings::Schema

  • backend (Gio::SettingsBackend)

    a GSettings::Backend

  • path (String)

    the path to use

Returns:

#new_with_backend(schema_id, backend) ⇒ Gio::Settings

Creates a new #GSettings object with the schema specified by schema_id and a given GSettings::Backend.

Creating a #GSettings 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.

Parameters:

  • schema_id (String)

    the id of the schema

  • backend (Gio::SettingsBackend)

    the GSettings::Backend to use

Returns:

#new_with_backend_and_path(schema_id, backend, path) ⇒ Gio::Settings

Creates a new #GSettings object with the schema specified by schema_id and a given GSettings::Backend and path.

This is a mix of g_settings_new_with_backend() and g_settings_new_with_path().

Parameters:

  • schema_id (String)

    the id of the schema

  • backend (Gio::SettingsBackend)

    the GSettings::Backend to use

  • path (String)

    the path to use

Returns:

#new_with_path(schema_id, path) ⇒ Gio::Settings

Creates a new #GSettings 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.

Parameters:

  • schema_id (String)

    the id of the schema

  • path (String)

    the path to use

Returns:

#pathString

The path within the backend where the settings are stored.

Returns:

  • (String)

    path

#path=(path) ⇒ String

The path within the backend where the settings are stored.

Parameters:

  • path (String)

Returns:

  • (String)

    path

  • (String)

    path

#range_check(key, value) ⇒ TrueClass

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

Parameters:

  • key (String)

    the key to check

  • value (GLib::Variant)

    the value to check

Returns:

  • (TrueClass)

    true if value is valid for key

#reset(key) ⇒ nil

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.

Parameters:

  • key (String)

    the name of a key

Returns:

  • (nil)

#revertnil

Reverts all non-applied changes to the settings. This function does nothing unless settings is in ‘delay-apply’ mode; see g_settings_delay(). In the normal case settings are always applied immediately.

Change notifications will be emitted for affected keys.

Returns:

  • (nil)

#schemaString

The name of the schema that describes the types of keys for this #GSettings object.

The type of this property is not GSettings::Schema. GSettings::Schema 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 ‘settings-schema’ property if you wish to pass in a GSettings::Schema.

Returns:

  • (String)

    schema

#schema=(schema) ⇒ String

The name of the schema that describes the types of keys for this #GSettings object.

The type of this property is not GSettings::Schema. GSettings::Schema 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 ‘settings-schema’ property if you wish to pass in a GSettings::Schema.

Parameters:

  • schema (String)

Returns:

  • (String)

    schema

  • (String)

    schema

#schema_idString

The name of the schema that describes the types of keys for this #GSettings object.

Returns:

  • (String)

    schema-id

#schema_id=(schema_id) ⇒ String

The name of the schema that describes the types of keys for this #GSettings object.

Parameters:

  • schema_id (String)

Returns:

  • (String)

    schema-id

  • (String)

    schema-id

#set(key, format, array) ⇒ TrueClass

Sets key in settings to value.

A convenience function that combines g_settings_set_value() with g_variant_new().

It is a programmer error to give a key that isn’t contained in the schema for settings or for the GVariant::Type of format to mismatch the type given in the schema.

Parameters:

  • key (String)

    the name of the key to set

  • format (String)

    a #GVariant format string

  • array (Array)

    arguments as per format

Returns:

  • (TrueClass)

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

#set_boolean(key, value) ⇒ TrueClass

Sets key in settings to value.

A convenience variant of g_settings_set() for booleans.

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

Parameters:

  • key (String)

    the name of the key to set

  • value (TrueClass)

    the value to set it to

Returns:

  • (TrueClass)

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

#set_double(key, value) ⇒ TrueClass

Sets key in settings to value.

A convenience variant of g_settings_set() for doubles.

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

Parameters:

  • key (String)

    the name of the key to set

  • value (Float)

    the value to set it to

Returns:

  • (TrueClass)

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

#set_enum(key, value) ⇒ TrueClass

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

It is a programmer error to give a key that isn’t contained in the schema for settings 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 g_settings_get_string() will return the ‘nick’ associated with value.

Parameters:

  • key (String)

    a key, within settings

  • value (Integer)

    an enumerated value

Returns:

  • (TrueClass)

    true, if the set succeeds

#set_flags(key, value) ⇒ TrueClass

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

It is a programmer error to give a key that isn’t contained in the 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 g_settings_get_strv() will return an array of ‘nicks’; one for each bit in value.

Parameters:

  • key (String)

    a key, within settings

  • value (Integer)

    a flags value

Returns:

  • (TrueClass)

    true, if the set succeeds

#set_int(key, value) ⇒ TrueClass

Sets key in settings to value.

A convenience variant of g_settings_set() 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 settings.

Parameters:

  • key (String)

    the name of the key to set

  • value (Integer)

    the value to set it to

Returns:

  • (TrueClass)

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

#set_int64(key, value) ⇒ TrueClass

Sets key in settings to value.

A convenience variant of g_settings_set() 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 settings.

Parameters:

  • key (String)

    the name of the key to set

  • value (Integer)

    the value to set it to

Returns:

  • (TrueClass)

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

#set_string(key, value) ⇒ TrueClass

Sets key in settings to value.

A convenience variant of g_settings_set() for strings.

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

Parameters:

  • key (String)

    the name of the key to set

  • value (String)

    the value to set it to

Returns:

  • (TrueClass)

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

#set_strv(key, value) ⇒ TrueClass

Sets key in settings to value.

A convenience variant of g_settings_set() for string arrays. If value is nil, 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 array of strings type in the schema for settings.

Parameters:

  • key (String)

    the name of the key to set

  • value (Array<String>)

    the value to set it to, or nil

Returns:

  • (TrueClass)

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

#set_uint(key, value) ⇒ TrueClass

Sets key in settings to value.

A convenience variant of g_settings_set() 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 settings.

Parameters:

  • key (String)

    the name of the key to set

  • value (Integer)

    the value to set it to

Returns:

  • (TrueClass)

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

#set_uint64(key, value) ⇒ TrueClass

Sets key in settings to value.

A convenience variant of g_settings_set() 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 settings.

Parameters:

  • key (String)

    the name of the key to set

  • value (Integer)

    the value to set it to

Returns:

  • (TrueClass)

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

#set_value(key, value) ⇒ TrueClass

Sets key in settings to value.

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

If value is floating then this function consumes the reference.

Parameters:

  • key (String)

    the name of the key to set

  • value (GLib::Variant)

    a #GVariant of the correct type

Returns:

  • (TrueClass)

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

#settings_schemaGio::SettingsSchema

The GSettings::Schema describing the types of keys for this #GSettings object.

Ideally, this property would be called ‘schema’. GSettings::Schema has only existed since version 2.32, however, and before then the ‘schema’ property was used to refer to the ID of the schema rather than the schema itself. Take care.

Returns:

  • (Gio::SettingsSchema)

    settings-schema

#settings_schema=(settings_schema) ⇒ Gio::SettingsSchema

The GSettings::Schema describing the types of keys for this #GSettings object.

Ideally, this property would be called ‘schema’. GSettings::Schema has only existed since version 2.32, however, and before then the ‘schema’ property was used to refer to the ID of the schema rather than the schema itself. Take care.

Parameters:

  • settings_schema (Gio::SettingsSchema)

Returns:

  • (Gio::SettingsSchema)

    settings-schema

  • (Gio::SettingsSchema)

    settings-schema