Package ch.bailu.gtk.gio
Class Settings
java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.gio.Settings
- All Implemented Interfaces:
PointerInterface
The #GSettings class provides a convenient API for storing and retrieving
application settings.
Reads and writes can be considered to be non-blocking. Reading
settings with #GSettings is typically extremely fast: on
approximately the same order of magnitude (but slower than) a
#GHashTable lookup. Writing settings is also extremely fast in terms
of time to return to your application, but can be extremely expensive
for other threads and other processes. Many settings backends
(including dconf) have lazy initialisation which means in the common
case of the user using their computer without modifying any settings
a lot of work can be avoided. For dconf, the D-Bus service doesn't
even need to be started in this case. For this reason, you should
only ever modify #GSettings keys in response to explicit user action.
Particular care should be paid to ensure that modifications are not
made during startup -- for example, when setting the initial value
of preferences widgets. The built-in g_settings_bind() functionality
is careful not to write settings in response to notify signals as a
result of modifications that it makes to widgets.
When creating a GSettings instance, you have to specify a schema
that describes the keys in your settings and their types and default
values, as well as some other information.
Normally, a schema has a fixed path that determines where the settings
are stored in the conceptual global tree of settings. However, schemas
can also be '[relocatable][gsettings-relocatable]', i.e. not equipped with
a fixed path. This is
useful e.g. when the schema describes an 'account', and you want to be
able to store a arbitrary number of accounts.
Paths must start with and end with a forward slash character ('/')
and must not contain two sequential slash characters. Paths should
be chosen based on a domain name associated with the program or
library to which the settings belong. Examples of paths are
"/org/gtk/settings/file-chooser/" and "/ca/desrt/dconf-editor/".
Paths should not start with "/apps/", "/desktop/" or "/system/" as
they often did in GConf.
Unlike other configuration systems (like GConf), GSettings does not
restrict keys to basic types like strings and numbers. GSettings stores
values as #GVariant, and allows any #GVariantType for keys. Key names
are restricted to lowercase characters, numbers and '-'. Furthermore,
the names must begin with a lowercase character, must not end
with a '-', and must not contain consecutive dashes.
Similar to GConf, the default values in GSettings schemas can be
localized, but the localized values are stored in gettext catalogs
and looked up with the domain that is specified in the
`gettext-domain` attribute of the <schemalist> or <schema>
elements and the category that is specified in the `l10n` attribute of
the <default> element. The string which is translated includes all text in
the <default> element, including any surrounding quotation marks.
The `l10n` attribute must be set to `messages` or `time`, and sets the
[locale category for
translation](https://www.gnu.org/software/gettext/manual/html_node/Aspects.html#index-locale-categories-1).
The `messages` category should be used by default; use `time` for
translatable date or time formats. A translation comment can be added as an
XML comment immediately above the <default> element — it is recommended to
add these comments to aid translators understand the meaning and
implications of the default value. An optional translation `context`
attribute can be set on the <default> element to disambiguate multiple
defaults which use the same string.
For example:
Translations of default values must remain syntactically valid serialized
#GVariants (e.g. retaining any surrounding quotation marks) or runtime
errors will occur.
GSettings uses schemas in a compact binary form that is created
by the [glib-compile-schemas][glib-compile-schemas]
utility. The input is a schema description in an XML format.
A DTD for the gschema XML format can be found here:
[gschema.dtd](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/gschema.dtd)
The [glib-compile-schemas][glib-compile-schemas] tool expects schema
files to have the extension `.gschema.xml`.
At runtime, schemas are identified by their id (as specified in the
id attribute of the <schema> element). The convention for schema
ids is to use a dotted name, similar in style to a D-Bus bus name,
e.g. "org.gnome.SessionManager". In particular, if the settings are
for a specific service that owns a D-Bus bus name, the D-Bus bus name
and schema id should match. For schemas which deal with settings not
associated with one named application, the id should not use
StudlyCaps, e.g. "org.gnome.font-rendering".
In addition to #GVariant types, keys can have types that have
enumerated types. These can be described by a <choice>,
<enum> or <flags> element, as seen in the
[example][schema-enumerated]. The underlying type of such a key
is string, but you can use g_settings_get_enum(), g_settings_set_enum(),
g_settings_get_flags(), g_settings_set_flags() access the numeric values
corresponding to the string value of enum and flags keys.
An example for default value:
An example for ranges, choices and enumerated types:
## Vendor overrides
Default values are defined in the schemas that get installed by
an application. Sometimes, it is necessary for a vendor or distributor
to adjust these defaults. Since patching the XML source for the schema
is inconvenient and error-prone,
[glib-compile-schemas][glib-compile-schemas] reads so-called vendor
override' files. These are keyfiles in the same directory as the XML
schema sources which can override default values. The schema id serves
as the group name in the key file, and the values are expected in
serialized GVariant form, as in the following example:
glib-compile-schemas expects schema files to have the extension
`.gschema.override`.
## Binding
A very convenient feature of GSettings lets you bind #GObject properties
directly to settings, using g_settings_bind(). Once a GObject property
has been bound to a setting, changes on either side are automatically
propagated to the other side. GSettings handles details like mapping
between GObject and GVariant types, and preventing infinite cycles.
This makes it very easy to hook up a preferences dialog to the
underlying settings. To make this even more convenient, GSettings
looks for a boolean property with the name "sensitivity" and
automatically binds it to the writability of the bound setting.
If this 'magic' gets in the way, it can be suppressed with the
%G_SETTINGS_BIND_NO_SENSITIVITY flag.
## Relocatable schemas # {#gsettings-relocatable}
A relocatable schema is one with no `path` attribute specified on its
<schema> element. By using g_settings_new_with_path(), a #GSettings object
can be instantiated for a relocatable schema, assigning a path to the
instance. Paths passed to g_settings_new_with_path() will typically be
constructed dynamically from a constant prefix plus some form of instance
identifier; but they must still be valid GSettings paths. Paths could also
be constant and used with a globally installed schema originating from a
dependency library.
For example, a relocatable schema could be used to store geometry information
for different windows in an application. If the schema ID was
`org.foo.MyApp.Window`, it could be instantiated for paths
`/org/foo/MyApp/main/`, `/org/foo/MyApp/document-1/`,
`/org/foo/MyApp/document-2/`, etc. If any of the paths are well-known
they can be specified as <child> elements in the parent schema, e.g.:
## Build system integration # {#gsettings-build-system}
GSettings comes with autotools integration to simplify compiling and
installing schemas. To add GSettings support to an application, add the
following to your `configure.ac`:
In the appropriate `Makefile.am`, use the following snippet to compile and
install the named schema:
No changes are needed to the build system to mark a schema XML file for
translation. Assuming it sets the `gettext-domain` attribute, a schema may
be marked for translation by adding it to `POTFILES.in`, assuming gettext
0.19 is in use (the preferred method for translation):
Alternatively, if intltool 0.50.1 is in use:
GSettings will use gettext to look up translations for the <summary> and
<description> elements, and also any <default> elements which have a `l10n`
attribute set. Translations must not be included in the `.gschema.xml` file
by the build system, for example by using intltool XML rules with a
`.gschema.xml.in` template.
If an enumerated type defined in a C header file is to be used in a GSettings
schema, it can either be defined manually using an <enum> element in the
schema XML, or it can be extracted automatically from the C header. This
approach is preferred, as it ensures the two representations are always
synchronised. To do so, add the following to the relevant `Makefile.am`:
`gsettings_ENUM_NAMESPACE` specifies the schema namespace for the enum files,
which are specified in `gsettings_ENUM_FILES`. This will generate a
`org.foo.MyApp.enums.xml` file containing the extracted enums, which will be
automatically included in the schema compilation, install and uninstall
rules. It should not be committed to version control or included in
`EXTRA_DIST`.
application settings.
Reads and writes can be considered to be non-blocking. Reading
settings with #GSettings is typically extremely fast: on
approximately the same order of magnitude (but slower than) a
#GHashTable lookup. Writing settings is also extremely fast in terms
of time to return to your application, but can be extremely expensive
for other threads and other processes. Many settings backends
(including dconf) have lazy initialisation which means in the common
case of the user using their computer without modifying any settings
a lot of work can be avoided. For dconf, the D-Bus service doesn't
even need to be started in this case. For this reason, you should
only ever modify #GSettings keys in response to explicit user action.
Particular care should be paid to ensure that modifications are not
made during startup -- for example, when setting the initial value
of preferences widgets. The built-in g_settings_bind() functionality
is careful not to write settings in response to notify signals as a
result of modifications that it makes to widgets.
When creating a GSettings instance, you have to specify a schema
that describes the keys in your settings and their types and default
values, as well as some other information.
Normally, a schema has a fixed path that determines where the settings
are stored in the conceptual global tree of settings. However, schemas
can also be '[relocatable][gsettings-relocatable]', i.e. not equipped with
a fixed path. This is
useful e.g. when the schema describes an 'account', and you want to be
able to store a arbitrary number of accounts.
Paths must start with and end with a forward slash character ('/')
and must not contain two sequential slash characters. Paths should
be chosen based on a domain name associated with the program or
library to which the settings belong. Examples of paths are
"/org/gtk/settings/file-chooser/" and "/ca/desrt/dconf-editor/".
Paths should not start with "/apps/", "/desktop/" or "/system/" as
they often did in GConf.
Unlike other configuration systems (like GConf), GSettings does not
restrict keys to basic types like strings and numbers. GSettings stores
values as #GVariant, and allows any #GVariantType for keys. Key names
are restricted to lowercase characters, numbers and '-'. Furthermore,
the names must begin with a lowercase character, must not end
with a '-', and must not contain consecutive dashes.
Similar to GConf, the default values in GSettings schemas can be
localized, but the localized values are stored in gettext catalogs
and looked up with the domain that is specified in the
`gettext-domain` attribute of the <schemalist> or <schema>
elements and the category that is specified in the `l10n` attribute of
the <default> element. The string which is translated includes all text in
the <default> element, including any surrounding quotation marks.
The `l10n` attribute must be set to `messages` or `time`, and sets the
[locale category for
translation](https://www.gnu.org/software/gettext/manual/html_node/Aspects.html#index-locale-categories-1).
The `messages` category should be used by default; use `time` for
translatable date or time formats. A translation comment can be added as an
XML comment immediately above the <default> element — it is recommended to
add these comments to aid translators understand the meaning and
implications of the default value. An optional translation `context`
attribute can be set on the <default> element to disambiguate multiple
defaults which use the same string.
For example:
<!-- Translators: A list of words which are not allowed to be typed, in GVariant serialization syntax. See: https://developer.gnome.org/glib/stable/gvariant-text.html --> <default l10n='messages' context='Banned words'>['bad', 'words']</default>
Translations of default values must remain syntactically valid serialized
#GVariants (e.g. retaining any surrounding quotation marks) or runtime
errors will occur.
GSettings uses schemas in a compact binary form that is created
by the [glib-compile-schemas][glib-compile-schemas]
utility. The input is a schema description in an XML format.
A DTD for the gschema XML format can be found here:
[gschema.dtd](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/gschema.dtd)
The [glib-compile-schemas][glib-compile-schemas] tool expects schema
files to have the extension `.gschema.xml`.
At runtime, schemas are identified by their id (as specified in the
id attribute of the <schema> element). The convention for schema
ids is to use a dotted name, similar in style to a D-Bus bus name,
e.g. "org.gnome.SessionManager". In particular, if the settings are
for a specific service that owns a D-Bus bus name, the D-Bus bus name
and schema id should match. For schemas which deal with settings not
associated with one named application, the id should not use
StudlyCaps, e.g. "org.gnome.font-rendering".
In addition to #GVariant types, keys can have types that have
enumerated types. These can be described by a <choice>,
<enum> or <flags> element, as seen in the
[example][schema-enumerated]. The underlying type of such a key
is string, but you can use g_settings_get_enum(), g_settings_set_enum(),
g_settings_get_flags(), g_settings_set_flags() access the numeric values
corresponding to the string value of enum and flags keys.
An example for default value:
<schemalist> <schema id="org.gtk.Test" path="/org/gtk/Test/" gettext-domain="test"> <key name="greeting" type="s"> <default l10n="messages">"Hello, earthlings"</default> <summary>A greeting</summary> <description> Greeting of the invading martians </description> </key> <key name="box" type="(ii)"> <default>(20,30)</default> </key> <key name="empty-string" type="s"> <default>""</default> <summary>Empty strings have to be provided in GVariant form</summary> </key> </schema> </schemalist>
An example for ranges, choices and enumerated types:
<schemalist> <enum id="org.gtk.Test.myenum"> <value nick="first" value="1"/> <value nick="second" value="2"/> </enum> <flags id="org.gtk.Test.myflags"> <value nick="flag1" value="1"/> <value nick="flag2" value="2"/> <value nick="flag3" value="4"/> </flags> <schema id="org.gtk.Test"> <key name="key-with-range" type="i"> <range min="1" max="100"/> <default>10</default> </key> <key name="key-with-choices" type="s"> <choices> <choice value='Elisabeth'/> <choice value='Annabeth'/> <choice value='Joe'/> </choices> <aliases> <alias value='Anna' target='Annabeth'/> <alias value='Beth' target='Elisabeth'/> </aliases> <default>'Joe'</default> </key> <key name='enumerated-key' enum='org.gtk.Test.myenum'> <default>'first'</default> </key> <key name='flags-key' flags='org.gtk.Test.myflags'> <default>["flag1","flag2"]</default> </key> </schema> </schemalist>
## Vendor overrides
Default values are defined in the schemas that get installed by
an application. Sometimes, it is necessary for a vendor or distributor
to adjust these defaults. Since patching the XML source for the schema
is inconvenient and error-prone,
[glib-compile-schemas][glib-compile-schemas] reads so-called vendor
override' files. These are keyfiles in the same directory as the XML
schema sources which can override default values. The schema id serves
as the group name in the key file, and the values are expected in
serialized GVariant form, as in the following example:
[org.gtk.Example] key1='string' key2=1.5
glib-compile-schemas expects schema files to have the extension
`.gschema.override`.
## Binding
A very convenient feature of GSettings lets you bind #GObject properties
directly to settings, using g_settings_bind(). Once a GObject property
has been bound to a setting, changes on either side are automatically
propagated to the other side. GSettings handles details like mapping
between GObject and GVariant types, and preventing infinite cycles.
This makes it very easy to hook up a preferences dialog to the
underlying settings. To make this even more convenient, GSettings
looks for a boolean property with the name "sensitivity" and
automatically binds it to the writability of the bound setting.
If this 'magic' gets in the way, it can be suppressed with the
%G_SETTINGS_BIND_NO_SENSITIVITY flag.
## Relocatable schemas # {#gsettings-relocatable}
A relocatable schema is one with no `path` attribute specified on its
<schema> element. By using g_settings_new_with_path(), a #GSettings object
can be instantiated for a relocatable schema, assigning a path to the
instance. Paths passed to g_settings_new_with_path() will typically be
constructed dynamically from a constant prefix plus some form of instance
identifier; but they must still be valid GSettings paths. Paths could also
be constant and used with a globally installed schema originating from a
dependency library.
For example, a relocatable schema could be used to store geometry information
for different windows in an application. If the schema ID was
`org.foo.MyApp.Window`, it could be instantiated for paths
`/org/foo/MyApp/main/`, `/org/foo/MyApp/document-1/`,
`/org/foo/MyApp/document-2/`, etc. If any of the paths are well-known
they can be specified as <child> elements in the parent schema, e.g.:
<schema id="org.foo.MyApp" path="/org/foo/MyApp/"> <child name="main" schema="org.foo.MyApp.Window"/> </schema>
## Build system integration # {#gsettings-build-system}
GSettings comes with autotools integration to simplify compiling and
installing schemas. To add GSettings support to an application, add the
following to your `configure.ac`:
GLIB_GSETTINGS
In the appropriate `Makefile.am`, use the following snippet to compile and
install the named schema:
gsettings_SCHEMAS = org.foo.MyApp.gschema.xml EXTRA_DIST = $(gsettings_SCHEMAS) @GSETTINGS_RULES@
No changes are needed to the build system to mark a schema XML file for
translation. Assuming it sets the `gettext-domain` attribute, a schema may
be marked for translation by adding it to `POTFILES.in`, assuming gettext
0.19 is in use (the preferred method for translation):
data/org.foo.MyApp.gschema.xml
Alternatively, if intltool 0.50.1 is in use:
[type: gettext/gsettings]data/org.foo.MyApp.gschema.xml
GSettings will use gettext to look up translations for the <summary> and
<description> elements, and also any <default> elements which have a `l10n`
attribute set. Translations must not be included in the `.gschema.xml` file
by the build system, for example by using intltool XML rules with a
`.gschema.xml.in` template.
If an enumerated type defined in a C header file is to be used in a GSettings
schema, it can either be defined manually using an <enum> element in the
schema XML, or it can be extracted automatically from the C header. This
approach is preferred, as it ensures the two representations are always
synchronised. To do so, add the following to the relevant `Makefile.am`:
gsettings_ENUM_NAMESPACE = org.foo.MyApp gsettings_ENUM_FILES = my-app-enums.h my-app-misc.h
`gsettings_ENUM_NAMESPACE` specifies the schema namespace for the enum files,
which are specified in `gsettings_ENUM_FILES`. This will generate a
`org.foo.MyApp.enums.xml` file containing the extracted enums, which will be
automatically included in the schema compilation, install and uninstall
rules. It should not be committed to version control or included in
`EXTRA_DIST`.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static interface
static interface
static interface
static interface
static interface
static interface
Nested classes/interfaces inherited from class ch.bailu.gtk.gobject.Object
Object.OnBindingTransformFunc, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
Fields inherited from class ch.bailu.gtk.gobject.Object
SIGNAL_ON_NOTIFY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
apply()
Applies any changes that have been made to the settings.void
Create a binding between the @key in the @settings object
and the property @property of @object.void
Create a binding between the @key in the @settings object
and the property @property of @object.void
bindWithMapping
(Str key, Pointer object, Str property, int flags, Settings.OnSettingsBindGetMapping get_mapping, Settings.OnSettingsBindSetMapping set_mapping, Pointer user_data, Settings.OnDestroyNotify destroy) Create a binding between the @key in the @settings object
and the property @property of @object.void
bindWithMapping
(String key, Pointer object, String property, int flags, Settings.OnSettingsBindGetMapping get_mapping, Settings.OnSettingsBindSetMapping set_mapping, Pointer user_data, Settings.OnDestroyNotify destroy) Create a binding between the @key in the @settings object
and the property @property of @object.void
bindWritable
(Str key, Pointer object, Str property, boolean inverted) Create a binding between the writability of @key in the
@settings object and the property @property of @object.void
bindWritable
(String key, Pointer object, String property, boolean inverted) Create a binding between the writability of @key in the
@settings object and the property @property of @object.createAction
(Str key) Creates a #GAction corresponding to a given #GSettings key.createAction
(String key) Creates a #GAction corresponding to a given #GSettings key.void
delay()
Changes the #GSettings object into 'delay-apply' mode.void
Gets the value that is stored at @key in @settings.void
Gets the value that is stored at @key in @settings.boolean
getBoolean
(Str key) Gets the value that is stored at @key in @settings.boolean
getBoolean
(String key) Gets the value that is stored at @key in @settings.Creates a child settings object which has a base path of
`base-path/@name`, where `base-path` is the base path of
@settings.Creates a child settings object which has a base path of
`base-path/@name`, where `base-path` is the base path of
@settings.static ClassHandler
getDefaultValue
(Str key) Gets the "default value" of a key.getDefaultValue
(String key) Gets the "default value" of a key.double
Gets the value that is stored at @key in @settings.double
Gets the value that is stored at @key in @settings.int
Gets the value that is stored in @settings for @key and converts it
to the enum value that it represents.int
Gets the value that is stored in @settings for @key and converts it
to the enum value that it represents.int
Gets the value that is stored in @settings for @key and converts it
to the flags value that it represents.int
Gets the value that is stored in @settings for @key and converts it
to the flags value that it represents.boolean
Returns whether the #GSettings object has any unapplied
changes.static int
int
Gets the value that is stored at @key in @settings.int
Gets the value that is stored at @key in @settings.long
Gets the value that is stored at @key in @settings.long
Gets the value that is stored at @key in @settings.static long
static TypeSystem.TypeSize
Gets the value that is stored at @key in @settings.Gets the value that is stored at @key in @settings.static long
static TypeSystem.TypeSize
int
Gets the value that is stored at @key in @settings.int
Gets the value that is stored at @key in @settings.long
Gets the value that is stored at @key in @settings.long
Gets the value that is stored at @key in @settings.getUserValue
(Str key) Checks the "user value" of a key, if there is one.getUserValue
(String key) Checks the "user value" of a key, if there is one.Gets the value that is stored in @settings for @key.Gets the value that is stored in @settings for @key.boolean
isWritable
(Str name) Finds out if a key can be written or notboolean
isWritable
(String name) Finds out if a key can be written or notstatic Settings
newFullSettings
(SettingsSchema schema, SettingsBackend backend, Str path) Creates a new #GSettings object with a given schema, backend and
path.static Settings
newFullSettings
(SettingsSchema schema, SettingsBackend backend, String path) Creates a new #GSettings object with a given schema, backend and
path.static Settings
newWithBackendAndPathSettings
(Str schema_id, SettingsBackend backend, Str path) Creates a new #GSettings object with the schema specified by
@schema_id and a given #GSettingsBackend and path.static Settings
newWithBackendAndPathSettings
(String schema_id, SettingsBackend backend, String path) Creates a new #GSettings object with the schema specified by
@schema_id and a given #GSettingsBackend and path.static Settings
newWithBackendSettings
(Str schema_id, SettingsBackend backend) Creates a new #GSettings object with the schema specified by
@schema_id and a given #GSettingsBackend.static Settings
newWithBackendSettings
(String schema_id, SettingsBackend backend) Creates a new #GSettings object with the schema specified by
@schema_id and a given #GSettingsBackend.static Settings
newWithPathSettings
(Str schema_id, Str path) Creates a new #GSettings object with the relocatable schema specified
by @schema_id and a given path.static Settings
newWithPathSettings
(String schema_id, String path) Creates a new #GSettings object with the relocatable schema specified
by @schema_id and a given path.onChanged
(Settings.OnChanged signal) Connect to signal "changed".onChangeEvent
(Settings.OnChangeEvent signal) Connect to signal "change-event".Connect to signal "writable-changed".Connect to signal "writable-change-event".void
Resets @key to its default value.void
Resets @key to its default value.void
revert()
Reverts all non-applied changes to the settings.boolean
Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.boolean
setBoolean
(Str key, boolean value) Sets @key in @settings to @value.boolean
setBoolean
(String key, boolean value) Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.boolean
Looks up the enumerated type nick for @value and writes it to @key,
within @settings.boolean
Looks up the enumerated type nick for @value and writes it to @key,
within @settings.boolean
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.boolean
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.boolean
Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.boolean
Sets @key in @settings to @value.static void
sync()
Ensures that all pending operations are complete for the default backend.static void
Removes an existing binding for @property on @object.Methods inherited from class ch.bailu.gtk.gobject.Object
addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref
Methods inherited from class ch.bailu.gtk.type.Pointer
asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks
Methods inherited from class ch.bailu.gtk.type.Type
asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface ch.bailu.gtk.type.PointerInterface
asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull
-
Field Details
-
SIGNAL_ON_CHANGE_EVENT
- See Also:
-
SIGNAL_ON_CHANGED
- See Also:
-
SIGNAL_ON_WRITABLE_CHANGE_EVENT
- See Also:
-
SIGNAL_ON_WRITABLE_CHANGED
- See Also:
-
-
Constructor Details
-
Settings
-
Settings
Creates a new #GSettings 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), g_settings_schema_source_lookup()
can be used to test for their existence before loading them.
Signals on the newly created #GSettings object will be dispatched
via the thread-default #GMainContext 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
- the id of the schema
-
Settings
Creates a new #GSettings 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), g_settings_schema_source_lookup()
can be used to test for their existence before loading them.
Signals on the newly created #GSettings object will be dispatched
via the thread-default #GMainContext 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
- the id of the schema
-
-
Method Details
-
getClassHandler
-
newFullSettings
public static Settings newFullSettings(@Nonnull SettingsSchema schema, @Nullable SettingsBackend backend, @Nullable Str path) 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 #GSettingsSchema, a #GSettingsBackend, a path within that
backend, and a #GMainContext 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 %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.- Parameters:
schema
- a #GSettingsSchemabackend
- a #GSettingsBackendpath
- the path to use- Returns:
- a new #GSettings object
-
newFullSettings
public static Settings newFullSettings(@Nonnull SettingsSchema schema, @Nullable SettingsBackend backend, String path) 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 #GSettingsSchema, a #GSettingsBackend, a path within that
backend, and a #GMainContext 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 %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.- Parameters:
schema
- a #GSettingsSchemabackend
- a #GSettingsBackendpath
- the path to use- Returns:
- a new #GSettings object
-
newWithBackendSettings
public static Settings newWithBackendSettings(@Nonnull Str schema_id, @Nonnull SettingsBackend backend) Creates a new #GSettings object with the schema specified by
@schema_id and a given #GSettingsBackend.
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
- the id of the schemabackend
- the #GSettingsBackend to use- Returns:
- a new #GSettings object
-
newWithBackendSettings
Creates a new #GSettings object with the schema specified by
@schema_id and a given #GSettingsBackend.
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
- the id of the schemabackend
- the #GSettingsBackend to use- Returns:
- a new #GSettings object
-
newWithBackendAndPathSettings
public static Settings newWithBackendAndPathSettings(@Nonnull Str schema_id, @Nonnull SettingsBackend backend, @Nonnull Str path) Creates a new #GSettings object with the schema specified by
@schema_id and a given #GSettingsBackend and path.
This is a mix of g_settings_new_with_backend() and
g_settings_new_with_path().- Parameters:
schema_id
- the id of the schemabackend
- the #GSettingsBackend to usepath
- the path to use- Returns:
- a new #GSettings object
-
newWithBackendAndPathSettings
public static Settings newWithBackendAndPathSettings(String schema_id, @Nonnull SettingsBackend backend, String path) Creates a new #GSettings object with the schema specified by
@schema_id and a given #GSettingsBackend and path.
This is a mix of g_settings_new_with_backend() and
g_settings_new_with_path().- Parameters:
schema_id
- the id of the schemabackend
- the #GSettingsBackend to usepath
- the path to use- Returns:
- a new #GSettings object
-
newWithPathSettings
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
- the id of the schemapath
- the path to use- Returns:
- a new #GSettings object
-
newWithPathSettings
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
- the id of the schemapath
- the path to use- Returns:
- a new #GSettings object
-
apply
public void apply()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. -
bind
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
- the key to bindobject
- a #GObjectproperty
- the name of the property to bindflags
- flags for the binding
-
bind
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
- the key to bindobject
- a #GObjectproperty
- the name of the property to bindflags
- flags for the binding
-
bindWithMapping
public void bindWithMapping(@Nonnull Str key, @Nonnull Pointer object, @Nonnull Str property, int flags, Settings.OnSettingsBindGetMapping get_mapping, Settings.OnSettingsBindSetMapping set_mapping, @Nullable Pointer user_data, Settings.OnDestroyNotify destroy) 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
- the key to bindobject
- a #GObjectproperty
- the name of the property to bindflags
- flags for the bindingget_mapping
- a function that gets called to convert values from @settings to @object, or %NULL to use the default GIO mappingset_mapping
- a function that gets called to convert values from @object to @settings, or %NULL to use the default GIO mappinguser_data
- data that gets passed to @get_mapping and @set_mappingdestroy
- #GDestroyNotify function for @user_data
-
bindWithMapping
public void bindWithMapping(String key, @Nonnull Pointer object, String property, int flags, Settings.OnSettingsBindGetMapping get_mapping, Settings.OnSettingsBindSetMapping set_mapping, @Nullable Pointer user_data, Settings.OnDestroyNotify destroy) 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
- the key to bindobject
- a #GObjectproperty
- the name of the property to bindflags
- flags for the bindingget_mapping
- a function that gets called to convert values from @settings to @object, or %NULL to use the default GIO mappingset_mapping
- a function that gets called to convert values from @object to @settings, or %NULL to use the default GIO mappinguser_data
- data that gets passed to @get_mapping and @set_mappingdestroy
- #GDestroyNotify function for @user_data
-
bindWritable
public void bindWritable(@Nonnull Str key, @Nonnull Pointer object, @Nonnull Str property, boolean 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.- Parameters:
key
- the key to bindobject
- a #GObjectproperty
- the name of a boolean property to bindinverted
- whether to 'invert' the value
-
bindWritable
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
- the key to bindobject
- a #GObjectproperty
- the name of a boolean property to bindinverted
- whether to 'invert' the value
-
createAction
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
- the name of a key in @settings- Returns:
- a new #GAction
-
createAction
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
- the name of a key in @settings- Returns:
- a new #GAction
-
delay
public void delay()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. -
get
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 #GVariantType of @format to mismatch
the type given in the schema.- Parameters:
key
- the key to get the value forformat
- a #GVariant format string_elipse
- arguments as per @format
-
get
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 #GVariantType of @format to mismatch
the type given in the schema.- Parameters:
key
- the key to get the value forformat
- a #GVariant format string_elipse
- arguments as per @format
-
getBoolean
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
- the key to get the value for- Returns:
- a boolean
-
getBoolean
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
- the key to get the value for- Returns:
- a boolean
-
getChild
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.
The created child settings object will inherit the #GSettings:delay-apply
mode from @settings.- Parameters:
name
- the name of the child schema- Returns:
- a 'child' settings object
-
getChild
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.
The created child settings object will inherit the #GSettings:delay-apply
mode from @settings.- Parameters:
name
- the name of the child schema- Returns:
- a 'child' settings object
-
getDefaultValue
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
- the key to get the default value for- Returns:
- the default value
-
getDefaultValue
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
- the key to get the default value for- Returns:
- the default value
-
getDouble
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
- the key to get the value for- Returns:
- a double
-
getDouble
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
- the key to get the value for- Returns:
- a double
-
getEnum
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
- the key to get the value for- Returns:
- the enum value
-
getEnum
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
- the key to get the value for- Returns:
- the enum value
-
getFlags
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
- the key to get the value for- Returns:
- the flags value
-
getFlags
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
- the key to get the value for- Returns:
- the flags value
-
getHasUnapplied
public boolean getHasUnapplied()Returns whether the #GSettings object has any unapplied
changes. This can only be the case if it is in 'delayed-apply' mode.- Returns:
- %TRUE if @settings has unapplied changes
-
getInt
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
- the key to get the value for- Returns:
- an integer
-
getInt
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
- the key to get the value for- Returns:
- an integer
-
getInt64
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
- the key to get the value for- Returns:
- a 64-bit integer
-
getInt64
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
- the key to get the value for- Returns:
- a 64-bit integer
-
getString
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
- the key to get the value for- Returns:
- a newly-allocated string
-
getString
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
- the key to get the value for- Returns:
- a newly-allocated string
-
getUint
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
- the key to get the value for- Returns:
- an unsigned integer
-
getUint
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
- the key to get the value for- Returns:
- an unsigned integer
-
getUint64
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
- the key to get the value for- Returns:
- a 64-bit unsigned integer
-
getUint64
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
- the key to get the value for- Returns:
- a 64-bit unsigned integer
-
getUserValue
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
%NULL (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
- the key to get the user value for- Returns:
- the user's value, if set
-
getUserValue
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
%NULL (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
- the key to get the user value for- Returns:
- the user's value, if set
-
getValue
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
- the key to get the value for- Returns:
- a new #GVariant
-
getValue
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
- the key to get the value for- Returns:
- a new #GVariant
-
isWritable
Finds out if a key can be written or not- Parameters:
name
- the name of a key- Returns:
- %TRUE if the key @name is writable
-
isWritable
Finds out if a key can be written or not- Parameters:
name
- the name of a key- Returns:
- %TRUE if the key @name is writable
-
reset
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
- the name of a key
-
reset
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
- the name of a key
-
revert
public void revert()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. -
set
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 #GVariantType of @format to mismatch
the type given in the schema.- Parameters:
key
- the name of the key to setformat
- a #GVariant format string_elipse
- arguments as per @format- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
set
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 #GVariantType of @format to mismatch
the type given in the schema.- Parameters:
key
- the name of the key to setformat
- a #GVariant format string_elipse
- arguments as per @format- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setBoolean
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setBoolean
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setDouble
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setDouble
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setEnum
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
- a key, within @settingsvalue
- an enumerated value- Returns:
- %TRUE, if the set succeeds
-
setEnum
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
- a key, within @settingsvalue
- an enumerated value- Returns:
- %TRUE, if the set succeeds
-
setFlags
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
- a key, within @settingsvalue
- a flags value- Returns:
- %TRUE, if the set succeeds
-
setFlags
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
- a key, within @settingsvalue
- a flags value- Returns:
- %TRUE, if the set succeeds
-
setInt
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setInt
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setInt64
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setInt64
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setString
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setString
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setUint
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setUint
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setUint64
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setUint64
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
- the name of the key to setvalue
- the value to set it to- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setValue
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
- the name of the key to setvalue
- a #GVariant of the correct type- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
setValue
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
- the name of the key to setvalue
- a #GVariant of the correct type- Returns:
- %TRUE if setting the key succeeded, %FALSE if the key was not writable
-
onChangeEvent
Connect to signal "change-event".
SeeSettings.OnChangeEvent.onChangeEvent(ch.bailu.gtk.type.Pointer, int)
for signal description.
FieldSIGNAL_ON_CHANGE_EVENT
contains original signal name and can be used as resource reference.- Parameters:
signal
- callback function (lambda).- Returns:
SignalHandler
. Can be used to disconnect signal and to release callback function.
-
onChanged
Connect to signal "changed".
SeeSettings.OnChanged.onChanged(ch.bailu.gtk.type.Str)
for signal description.
FieldSIGNAL_ON_CHANGED
contains original signal name and can be used as resource reference.- Parameters:
signal
- callback function (lambda).- Returns:
SignalHandler
. Can be used to disconnect signal and to release callback function.
-
onWritableChangeEvent
Connect to signal "writable-change-event".
SeeSettings.OnWritableChangeEvent.onWritableChangeEvent(int)
for signal description.
FieldSIGNAL_ON_WRITABLE_CHANGE_EVENT
contains original signal name and can be used as resource reference.- Parameters:
signal
- callback function (lambda).- Returns:
SignalHandler
. Can be used to disconnect signal and to release callback function.
-
onWritableChanged
Connect to signal "writable-changed".
SeeSettings.OnWritableChanged.onWritableChanged(ch.bailu.gtk.type.Str)
for signal description.
FieldSIGNAL_ON_WRITABLE_CHANGED
contains original signal name and can be used as resource reference.- Parameters:
signal
- callback function (lambda).- Returns:
SignalHandler
. Can be used to disconnect signal and to release callback function.
-
sync
public static void sync()Ensures that all pending operations are complete for the default backend.
Writes made to a #GSettings 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). -
unbind
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.- Parameters:
object
- the objectproperty
- the property whose binding is removed
-
getTypeID
public static long getTypeID() -
getParentTypeID
public static long getParentTypeID() -
getTypeSize
-
getParentTypeSize
-
getInstanceSize
public static int getInstanceSize()
-