luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-09-20 09:16:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

GSettings: use markdown for sections

Browse Source
This commit is contained in:
Matthias Clasen 2014-02-01 10:48:02 -05:00
parent b5fb6b4bbf
commit eb69bc6aa4
1 changed files with 35 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
gio/gsettings.c
View File

@ -95,7 +95,10 @@
* by the <link linkend="glib-compile-schemas">glib-compile-schemas</link> * by the <link linkend="glib-compile-schemas">glib-compile-schemas</link>
* utility. The input is a schema description in an XML format that can be * utility. The input is a schema description in an XML format that can be
* described by the following DTD: * described by the following DTD:
* |[<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/gschema.dtd"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include>]| *
* <programlisting>
* <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/gschema.dtd"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include>
* </programlisting>
* *
* glib-compile-schemas expects schema files to have the extension <filename>.gschema.xml</filename> * glib-compile-schemas expects schema files to have the extension <filename>.gschema.xml</filename>
* *
@ -185,50 +188,41 @@
* </schemalist> * </schemalist>
* ]| * ]|
* *
* <refsect2> * ## Vendor overrides
* <title>Vendor overrides</title> *
* <para> * Default values are defined in the schemas that get installed by
* Default values are defined in the schemas that get installed by * an application. Sometimes, it is necessary for a vendor or distributor
* an application. Sometimes, it is necessary for a vendor or distributor * to adjust these defaults. Since patching the XML source for the schema
* to adjust these defaults. Since patching the XML source for the schema * is inconvenient and error-prone,
* is inconvenient and error-prone, * <link linkend="glib-compile-schemas">glib-compile-schemas</link> reads
* <link linkend="glib-compile-schemas">glib-compile-schemas</link> reads * so-called 'vendor override' files. These are keyfiles in the same
* so-called 'vendor override' files. These are keyfiles in the same * directory as the XML schema sources which can override default values.
* 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
* 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:
* are expected in serialized GVariant form, as in the following example: * |[
* |[
* [org.gtk.Example] * [org.gtk.Example]
* key1='string' * key1='string'
* key2=1.5 * key2=1.5
* ]| * ]|
* </para>
* <para>
* glib-compile-schemas expects schema files to have the extension
* <filename>.gschema.override</filename>
* </para>
* </refsect2>
* *
* <refsect2> * glib-compile-schemas expects schema files to have the extension
* <title>Binding</title> * <filename>.gschema.override</filename>
* <para> *
* A very convenient feature of GSettings lets you bind #GObject properties * ## Binding
* directly to settings, using g_settings_bind(). Once a GObject property *
* has been bound to a setting, changes on either side are automatically * A very convenient feature of GSettings lets you bind #GObject properties
* propagated to the other side. GSettings handles details like * directly to settings, using g_settings_bind(). Once a GObject property
* mapping between GObject and GVariant types, and preventing infinite * has been bound to a setting, changes on either side are automatically
* cycles. * propagated to the other side. GSettings handles details like mapping
* </para> * between GObject and GVariant types, and preventing infinite cycles.
* <para> *
* This makes it very easy to hook up a preferences dialog to the * This makes it very easy to hook up a preferences dialog to the
* underlying settings. To make this even more convenient, GSettings * underlying settings. To make this even more convenient, GSettings
* looks for a boolean property with the name "sensitivity" and * looks for a boolean property with the name "sensitivity" and
* automatically binds it to the writability of the bound setting. * automatically binds it to the writability of the bound setting.
* If this 'magic' gets in the way, it can be suppressed with the * If this 'magic' gets in the way, it can be suppressed with the
* #G_SETTINGS_BIND_NO_SENSITIVITY flag. * #G_SETTINGS_BIND_NO_SENSITIVITY flag.
* </para> */
* </refsect2>
**/
struct _GSettingsPrivate struct _GSettingsPrivate
{ {