Document g_settings_get_child

This commit is contained in:
Matthias Clasen 2010-04-15 10:32:28 -04:00
parent 09ce895cc6
commit ac3dfbcf8c
2 changed files with 25 additions and 1 deletions

View File

@ -2114,6 +2114,7 @@ g_settings_set_delay_apply
g_settings_apply
g_settings_revert
g_settings_get_has_unapplied
g_settings_get_child
<SUBSECTION Standard>
GSettingsClass
<SUBSECTION Private>

View File

@ -59,7 +59,7 @@
* <!ELEMENT schemalist (schema*) >
* <!ATTLIST schemalist gettext-domain #IMPLIED >
*
* <!ELEMENT schema (key*) >
* <!ELEMENT schema (key|child)* >
* <!ATTLIST schema id CDATA #REQUIRED
* path CDATA #IMPLIED
* gettext-domain CDATA #IMPLIED >
@ -90,10 +90,18 @@
* <!ELEMENT choice (alias?) >
* <!ELEMENT alias EMPTY >
* <!ATTLIST alias value CDATA #REQUIRED >
*
* <!ELEMENT child EMPTY >
* <!ATTLIST child name CDATA #REQUIRED
* schema CDATA #REQUIRED >
* ]]>
* ]|
*/
/* XXX talk about key and schema naming conventions,
* explain child settings
*/
struct _GSettingsPrivate
{
GSettingsBackend *backend;
@ -851,6 +859,21 @@ g_settings_is_writable (GSettings *settings,
return writable;
}
/**
* g_settings_get_child:
* @settings: a #GSettings object
* @name: the name of the 'child' schema
* @returns: a 'child' settings object
*
* Creates a 'child' settings object which has a base path of
* <replaceable>base-path</replaceable>/@name", where
* <replaceable>base-path</replaceable> is the base path of @settings.
*
* The schema for the child settings object must have been declared
* in the schema of @settings using a <tag>child</tag> element.
*
* Since: 2.26
*/
GSettings *
g_settings_get_child (GSettings *settings,
const gchar *name)