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().
the id of the schema
The name of the context that the settings are stored in.
Whether the #GSettings object is in 'delay-apply' mode. See g_settings_delay() for details.
If this property is %TRUE, the #GSettings object has outstanding changes that will be applied when g_settings_apply() is called.
The path within the backend where the settings are stored.
The name of the schema that describes the types of keys for this #GSettings object.
The type of this property is not #GSettingsSchema. #GSettingsSchema 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 #GSettingsSchema.
The name of the schema that describes the types of keys for this #GSettings object.
The #GSettingsSchema describing the types of keys for this #GSettings object.
Ideally, this property would be called 'schema'. #GSettingsSchema 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.
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.
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.
the key to bind
a #GObject
the name of the property to bind
flags for the binding
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
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.
the key to bind
a #GObject
the name of a boolean property to bind
whether to 'invert' the value
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).
the name of a key in settings
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.
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
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.
the key to get the value for
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.
the name of the child schema
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
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.
the key to get the default value for
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.
the key to get the value for
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.
the key to get the value for
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.
the key to get the value for
Returns whether the #GSettings object has any unapplied changes. This can only be the case if it is in 'delayed-apply' mode.
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.
the key to get the value for
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.
the key to get the value for
Gets the value that is stored at key in settings, subject to
application-level validation/mapping.
You should use this function when the application needs to perform
some processing on the value of the key (for example, parsing). The
mapping function performs that processing. If the function
indicates that the processing was unsuccessful (due to a parse error,
for example) then the mapping is tried again with another value.
This allows a robust 'fall back to defaults' behaviour to be implemented somewhat automatically.
The first value that is tried is the user's setting for the key. If the mapping function fails to map this value, other values may be tried in an unspecified order (system or site defaults, translated schema default values, untranslated schema default values, etc).
If the mapping function fails for all possible values, one additional attempt is made: the mapping function is called with a %NULL value. If the mapping function still indicates failure at this point then the application will be aborted.
The result parameter for the mapping function is pointed to a
#gpointer which is initially set to %NULL. The same pointer is given
to each invocation of mapping. The final value of that #gpointer is
what is returned by this function. %NULL is valid; it is returned
just as any other value would be.
the key to get the value for
the function to map the value in the settings database to the value used by the application
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
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.
the key to get the value for
A convenience variant of g_settings_get() for string arrays.
It is a programmer error to give a key that isn't specified as
having an array of strings type in the schema for settings.
the key to get the value for
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.
the key to get the value for
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.
the key to get the value for
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.
the key to get the user value for
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
Finds out if a key can be written or not
the name of a key
Gets the list of children on settings.
The list is exactly the list of strings for which it is not an error to call g_settings_get_child().
There is little reason to call this function from "normal" code, since you should already know what children are in your schema. This function may still be useful there for introspection reasons, however.
You should free the return value with g_strfreev() when you are done with it.
Introspects the list of keys on settings.
You should probably not be calling this function from "normal" code (since you should already know what keys are in your schema). This function is intended for introspection reasons.
You should free the return value with g_strfreev() when you are done with it.
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object.
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
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.
the name of a key
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.
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
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.
the name of the key to set
the value to set it to
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a #GQuark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
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.
the name of the key to set
the value to set it to
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.
a key, within settings
an enumerated value
Looks up the flags type nicks for the bits specified by value, puts
them in an array of strings and writes the array to key, within
settings.
It is a programmer error to give a key that isn't contained in the
schema for settings or is not marked as a flags type, or for value
to contain any bits that are not value for the named type.
After performing the write, accessing key directly with
g_settings_get_strv() will return an array of 'nicks'; one for each
bit in value.
a key, within settings
a flags value
Sets key in settings to value.
A convenience variant of g_settings_set() for 32-bit integers.
It is a programmer error to give a key that isn't specified as
having a int32 type in the schema for settings.
the name of the key to set
the value to set it to
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.
the name of the key to set
the value to set it to
Sets a property on an object.
the name of the property to set
the value
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.
the name of the key to set
the value to set it to
Sets key in settings to value.
A convenience variant of g_settings_set() for string arrays. If
value is %NULL, then key is set to be the empty array.
It is a programmer error to give a key that isn't specified as
having an array of strings type in the schema for settings.
the name of the key to set
the value to set it to, or %NULL
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.
the name of the key to set
the value to set it to
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.
the name of the key to set
the value to set it to
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.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
#GTypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Deprecated.
Deprecated.
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().
the id of the schema
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.
a #GSettingsSchema
a #GSettingsBackend
the path to use
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.
the id of the schema
the #GSettingsBackend to use
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().
the id of the schema
the #GSettingsBackend to use
the path to use
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.
the id of the schema
the path to use
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
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).
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 or
elements and the category that is specified in the element. The string which is translated includes all text in
the element, including any surrounding quotation marks.
gettext-domainattribute of thel10nattribute of theThe element — it is recommended to
add these comments to aid translators understand the meaning and
implications of the default value. An optional translation element to disambiguate multiple
defaults which use the same string.
l10nattribute must be set tomessagesortime, and sets the locale category for translation. Themessagescategory should be used by default; usetimefor translatable date or time formats. A translation comment can be added as an XML comment immediately above thecontextattribute can be set on theFor example: |[['bad', 'words']
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: |[ [org.gtk.Example] key1='string' key2=1.5
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_GSETTINGSNo changes are needed to the build system to mark a schema XML file for translation. Assuming it sets the
gettext-domainattribute, a schema may be marked for translation by adding it toPOTFILES.in, assuming gettext 0.19 is in use (the preferred method for translation): |[ data/org.foo.MyApp.gschema.xmlGSettings will use gettext to look up translations for the and
elements, and also any elements which have a
l10nattribute set. Translations must not be included in the.gschema.xmlfile by the build system, for example by using intltool XML rules with a.gschema.xml.intemplate.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 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_NAMESPACEspecifies the schema namespace for the enum files, which are specified ingsettings_ENUM_FILES. This will generate aorg.foo.MyApp.enums.xmlfile 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 inEXTRA_DIST.