Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• Settings (schema_id = null, backend = null)

  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].
  • @p schema_id is the ID of the schema.
  • @p backend is the settings backend to use.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asObject ()

  Wraps this handle as Object.

  • @r A Object object.

• connectSignal (string Name, CallbackObj)

  Connects one generated callback wrapper to a named signal.

  • @p Name is the signal name.
  • @p CallbackObj is the generated callback wrapper to connect.
  • @r The connected handler id.

• disconnectSignalHandler (int HandlerId)

  Disconnects one retained signal handler id.

  • @p HandlerId is the signal handler id to disconnect.
  • @r None.

• setOnChanged (callback Fn, UserData = null)

  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.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Settings Self, string Key).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnWritablechangeevent (callback Fn, UserData = null)

  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.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Settings Self, int Key).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnWritablechanged (callback Fn, UserData = null)

  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.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Settings Self, string Key).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• apply ()

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

  • @r None.

• bind (string key, object object, string property, string flags)

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

  • @p key is the key to bind.
  • @p object is the object with property to bind.
  • @p property is the name of the property to bind.
  • @p flags is flags for the binding.
  • @r None.

• bind_with_mapping_closures (string key, object object, string property, string flags, object get_mapping, object set_mapping)

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

  • @p key is the key to bind.
  • @p object is the object with property to bind.
  • @p property is the name of the property to bind.
  • @p flags is flags for the binding.
  • @p get_mapping is a function that gets called to convert values from
  • @settings to @object, or NULL to use the default GIO mapping.
  • @p set_mapping is a function that gets called to convert values from
  • @object to @settings, or NULL to use the default GIO mapping.
  • @r None.

• bind_writable (string key, object object, string property, bool inverted)

  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.

  • @p key is the key to bind.
  • @p object is the object with property to bind.
  • @p property is the name of a boolean property to bind.
  • @p inverted is whether to ‘invert’ the value.
  • @r None.

• create_action (string key)

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

  • @p key is the name of a key in @settings.

• delay ()

  Changes the [class@Gio.Settings] object into ‘delay-apply’ mode. In this mode, changes to

  • @settings are not immediately propagated to the backend, but kept locally until [method@Gio.Settings.apply] is called.
  • @r None.

• get_boolean (string key)

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

  • @settings (see [struct@GLib.VariantType]).
  • @p key is the key to get the value for.

• get_child (string name)

  Creates a child settings object which has a base path of base-path/name, where base-path is the base path of @settings and name is as specified by the caller. The schema for the child settings object must have been declared in the schema of @settings using a <child> element. The created child settings object will inherit the [property@Gio.Settings:delay-apply] mode from @settings.

  • @p name is the name of the child schema.

• get_default_value (string key)

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

  • @p key is the key to get the default value for.

• get_double (string key)

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

  • @settings (see [struct@GLib.VariantType]).
  • @p key is the key to get the value for.

• get_enum (string key)

  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.

  • @p key is the key to get the value for.

• get_flags (string key)

  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.

  • @p key is the key to get the value for.

• get_has_unapplied ()

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

• get_int (string key)

  Gets the value that is stored at @key in @settings. 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 @settings (see [struct@GLib.VariantType]).

  • @p key is the key to get the value for.

• get_range (string key)

  Queries the range of a key.

  • @p key is the key to query the range of.

• get_string (string key)

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

  • @settings (see [struct@GLib.VariantType]).
  • @p key is the key to get the value for.

• get_strv (string key)

  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 @settings (see [struct@GLib.VariantType]).

  • @p key is the key to get the value for.

• get_uint (string key)

  Gets the value that is stored at @key in @settings. 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 @settings (see [struct@GLib.VariantType]).

  • @p key is the key to get the value for.

• get_user_value (string key)

  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

  • @settings. ``
  • @p key is the key to get the user value for.

• get_value (string key)

  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.

  • @p key is the key to get the value for.

• is_writable (string name)

  Finds out if a key can be written.

  • @p name is the name of a key.

• list_children ()

  Gets the list of children on @settings. 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 ()

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

• range_check (string key, object value)

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

  • @p key is the key to check.
  • @p value is the value to check.

• reset (string 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.

  • @p key is the name of a key.
  • @r None.

• revert ()

  Reverts all unapplied changes to the settings. This function does nothing unless @settings is in ‘delay-apply’ mode. In the normal case settings are always applied immediately. Change notifications will be emitted for affected keys.

  • @r None.

• set_boolean (string key, bool value)

  Sets @key in @settings 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

  • @settings (see [struct@GLib.VariantType]).
  • @p key is the key to set the value for.
  • @p value is the value to set it to.

• set_double (string key, double value)

  Sets @key in @settings 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
  • @settings (see [struct@GLib.VariantType]).
  • @p key is the key to set the value for.
  • @p value is the value to set it to.

• set_enum (string key, int value)

  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 [method@Gio.Settings.get_string] will return the ‘nick’ associated with

  • @value. ``
  • @p key is the key to set the value for.
  • @p value is an enumerated value.

• set_flags (string key, int 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 [method@Gio.Settings.get_strv] will return an array of ‘nicks’; one for each bit in @value.

  • @p key is the key to set the value for.
  • @p value is a flags value.

• set_int (string key, int value)

  Sets @key in @settings 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 @settings (see [struct@GLib.VariantType]).

  • @p key is the key to set the value for.
  • @p value is the value to set it to.

• set_string (string key, string value)

  Sets @key in @settings 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
  • @settings (see [struct@GLib.VariantType]).
  • @p key is the key to set the value for.
  • @p value is the value to set it to.

• set_strv (string key, list value)

  Sets @key in @settings 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
  • @settings (see [struct@GLib.VariantType]).
  • @p key is the key to set the value for.
  • @p value is the value to set it to.

• set_uint (string key, int value)

  Sets @key in @settings 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 @settings (see [struct@GLib.VariantType]).

  • @p key is the key to set the value for.
  • @p value is the value to set it to.

• set_value (string key, object value)

  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.

  • @p key is the key to set the value for.
  • @p value is a [struct@GLib.Variant] of the correct type.

class: SettingsWritablechangeeventCallback

[1177:7] extends: object

Generated low-level callback wrapper for GIR callback writable-change-event.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• SettingsWritablechangeeventCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, key, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: SettingsWritablechangedCallback

[1247:7] extends: object

Generated low-level callback wrapper for GIR callback writable-changed.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• SettingsWritablechangedCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, key, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: SettingsMeta

[1317:14] static extends: object

Generated metadata helpers for Settings class surfaces.

Methods

• properties ()

  Returns property metadata for Settings.

  • @r A list.

• signals ()

  Returns signal metadata for Settings.

  • @r A list.

class: SettingsCtors

[1027:14] static extends: object

Alternate constructors for Settings. Usage: SettingsCtors.<name>(...). The primary constructor lives directly on Settings.

Methods

• newFull (object schema, object backend, string path)

  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.

  • @p schema is the schema describing the settings.
  • @p backend is the settings backend to use.
  • @p path is the path to use.
  • @r A new Settings.

• newWithBackendAndPath (string schema_id, object backend, string path)

  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].
  • @p schema_id is the ID of the schema.
  • @p backend is the settings backend to use.
  • @p path is the path to use.
  • @r A new Settings.

• newWithPath (string schema_id, string path)

  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.

  • @p schema_id is the ID of the schema.
  • @p path is the path to use.
  • @r A new Settings.