Memory-managed wrapper type.

Type class for types which can be safely cast to Settings, for instance with toSettings.

Cast to Settings, for types for which this is known to be safe. For general casts, use castTo.

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

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 SettingsBindFlagsNoSensitivity, 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 settingsBindWritable 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.

Since: 2.26

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.

Since: 2.26

Creates a Action corresponding to a given 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).

Since: 2.32

Changes the Settings object into 'delay-apply' mode. In this mode, changes to settings are not immediately propagated to the backend, but kept locally until settingsApply is called.

Since: 2.26

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.

Since: 2.26

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.

Since: 2.26

Gets the "default value" of a key.

This is the value that would be read if settingsReset were to be called on the key.

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

Comparing the return values of settingsGetDefaultValue and settingsGetValue 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.

Since: 2.40

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.

Since: 2.26

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.

Since: 2.26

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.

Since: 2.26

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

Since: 2.26

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.

Since: 2.26

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.

Since: 2.50

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

Queries the range of a key.

Since: 2.28

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.

Since: 2.26

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.

Since: 2.26

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.

Since: 2.30

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.

Since: 2.50

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

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

Since: 2.40

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.

Since: 2.26

Finds out if a key can be written or not

Since: 2.26

Gets the list of children on settings.

The list is exactly the list of strings for which it is not an error to call settingsGetChild.

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 strfreev when you are done with it.

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 strfreev when you are done with it.

Deprecated.

Since: 2.28

Deprecated.

Since: 2.26

Creates a new Settings object with the schema specified by schemaId.

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), settingsSchemaSourceLookup can be used to test for their existence before loading them.

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

Since: 2.26

Creates a new 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 Settings object is a pure composition of 4 things: a SettingsSchema, a SettingsBackend, a path within that backend, and a MainContext to which signals are dispatched.

This constructor therefore gives you full control over constructing 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 settingsNew).

If backend is Nothing then the default backend is used.

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

Since: 2.32

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

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

Since: 2.26

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

This is a mix of settingsNewWithBackend and settingsNewWithPath.

Since: 2.26

Creates a new Settings object with the relocatable schema specified by schemaId 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.

Since: 2.26

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

Since: 2.28

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.

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

Change notifications will be emitted for affected keys.

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.

Since: 2.26

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.

Since: 2.26

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 settingsGetString will return the 'nick' associated with value.

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 settingsGetStrv will return an array of 'nicks'; one for each bit in value.

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.

Since: 2.26

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.

Since: 2.50

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.

Since: 2.26

Sets key in settings to value.

A convenience variant of g_settings_set() for string arrays. If value is Nothing, 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.

Since: 2.26

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.

Since: 2.30

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.

Since: 2.50

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.

Since: 2.26

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

Writes made to a 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).

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.

Since: 2.26

Construct a GValueConstruct with valid value for the “backend” property. This is rarely needed directly, but it is used by new.

Get the value of the “backend” property. When overloading is enabled, this is equivalent to

get settings #backend

Get the value of the “delay-apply” property. When overloading is enabled, this is equivalent to

get settings #delayApply

Get the value of the “has-unapplied” property. When overloading is enabled, this is equivalent to

get settings #hasUnapplied

Construct a GValueConstruct with valid value for the “path” property. This is rarely needed directly, but it is used by new.

Get the value of the “path” property. When overloading is enabled, this is equivalent to

get settings #path

Construct a GValueConstruct with valid value for the “schema” property. This is rarely needed directly, but it is used by new.

Get the value of the “schema” property. When overloading is enabled, this is equivalent to

get settings #schema

Construct a GValueConstruct with valid value for the “schema-id” property. This is rarely needed directly, but it is used by new.

Get the value of the “schema-id” property. When overloading is enabled, this is equivalent to

get settings #schemaId

Construct a GValueConstruct with valid value for the “settings-schema” property. This is rarely needed directly, but it is used by new.

Get the value of the “settings-schema” property. When overloading is enabled, this is equivalent to

get settings #settingsSchema

The "change-event" signal is 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 "changed" signal. For most use cases it is more appropriate to use the "changed" signal.

In the event that the change event applies to one or more specified keys, keys will be an array of GQuark of length nKeys. In the event that the change event applies to the Settings object as a whole (ie: potentially every key has been changed) then keys will be Nothing and nKeys will be 0.

The default handler for this signal invokes the "changed" signal for each affected key. If any other connected handler returns True then this default functionality will be suppressed.

Connect a signal handler for the changeEvent signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after settings #changeEvent callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the changeEvent signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on settings #changeEvent callback

The "changed" signal is emitted when a key has potentially changed. You should call one of the g_settings_get() calls to check the new value.

This signal supports detailed connections. You can connect to the detailed signal "changed[x](#g:signal: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.

Connect a signal handler for the changed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after settings #changed callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “changed::detail” instead.

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the changed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on settings #changed callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “changed::detail” instead.

The "writable-change-event" signal is 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 "writable-changed" signal. For most use cases it is more appropriate to use the "writable-changed" signal.

In the event that the writability change applies only to a single key, key will be set to the GQuark 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 "writable-changed" and "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.

Connect a signal handler for the writableChangeEvent signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after settings #writableChangeEvent callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the writableChangeEvent signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on settings #writableChangeEvent callback

The "writable-changed" signal is emitted when the writability of a key has potentially changed. You should call settingsIsWritable in order to determine the new status.

This signal supports detailed connections. You can connect to the detailed signal "writable-changed[x](#g:signal:x)" in order to only receive callbacks when the writability of "x" changes.

Connect a signal handler for the writableChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after settings #writableChanged callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “writable-changed::detail” instead.

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the writableChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on settings #writableChanged callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “writable-changed::detail” instead.