Package: gio

Function gio:settings-user-value

Lambda List

gio:settings-user-value (settings key)

Arguments

settings -- a g:settings instance
key -- a string for the name of a key in settings

Return Value

The new g:variant instance for the user value, if set.

Details

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 the g:settings-reset function this function should always return nil, assuming something is not wrong with the system configuration.

It is possible that the g:settings-value function 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 is not contained in the schema for settings.
 

See also

#2026-03-25