From c3c7263b0b46b0123e368c5b86eb2ec32261b444 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 16 Apr 2010 18:28:08 -0400 Subject: [PATCH] Add new convenience api to docs --- docs/reference/gio/gio-sections.txt | 16 ++- gio/gsettings.c | 160 ++++++++++++++++++++++++++++ gio/gsettingsbackend.c | 1 + 3 files changed, 175 insertions(+), 2 deletions(-) diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt index 19f63131f..450bf55e6 100644 --- a/docs/reference/gio/gio-sections.txt +++ b/docs/reference/gio/gio-sections.txt @@ -2102,8 +2102,6 @@ g_settings_new g_settings_new_with_path g_settings_get_value g_settings_set_value -g_settings_get -g_settings_set g_settings_is_writable g_settings_delay g_settings_apply @@ -2111,6 +2109,20 @@ g_settings_revert g_settings_get_has_unapplied g_settings_get_child + +g_settings_get +g_settings_set +g_settings_get_boolean +g_settings_set_boolean +g_settings_get_int +g_settings_set_int +g_settings_get_double +g_settings_set_double +g_settings_get_string +g_settings_set_string +g_settings_get_strv +g_settings_set_strv + GSettingsBindFlags g_settings_bind diff --git a/gio/gsettings.c b/gio/gsettings.c index 68b7e66e6..4c81aca9d 100644 --- a/gio/gsettings.c +++ b/gio/gsettings.c @@ -1731,6 +1731,21 @@ g_settings_unbind (gpointer object, g_object_set_qdata (object, binding_quark, NULL); } +/** + * g_settings_get_string: + * @settings: a #GSettings object + * @key: the key to get the value for + * @returns: a newly-allocated string + * + * 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 pass a @key that isn't valid for + * @settings or is not of type string. + * + * Since: 2.26 + */ gchar * g_settings_get_string (GSettings *settings, const gchar *key) @@ -1745,6 +1760,23 @@ g_settings_get_string (GSettings *settings, return result; } +/** + * g_settings_set_string: + * @settings: a #GSettings object + * @key: the name of the key to set + * @value: the value to set it to + * @returns: %TRUE if setting the key succeeded, + * %FALSE if the key was not writable + * + * Sets @key in @settings to @value. + * + * A convenience variant of g_settings_set() for strings. + * + * It is a programmer error to pass a @key that isn't valid for + * @settings or is not of type string. + * + * Since: 2.26 + */ gboolean g_settings_set_string (GSettings *settings, const gchar *key, @@ -1753,6 +1785,21 @@ g_settings_set_string (GSettings *settings, return g_settings_set_value (settings, key, g_variant_new_string (value)); } +/** + * g_settings_get_int: + * @settings: a #GSettings object + * @key: the key to get the value for + * @returns: an integer + * + * 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 pass a @key that isn't valid for + * @settings or is not of type int32. + * + * Since: 2.26 + */ gint g_settings_get_int (GSettings *settings, const gchar *key) @@ -1767,6 +1814,23 @@ g_settings_get_int (GSettings *settings, return result; } +/** + * g_settings_set_int: + * @settings: a #GSettings object + * @key: the name of the key to set + * @value: the value to set it to + * @returns: %TRUE if setting the key succeeded, + * %FALSE if the key was not writable + * + * Sets @key in @settings to @value. + * + * A convenience variant of g_settings_set() for 32-bit integers. + * + * It is a programmer error to pass a @key that isn't valid for + * @settings or is not of type int32. + * + * Since: 2.26 + */ gboolean g_settings_set_int (GSettings *settings, const gchar *key, @@ -1775,6 +1839,21 @@ g_settings_set_int (GSettings *settings, return g_settings_set_value (settings, key, g_variant_new_int32 (value)); } +/** + * g_settings_get_double: + * @settings: a #GSettings object + * @key: the key to get the value for + * @returns: a double + * + * 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 pass a @key that isn't valid for + * @settings or is not of type double. + * + * Since: 2.26 + */ gdouble g_settings_get_double (GSettings *settings, const gchar *key) @@ -1789,6 +1868,23 @@ g_settings_get_double (GSettings *settings, return result; } +/** + * g_settings_set_double: + * @settings: a #GSettings object + * @key: the name of the key to set + * @value: the value to set it to + * @returns: %TRUE if setting the key succeeded, + * %FALSE if the key was not writable + * + * Sets @key in @settings to @value. + * + * A convenience variant of g_settings_set() for doubles. + * + * It is a programmer error to pass a @key that isn't valid for + * @settings or is not of type double. + * + * Since: 2.26 + */ gboolean g_settings_set_double (GSettings *settings, const gchar *key, @@ -1797,6 +1893,21 @@ g_settings_set_double (GSettings *settings, return g_settings_set_value (settings, key, g_variant_new_double (value)); } +/** + * g_settings_get_boolean: + * @settings: a #GSettings object + * @key: the key to get the value for + * @returns: a boolean + * + * 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 pass a @key that isn't valid for + * @settings or is not of type boolean. + * + * Since: 2.26 + */ gboolean g_settings_get_boolean (GSettings *settings, const gchar *key) @@ -1811,6 +1922,23 @@ g_settings_get_boolean (GSettings *settings, return result; } +/** + * g_settings_set_boolean: + * @settings: a #GSettings object + * @key: the name of the key to set + * @value: the value to set it to + * @returns: %TRUE if setting the key succeeded, + * %FALSE if the key was not writable + * + * Sets @key in @settings to @value. + * + * A convenience variant of g_settings_set() for booleans. + * + * It is a programmer error to pass a @key that isn't valid for + * @settings or is not of type boolean. + * + * Since: 2.26 + */ gboolean g_settings_set_boolean (GSettings *settings, const gchar *key, @@ -1819,6 +1947,21 @@ g_settings_set_boolean (GSettings *settings, return g_settings_set_value (settings, key, g_variant_new_boolean (value)); } +/** + * g_settings_get_strv: + * @settings: a #GSettings object + * @key: the key to get the value for + * @returns: a newly-allocated, %NULL-terminated array of strings + * + * Gets the value that is stored at @key in @settings. + * + * A convenience variant of g_settings_get() for string arrays. + * + * It is a programmer error to pass a @key that isn't valid for + * @settings or is not of type 'string array'. + * + * Since: 2.26 + */ gchar ** g_settings_get_strv (GSettings *settings, const gchar *key, @@ -1834,6 +1977,23 @@ g_settings_get_strv (GSettings *settings, return result; } +/** + * g_settings_set_strv: + * @settings: a #GSettings object + * @key: the name of the key to set + * @value: the value to set it to + * @returns: %TRUE if setting the key succeeded, + * %FALSE if the key was not writable + * + * Sets @key in @settings to @value. + * + * A convenience variant of g_settings_set() for string arrays. + * + * It is a programmer error to pass a @key that isn't valid for + * @settings or is not of type 'string array'. + * + * Since: 2.26 + */ gboolean g_settings_set_strv (GSettings *settings, const gchar *key, diff --git a/gio/gsettingsbackend.c b/gio/gsettingsbackend.c index c27906315..b562da383 100644 --- a/gio/gsettingsbackend.c +++ b/gio/gsettingsbackend.c @@ -497,6 +497,7 @@ g_settings_backend_read (GSettingsBackend *backend, * @key: the name of the key * @value: a #GVariant value to write to this key * @origin_tag: the origin tag + * @returns: %TRUE if the write succeeded, %FALSE if the key was not writable * * Writes exactly one key. *