#[repr(transparent)]pub struct Settings { /* private fields */ }
Expand description
The Settings
class provides a convenient API for storing and retrieving
application settings.
Reads and writes can be considered to be non-blocking. Reading
settings with Settings
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 Settings
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 SettingsExtManual::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 glib::Variant
, and allows any glib::VariantType
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.
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
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 glib::Variant
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 SettingsExt::enum_()
, SettingsExt::set_enum()
,
SettingsExt::flags()
, SettingsExt::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 glib::Object
properties
directly to settings, using SettingsExtManual::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
SettingsBindFlags::NO_SENSITIVITY
flag.
Relocatable schemas # {gsettings
-relocatable}
A relocatable schema is one with no path
attribute specified on its
<schema>
element. By using with_path()
, a Settings
object
can be instantiated for a relocatable schema, assigning a path to the
instance. Paths passed to 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
.
Properties
backend
The name of the context that the settings are stored in.
Readable | Writeable | Construct Only
delay-apply
Whether the Settings
object is in ‘delay-apply’ mode. See
SettingsExt::delay()
for details.
Readable
has-unapplied
If this property is true
, the Settings
object has outstanding
changes that will be applied when SettingsExt::apply()
is called.
Readable
path
The path within the backend where the settings are stored.
Readable | Writeable | Construct Only
schema
The name of the schema that describes the types of keys
for this Settings
object.
The type of this property is not SettingsSchema
.
SettingsSchema
has only existed since version 2.32 and
unfortunately this name was used in previous versions to refer to
the schema ID rather than the schema itself. Take care to use the
‘settings-schema’ property if you wish to pass in a
SettingsSchema
.
Readable | Writeable | Construct Only
schema-id
The name of the schema that describes the types of keys
for this Settings
object.
Readable | Writeable | Construct Only
settings-schema
The SettingsSchema
describing the types of keys for this
Settings
object.
Ideally, this property would be called ‘schema’. SettingsSchema
has only existed since version 2.32, however, and before then the
‘schema’ property was used to refer to the ID of the schema rather
than the schema itself. Take care.
Readable | Writeable | Construct Only
Signals
change-event
The “change-event” signal is emitted once per change event that affects this settings object. You should connect to this signal only if you are interested in viewing groups of changes before they are split out into multiple emissions of the “changed” signal. For most use cases it is more appropriate to use the “changed” signal.
In the event that the change event applies to one or more specified
keys, keys
will be an array of GQuark
of length n_keys
. In the
event that the change event applies to the Settings
object as a
whole (ie: potentially every key has been changed) then keys
will
be None
and n_keys
will be 0.
The default handler for this signal invokes the “changed” signal
for each affected key. If any other connected handler returns
true
then this default functionality will be suppressed.
changed
The “changed” signal is emitted when a key has potentially changed.
You should call one of the g_settings_get()
calls to check the new
value.
This signal supports detailed connections. You can connect to the detailed signal “changed::x” 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
.
Detailed
writable-change-event
The “writable-change-event” signal is emitted once per writability change event that affects this settings object. You should connect to this signal if you are interested in viewing groups of changes before they are split out into multiple emissions of the “writable-changed” signal. For most use cases it is more appropriate to use the “writable-changed” signal.
In the event that the writability change applies only to a single
key, key
will be set to the GQuark
for that key. In the event
that the writability change affects the entire settings object,
key
will be 0.
The default handler for this signal invokes the “writable-changed”
and “changed” signals for each affected key. This is done because
changes in writability might also imply changes in value (if for
example, a new mandatory setting is introduced). If any other
connected handler returns true
then this default functionality
will be suppressed.
writable-changed
The “writable-changed” signal is emitted when the writability of a
key has potentially changed. You should call
SettingsExt::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.
Detailed
Implements
Implementations§
source§impl Settings
impl Settings
pub const NONE: Option<&'static Settings> = None
sourcepub fn new(schema_id: &str) -> Settings
pub fn new(schema_id: &str) -> Settings
Creates a new 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), SettingsSchemaSource::lookup()
can be used to test for their existence before loading them.
Signals on the newly created Settings
object will be dispatched
via the thread-default glib::MainContext
in effect at the time of the
call to new()
. The new Settings
will hold a reference
on the context. See [glib::MainContext::push_thread_default()
][crate::glib::MainContext::push_thread_default()].
schema_id
the id of the schema
Returns
a new Settings
object
sourcepub fn new_full(
schema: &SettingsSchema,
backend: Option<&impl IsA<SettingsBackend>>,
path: Option<&str>
) -> Settings
pub fn new_full( schema: &SettingsSchema, backend: Option<&impl IsA<SettingsBackend>>, path: Option<&str> ) -> Settings
Creates a new Settings
object with a given schema, backend and
path.
It should be extremely rare that you ever want to use this function. It is made available for advanced use-cases (such as plugin systems that want to provide access to schemas loaded from custom locations, etc).
At the most basic level, a Settings
object is a pure composition of
4 things: a SettingsSchema
, a SettingsBackend
, a path within that
backend, and a glib::MainContext
to which signals are dispatched.
This constructor therefore gives you full control over constructing
Settings
instances. The first 3 parameters are given directly as
schema
, backend
and path
, and the main context is taken from the
thread-default (as per new()
).
If backend
is None
then the default backend is used.
If path
is None
then the path from the schema is used. It is an
error if path
is None
and the schema has no path of its own or if
path
is non-None
and not equal to the path that the schema does
have.
schema
backend
path
the path to use
Returns
a new Settings
object
sourcepub fn with_backend(
schema_id: &str,
backend: &impl IsA<SettingsBackend>
) -> Settings
pub fn with_backend( schema_id: &str, backend: &impl IsA<SettingsBackend> ) -> Settings
Creates a new Settings
object with the schema specified by
schema_id
and a given SettingsBackend
.
Creating a Settings
object with a different backend allows accessing
settings from a database other than the usual one. For example, it may make
sense to pass a backend corresponding to the “defaults” settings database on
the system to get a settings object that modifies the system default
settings instead of the settings for this user.
schema_id
the id of the schema
backend
the SettingsBackend
to use
Returns
a new Settings
object
sourcepub fn with_backend_and_path(
schema_id: &str,
backend: &impl IsA<SettingsBackend>,
path: &str
) -> Settings
pub fn with_backend_and_path( schema_id: &str, backend: &impl IsA<SettingsBackend>, path: &str ) -> Settings
Creates a new Settings
object with the schema specified by
schema_id
and a given SettingsBackend
and path.
This is a mix of with_backend()
and
with_path()
.
schema_id
the id of the schema
backend
the SettingsBackend
to use
path
the path to use
Returns
a new Settings
object
sourcepub fn with_path(schema_id: &str, path: &str) -> Settings
pub fn with_path(schema_id: &str, path: &str) -> Settings
Creates a new 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.
schema_id
the id of the schema
path
the path to use
Returns
a new Settings
object
sourcepub fn sync()
pub fn sync()
Ensures that all pending operations are complete for the default backend.
Writes made to a Settings
are handled asynchronously. For this
reason, it is very unlikely that the changes have it to disk by the
time g_settings_set()
returns.
This call will block until all of the writes have made it to the backend. Since the mainloop is not running, no change notifications will be dispatched during this call (but some may be queued by the time the call is done).
Trait Implementations§
source§impl HasParamSpec for Settings
impl HasParamSpec for Settings
source§impl Ord for Settings
impl Ord for Settings
source§impl<OT: ObjectType> PartialEq<OT> for Settings
impl<OT: ObjectType> PartialEq<OT> for Settings
source§impl<OT: ObjectType> PartialOrd<OT> for Settings
impl<OT: ObjectType> PartialOrd<OT> for Settings
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl StaticType for Settings
impl StaticType for Settings
source§fn static_type() -> Type
fn static_type() -> Type
Self
.impl Eq for Settings
Auto Trait Implementations§
impl RefUnwindSafe for Settings
impl !Send for Settings
impl !Sync for Settings
impl Unpin for Settings
impl UnwindSafe for Settings
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Cast for Twhere
T: ObjectType,
impl<T> Cast for Twhere T: ObjectType,
source§fn upcast<T>(self) -> Twhere
T: ObjectType,
Self: IsA<T>,
fn upcast<T>(self) -> Twhere T: ObjectType, Self: IsA<T>,
T
. Read moresource§fn upcast_ref<T>(&self) -> &Twhere
T: ObjectType,
Self: IsA<T>,
fn upcast_ref<T>(&self) -> &Twhere T: ObjectType, Self: IsA<T>,
T
. Read moresource§fn downcast<T>(self) -> Result<T, Self>where
T: ObjectType,
Self: CanDowncast<T>,
fn downcast<T>(self) -> Result<T, Self>where T: ObjectType, Self: CanDowncast<T>,
T
. Read moresource§fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: CanDowncast<T>,
fn downcast_ref<T>(&self) -> Option<&T>where T: ObjectType, Self: CanDowncast<T>,
T
. Read moresource§fn dynamic_cast<T>(self) -> Result<T, Self>where
T: ObjectType,
fn dynamic_cast<T>(self) -> Result<T, Self>where T: ObjectType,
T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while upcast
will do many checks at compile-time already. downcast
will
perform the same checks at runtime as dynamic_cast
, but will also ensure some amount of
compile-time safety. Read moresource§fn dynamic_cast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
fn dynamic_cast_ref<T>(&self) -> Option<&T>where T: ObjectType,
T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read moresource§unsafe fn unsafe_cast<T>(self) -> Twhere
T: ObjectType,
unsafe fn unsafe_cast<T>(self) -> Twhere T: ObjectType,
T
unconditionally. Read moresource§unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
T: ObjectType,
unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere T: ObjectType,
&T
unconditionally. Read moresource§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> IntoClosureReturnValue for Twhere
T: Into<Value>,
impl<T> IntoClosureReturnValue for Twhere T: Into<Value>,
fn into_closure_return_value(self) -> Option<Value>
source§impl<U> IsSubclassableExt for Uwhere
U: IsClass + ParentClassIs,
impl<U> IsSubclassableExt for Uwhere U: IsClass + ParentClassIs,
fn parent_class_init<T>(class: &mut Class<U>)where T: ObjectSubclass, <U as ParentClassIs>::Parent: IsSubclassable<T>,
fn parent_instance_init<T>(instance: &mut InitializingObject<T>)where T: ObjectSubclass, <U as ParentClassIs>::Parent: IsSubclassable<T>,
source§impl<T> ObjectExt for Twhere
T: ObjectType,
impl<T> ObjectExt for Twhere T: ObjectType,
source§fn is<U>(&self) -> boolwhere
U: StaticType,
fn is<U>(&self) -> boolwhere U: StaticType,
true
if the object is an instance of (can be cast to) T
.source§fn object_class(&self) -> &Class<Object>
fn object_class(&self) -> &Class<Object>
ObjectClass
of the object. Read moresource§fn class_of<U>(&self) -> Option<&Class<U>>where
U: IsClass,
fn class_of<U>(&self) -> Option<&Class<U>>where U: IsClass,
T
. Read moresource§fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where
U: IsInterface,
fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where U: IsInterface,
T
of the object. Read moresource§fn set_property_from_value(&self, property_name: &str, value: &Value)
fn set_property_from_value(&self, property_name: &str, value: &Value)
source§fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])
fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])
source§fn set_properties_from_value(&self, property_values: &[(&str, Value)])
fn set_properties_from_value(&self, property_values: &[(&str, Value)])
source§fn property<V>(&self, property_name: &str) -> Vwhere
V: for<'b> FromValue<'b> + 'static,
fn property<V>(&self, property_name: &str) -> Vwhere V: for<'b> FromValue<'b> + 'static,
property_name
of the object and cast it to the type V. Read moresource§fn property_value(&self, property_name: &str) -> Value
fn property_value(&self, property_name: &str) -> Value
property_name
of the object. Read moresource§fn property_type(&self, property_name: &str) -> Option<Type>
fn property_type(&self, property_name: &str) -> Option<Type>
property_name
of this object. Read moresource§fn find_property(&self, property_name: &str) -> Option<ParamSpec>
fn find_property(&self, property_name: &str) -> Option<ParamSpec>
ParamSpec
of the property property_name
of this object.source§fn list_properties(&self) -> PtrSlice<ParamSpec>
fn list_properties(&self) -> PtrSlice<ParamSpec>
ParamSpec
of the properties of this object.source§fn freeze_notify(&self) -> PropertyNotificationFreezeGuard
fn freeze_notify(&self) -> PropertyNotificationFreezeGuard
source§unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where
QD: 'static,
unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where QD: 'static,
key
. Read moresource§unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where
QD: 'static,
unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where QD: 'static,
key
. Read moresource§unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where
QD: 'static,
unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where QD: 'static,
key
. Read moresource§unsafe fn set_data<QD>(&self, key: &str, value: QD)where
QD: 'static,
unsafe fn set_data<QD>(&self, key: &str, value: QD)where QD: 'static,
key
. Read moresource§unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>where
QD: 'static,
unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>where QD: 'static,
key
. Read moresource§unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>where
QD: 'static,
unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>where QD: 'static,
key
. Read moresource§fn block_signal(&self, handler_id: &SignalHandlerId)
fn block_signal(&self, handler_id: &SignalHandlerId)
source§fn unblock_signal(&self, handler_id: &SignalHandlerId)
fn unblock_signal(&self, handler_id: &SignalHandlerId)
source§fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)
fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)
source§fn stop_signal_emission_by_name(&self, signal_name: &str)
fn stop_signal_emission_by_name(&self, signal_name: &str)
source§fn connect<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
fn connect<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerIdwhere F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
signal_name
on this object. Read moresource§fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
fn connect_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerIdwhere F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
signal_id
on this object. Read moresource§fn connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value> + 'static,
fn connect_local<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerIdwhere F: Fn(&[Value]) -> Option<Value> + 'static,
signal_name
on this object. Read moresource§fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value> + 'static,
fn connect_local_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerIdwhere F: Fn(&[Value]) -> Option<Value> + 'static,
signal_id
on this object. Read moresource§unsafe fn connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value>,
unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerIdwhere F: Fn(&[Value]) -> Option<Value>,
signal_name
on this object. Read moresource§unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value>,
unsafe fn connect_unsafe_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerIdwhere F: Fn(&[Value]) -> Option<Value>,
signal_id
on this object. Read moresource§fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId
fn connect_closure( &self, signal_name: &str, after: bool, closure: RustClosure ) -> SignalHandlerId
signal_name
on this object. Read moresource§fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId
fn connect_closure_id( &self, signal_id: SignalId, details: Option<Quark>, after: bool, closure: RustClosure ) -> SignalHandlerId
signal_id
on this object. Read moresource§fn watch_closure(&self, closure: &impl AsRef<Closure>)
fn watch_closure(&self, closure: &impl AsRef<Closure>)
closure
to the lifetime of the object. When
the object’s reference count drops to zero, the closure will be
invalidated. An invalidated closure will ignore any calls to
invoke_with_values
, or
invoke
when using Rust closures.source§fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> Rwhere R: TryFromClosureReturnValue,
source§fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>
fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>
Self::emit
but takes Value
for the arguments.source§fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> Rwhere R: TryFromClosureReturnValue,
source§fn emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value]
) -> Option<Value>
fn emit_by_name_with_values( &self, signal_name: &str, args: &[Value] ) -> Option<Value>
source§fn emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue]
) -> Rwhere
R: TryFromClosureReturnValue,
fn emit_by_name_with_details<R>( &self, signal_name: &str, details: Quark, args: &[&dyn ToValue] ) -> Rwhere R: TryFromClosureReturnValue,
source§fn emit_by_name_with_details_and_values(
&self,
signal_name: &str,
details: Quark,
args: &[Value]
) -> Option<Value>
fn emit_by_name_with_details_and_values( &self, signal_name: &str, details: Quark, args: &[Value] ) -> Option<Value>
source§fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Rwhere
R: TryFromClosureReturnValue,
fn emit_with_details<R>( &self, signal_id: SignalId, details: Quark, args: &[&dyn ToValue] ) -> Rwhere R: TryFromClosureReturnValue,
source§fn emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value]
) -> Option<Value>
fn emit_with_details_and_values( &self, signal_id: SignalId, details: Quark, args: &[Value] ) -> Option<Value>
source§fn disconnect(&self, handler_id: SignalHandlerId)
fn disconnect(&self, handler_id: SignalHandlerId)
source§fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
F: Fn(&T, &ParamSpec) + Send + Sync + 'static,
fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere F: Fn(&T, &ParamSpec) + Send + Sync + 'static,
notify
signal of the object. Read moresource§fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
F: Fn(&T, &ParamSpec) + 'static,
fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere F: Fn(&T, &ParamSpec) + 'static,
notify
signal of the object. Read moresource§unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerIdwhere
F: Fn(&T, &ParamSpec),
unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F ) -> SignalHandlerIdwhere F: Fn(&T, &ParamSpec),
notify
signal of the object. Read moresource§fn notify(&self, property_name: &str)
fn notify(&self, property_name: &str)
source§fn notify_by_pspec(&self, pspec: &ParamSpec)
fn notify_by_pspec(&self, pspec: &ParamSpec)
source§fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>where
F: FnOnce() + Send + 'static,
fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>where F: FnOnce() + Send + 'static,
source§fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>where
F: FnOnce() + 'static,
fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>where F: FnOnce() + 'static,
source§fn bind_property<'f, 't, O, 'a>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str
) -> BindingBuilder<'a, 'f, 't>where
O: ObjectType,
fn bind_property<'f, 't, O, 'a>( &'a self, source_property: &'a str, target: &'a O, target_property: &'a str ) -> BindingBuilder<'a, 'f, 't>where O: ObjectType,
source§unsafe fn run_dispose(&self)
unsafe fn run_dispose(&self)
source§impl<T> PropertyGet for Twhere
T: HasParamSpec,
impl<T> PropertyGet for Twhere T: HasParamSpec,
source§impl<O> SettingsExt for Owhere
O: IsA<Settings>,
impl<O> SettingsExt for Owhere O: IsA<Settings>,
source§fn apply(&self)
fn apply(&self)
self
is in ‘delay-apply’ mode;
see delay()
. In the normal case settings are always
applied immediately.source§fn bind_writable(
&self,
key: &str,
object: &impl IsA<Object>,
property: &str,
inverted: bool
)
fn bind_writable( &self, key: &str, object: &impl IsA<Object>, property: &str, inverted: bool )
key
in the
self
object and the property property
of object
.
The property must be boolean; “sensitive” or “visible”
properties of widgets are the most likely candidates. Read moresource§fn create_action(&self, key: &str) -> Action
fn create_action(&self, key: &str) -> Action
source§fn child(&self, name: &str) -> Settings
fn child(&self, name: &str) -> Settings
base-path/
name``, where base-path
is the base path of
self
. Read moresource§fn default_value(&self, key: &str) -> Option<Variant>
fn default_value(&self, key: &str) -> Option<Variant>
source§fn enum_(&self, key: &str) -> i32
fn enum_(&self, key: &str) -> i32
self
for key
and converts it
to the enum value that it represents. Read moresource§fn flags(&self, key: &str) -> u32
fn flags(&self, key: &str) -> u32
self
for key
and converts it
to the flags value that it represents. Read moresource§fn has_unapplied(&self) -> bool
fn has_unapplied(&self) -> bool
source§fn user_value(&self, key: &str) -> Option<Variant>
fn user_value(&self, key: &str) -> Option<Variant>
source§fn set_flags(&self, key: &str, value: u32) -> Result<(), BoolError>
fn set_flags(&self, key: &str, value: u32) -> Result<(), BoolError>
value
, puts
them in an array of strings and writes the array to key
, within
self
. Read moresource§fn backend(&self) -> Option<SettingsBackend>
fn backend(&self) -> Option<SettingsBackend>
source§fn is_delay_apply(&self) -> bool
fn is_delay_apply(&self) -> bool
source§fn schema_id(&self) -> Option<GString>
fn schema_id(&self) -> Option<GString>
Settings
object.source§fn settings_schema(&self) -> Option<SettingsSchema>
fn settings_schema(&self) -> Option<SettingsSchema>
source§fn connect_changed<F>(&self, detail: Option<&str>, f: F) -> SignalHandlerIdwhere
F: Fn(&O, &str) + 'static,
fn connect_changed<F>(&self, detail: Option<&str>, f: F) -> SignalHandlerIdwhere F: Fn(&O, &str) + 'static,
g_settings_get()
calls to check the new
value. Read moresource§fn connect_writable_change_event<F>(&self, f: F) -> SignalHandlerIdwhere
F: Fn(&O, u32) -> Inhibit + 'static,
fn connect_writable_change_event<F>(&self, f: F) -> SignalHandlerIdwhere F: Fn(&O, u32) -> Inhibit + 'static,
source§fn connect_writable_changed<F>(
&self,
detail: Option<&str>,
f: F
) -> SignalHandlerIdwhere
F: Fn(&O, &str) + 'static,
fn connect_writable_changed<F>( &self, detail: Option<&str>, f: F ) -> SignalHandlerIdwhere F: Fn(&O, &str) + 'static,
is_writable()
in order to determine the new status. Read morefn connect_delay_apply_notify<F>(&self, f: F) -> SignalHandlerIdwhere F: Fn(&O) + 'static,
fn connect_has_unapplied_notify<F>(&self, f: F) -> SignalHandlerIdwhere F: Fn(&O) + 'static,
source§impl<O> SettingsExtManual for Owhere
O: IsA<Settings>,
impl<O> SettingsExtManual for Owhere O: IsA<Settings>,
fn get<U>(&self, key: &str) -> Uwhere U: FromVariant,
fn set(&self, key: &str, value: impl Into<Variant>) -> Result<(), BoolError>
source§fn strv(&self, key: &str) -> StrV
fn strv(&self, key: &str) -> StrV
g_settings_get()
for string arrays. Read more