luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-20 07:38:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add some more schema docs

Browse Source
This commit is contained in:
Matthias Clasen
2010-04-14 00:22:50 -04:00
parent 102c0dacab
commit 4bc82beae5
4 changed files with 40 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/reference/gio/gio-sections.txt
View File

@@ -2080,7 +2080,8 @@ G_TYPE_FILE_DESCRIPTOR_BASED
<FILE>gsettingsbackend</FILE> <FILE>gsettingsbackend</FILE>
<TITLE>GSettingsBackend</TITLE> <TITLE>GSettingsBackend</TITLE>
GSettingsBackend GSettingsBackend
g_settings_backend_get_default g_settings_backend_get_with_context
g_settings_backend_supports_context
g_settings_backend_create_tree g_settings_backend_create_tree
g_settings_backend_read g_settings_backend_read
g_settings_backend_write g_settings_backend_write

10
gio/gsettings.c
View File

@@ -705,7 +705,7 @@ g_settings_set_value (GSettings *settings,
* g_settings_get: * g_settings_get:
* @settings: a #GSettings object * @settings: a #GSettings object
* @key: the key to get the value for * @key: the key to get the value for
* @format: a #GVariant format string * @format_string: a #GVariant format string
* @...: arguments as per @format * @...: arguments as per @format
* *
* Gets the value that is stored at @key in @settings. * Gets the value that is stored at @key in @settings.
@@ -714,7 +714,7 @@ g_settings_set_value (GSettings *settings,
* g_variant_get(). * g_variant_get().
* *
* It is a programmer error to pass a @key that isn't valid for * It is a programmer error to pass a @key that isn't valid for
* @settings or a @format that doesn't match the type of @key according * @settings or a @format_string that doesn't match the type of @key according
* to the schema of @settings. * to the schema of @settings.
* *
* Since: 2.26 * Since: 2.26
@@ -722,7 +722,7 @@ g_settings_set_value (GSettings *settings,
void void
g_settings_get (GSettings *settings, g_settings_get (GSettings *settings,
const gchar *key, const gchar *key,
const gchar *format, const gchar *format_string,
...) ...)
{ {
GVariant *value; GVariant *value;
@@ -730,8 +730,8 @@ g_settings_get (GSettings *settings,
value = g_settings_get_value (settings, key); value = g_settings_get_value (settings, key);
va_start (ap, format); va_start (ap, format_string);
g_variant_get_va (value, format, NULL, &ap); g_variant_get_va (value, format_string, NULL, &ap);
va_end (ap); va_end (ap);
g_variant_unref (value); g_variant_unref (value);

2
gio/gsettings.h
View File

@@ -67,7 +67,7 @@ void g_settings_apply (GSettin
gboolean g_settings_get_delay_apply (GSettings *settings); gboolean g_settings_get_delay_apply (GSettings *settings);
gboolean g_settings_get_has_unapplied (GSettings *settings); gboolean g_settings_get_has_unapplied (GSettings *settings);
void g_settings_set_delay_apply (GSettings *settings, void g_settings_set_delay_apply (GSettings *settings,
gboolean delay_apply); gboolean delay);
gboolean g_settings_get_locked (GSettings *settings); gboolean g_settings_get_locked (GSettings *settings);
void g_settings_lock (GSettings *settings); void g_settings_lock (GSettings *settings);

32
gio/gsettingsschema.c
View File

@@ -31,6 +31,38 @@
* *
* The #GSettingsSchema class provides schema information (i.e. types, * The #GSettingsSchema class provides schema information (i.e. types,
* default values and descriptions) for keys in settings. * default values and descriptions) for keys in settings.
*
* Schema information is required to use #GSettings.
*
* The source format for GSettings schemas is an XML format that can
* be described with the following DTD:
* |[<![CDATA[
* <!ELEMENT schemalist (schema*) >
* <!ATTLIST schemalist gettext-domain #IMPLIED >
*
* <!ELEMENT schema (key*) >
* <!ATTLIST schema id #REQUIRED
* path #IMPLIED
* gettext-domain #IMPLIED >
*
* <!ELEMENT key (default|summary|description|range)* >
* <!ATTLIST key name #REQUIRED
* type #REQUIRED >
*
* <!ELEMENT default (#PCDATA) >
* <!ATTLIST default l10n #IMPLIED >
*
* <!ELEMENT summary (#PCDATA) >
* <!ELEMENT description (#PCDATA) >
* <!ELEMENT range (choice*|(min,max)) >
*
* <!ELEMENT choice EMPTY >
* <!ATTLIST choice value #REQUIRED >
*
* <!ELEMENT min (#PCDATA) >
* <!ELEMENT max (#PCDATA) >
* ]]>
* ]|
*/ */
G_DEFINE_TYPE (GSettingsSchema, g_settings_schema, G_TYPE_OBJECT) G_DEFINE_TYPE (GSettingsSchema, g_settings_schema, G_TYPE_OBJECT)