DConf Paths — utility functions to validate dconf paths diff -Nru d-conf-0.11.7/docs/html/DConfClient.html d-conf-0.12.0/docs/html/DConfClient.html --- d-conf-0.11.7/docs/html/DConfClient.html 2012-03-19 18:09:54.000000000 +0000 +++ d-conf-0.12.0/docs/html/DConfClient.html 2012-03-26 14:35:08.000000000 +0000 @@ -41,80 +41,80 @@
Synopsis

DConfClient; void (*DConfWatchFunc) (DConfClient *client, - const gchar *path, - const gchar * const *items, - gint n_items, - const gchar *tag, - gpointer user_data); -DConfClient * dconf_client_new (const gchar *profile, + const gchar *path, + const gchar * const *items, + gint n_items, + const gchar *tag, + gpointer user_data); +DConfClient * dconf_client_new (const gchar *profile, DConfWatchFunc watch_func, - gpointer user_data, - GDestroyNotify notify); -GVariant * dconf_client_read (DConfClient *client, - const gchar *key); -GVariant * dconf_client_read_default (DConfClient *client, - const gchar *key); -GVariant * dconf_client_read_no_default (DConfClient *client, - const gchar *key); -gchar ** dconf_client_list (DConfClient *client, - const gchar *dir, - gint *length); -gboolean dconf_client_is_writable (DConfClient *client, - const gchar *key); -gboolean dconf_client_write (DConfClient *client, - const gchar *key, - GVariant *value, - gchar **tag, - GCancellable *cancellable, - GError **error); + gpointer user_data, + GDestroyNotify notify); +GVariant * dconf_client_read (DConfClient *client, + const gchar *key); +GVariant * dconf_client_read_default (DConfClient *client, + const gchar *key); +GVariant * dconf_client_read_no_default (DConfClient *client, + const gchar *key); +gchar ** dconf_client_list (DConfClient *client, + const gchar *dir, + gint *length); +gboolean dconf_client_is_writable (DConfClient *client, + const gchar *key); +gboolean dconf_client_write (DConfClient *client, + const gchar *key, + GVariant *value, + gchar **tag, + GCancellable *cancellable, + GError **error); void dconf_client_write_async (DConfClient *client, - const gchar *key, - GVariant *value, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); -gboolean dconf_client_write_finish (DConfClient *client, - GAsyncResult *result, - gchar **tag, - GError **error); -gboolean dconf_client_write_many (DConfClient *client, - const gchar *dir, - const gchar * const *rels, - GVariant **values, - gint n_values, - gchar **tag, - GCancellable *cancellable, - GError **error); -gboolean dconf_client_watch (DConfClient *client, - const gchar *path, - GCancellable *cancellable, - GError **error); + const gchar *key, + GVariant *value, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); +gboolean dconf_client_write_finish (DConfClient *client, + GAsyncResult *result, + gchar **tag, + GError **error); +gboolean dconf_client_write_many (DConfClient *client, + const gchar *dir, + const gchar * const *rels, + GVariant **values, + gint n_values, + gchar **tag, + GCancellable *cancellable, + GError **error); +gboolean dconf_client_watch (DConfClient *client, + const gchar *path, + GCancellable *cancellable, + GError **error); void dconf_client_watch_async (DConfClient *client, - const gchar *path, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); -gboolean dconf_client_watch_finish (DConfClient *client, - GAsyncResult *result, - GError **error); -gboolean dconf_client_unwatch (DConfClient *client, - const gchar *path, - GCancellable *cancellable, - GError **error); + const gchar *path, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); +gboolean dconf_client_watch_finish (DConfClient *client, + GAsyncResult *result, + GError **error); +gboolean dconf_client_unwatch (DConfClient *client, + const gchar *path, + GCancellable *cancellable, + GError **error); void dconf_client_unwatch_async (DConfClient *client, - const gchar *path, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); -gboolean dconf_client_unwatch_finish (DConfClient *client, - GAsyncResult *result, - GError **error); + const gchar *path, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); +gboolean dconf_client_unwatch_finish (DConfClient *client, + GAsyncResult *result, + GError **error);

Object Hierarchy

-  GObject
+  GObject
    +----DConfClient

Most applications probably don't want to access dconf directly and -would be better off using something like GSettings. +would be better off using something like GSettings.

@@ -146,11 +146,11 @@

DConfWatchFunc ()

void                (*DConfWatchFunc)                   (DConfClient *client,
-                                                         const gchar *path,
-                                                         const gchar * const *items,
-                                                         gint n_items,
-                                                         const gchar *tag,
-                                                         gpointer user_data);

+ const gchar *path, + const gchar * const *items, + gint n_items, + const gchar *tag, + gpointer user_data);

This is the type of the callback given to dconf_client_new().

@@ -208,15 +208,15 @@

dconf_client_new ()

DConfClient *       dconf_client_new                    (const gchar *profile,
+DConfClient *       dconf_client_new                    (const gchar *profile,
                                                          DConfWatchFunc watch_func,
-                                                         gpointer user_data,
-                                                         GDestroyNotify notify);
+                                                         gpointer user_data,
+                                                         GDestroyNotify notify);

Creates a new DConfClient for the given context.

-If profile is non-NULL then it specifies the name of the profile to use. If profile is NULL then +If profile is non-NULL then it specifies the name of the profile to use. If profile is NULL then the DCONF_PROFILE environment variable is consulted. If that is unset then the default profile of "user" is used. If a profile named "user" is not installed then the dconf client is setup to access ~/.config/dconf/user. @@ -226,7 +226,7 @@

profile :

-the dconf profile to use, or NULL +the dconf profile to use, or NULL @@ -250,10 +250,10 @@

dconf_client_read ()

GVariant *          dconf_client_read                   (DConfClient *client,
-                                                         const gchar *key);

GVariant *          dconf_client_read                   (DConfClient *client,
+                                                         const gchar *key);

-Reads the value named by key from dconf. If no such value exists, NULL is returned. +Reads the value named by key from dconf. If no such value exists, NULL is returned.

@@ -266,7 +266,7 @@ +Returns: the value corresponding to key, or NULL if there is none

key :

a valid dconf key -Returns: the value corresponding to key, or NULL if there is none

@@ -274,8 +274,8 @@

dconf_client_read_default ()

GVariant *          dconf_client_read_default           (DConfClient *client,
-                                                         const gchar *key);

GVariant *          dconf_client_read_default           (DConfClient *client,
+                                                         const gchar *key);

Reads the value named by key from any existing default/mandatory databases but ignoring any value set by the user. The result is as if the named key had just been reset. @@ -291,7 +291,7 @@

key :

a valid dconf key -Returns: the default value corresponding to key, or NULL if there is none +Returns: the default value corresponding to key, or NULL if there is none

@@ -299,8 +299,8 @@

dconf_client_read_no_default ()

GVariant *          dconf_client_read_no_default        (DConfClient *client,
-                                                         const gchar *key);

GVariant *          dconf_client_read_no_default        (DConfClient *client,
+                                                         const gchar *key);

Reads the value named by key as set by the user, ignoring any default/mandatory databases. Normal applications will never want to do this, but it may be useful for administrative or configuration @@ -323,7 +323,7 @@

key :

a valid dconf key -Returns: the user value corresponding to key, or NULL if there is none +Returns: the user value corresponding to key, or NULL if there is none

@@ -331,14 +331,14 @@

dconf_client_list ()

gchar **            dconf_client_list                   (DConfClient *client,
-                                                         const gchar *dir,
-                                                         gint *length);

gchar **            dconf_client_list                   (DConfClient *client,
+                                                         const gchar *dir,
+                                                         gint *length);

Lists the keys and dirs located directly below dir.

-You should free the return result with g_strfreev() when it is no longer needed. +You should free the return result with g_strfreev() when it is no longer needed.

@@ -364,8 +364,8 @@

dconf_client_is_writable ()

gboolean            dconf_client_is_writable            (DConfClient *client,
-                                                         const gchar *key);

gboolean            dconf_client_is_writable            (DConfClient *client,
+                                                         const gchar *key);

Checks if key is writable (ie: the key has no mandatory setting).

@@ -385,7 +385,7 @@

+Returns: TRUE is key is writable

key :

a dconf key -Returns: TRUE is key is writable

@@ -393,21 +393,21 @@

dconf_client_write ()

gboolean            dconf_client_write                  (DConfClient *client,
-                                                         const gchar *key,
-                                                         GVariant *value,
-                                                         gchar **tag,
-                                                         GCancellable *cancellable,
-                                                         GError **error);

gboolean            dconf_client_write                  (DConfClient *client,
+                                                         const gchar *key,
+                                                         GVariant *value,
+                                                         gchar **tag,
+                                                         GCancellable *cancellable,
+                                                         GError **error);

Write a value to the given key, or reset key to its default value.

-If value is NULL then key is reset to its default value (which may +If value is NULL then key is reset to its default value (which may be completely unset), otherwise value becomes the new value.

-If tag is non-NULL then it is set to the unique tag associated with this write. This is the same +If tag is non-NULL then it is set to the unique tag associated with this write. This is the same tag that appears in change notifications.

@@ -424,7 +424,7 @@ - @@ -434,13 +434,13 @@ - - +

`value` :	a GVariant, or `NULL`. [allow-none] +	a GVariant, or `NULL`. [allow-none]
`cancellable` :	a GCancellable, or `NULL` +	a GCancellable, or `NULL`
`error` :	a pointer to a GError, or `NULL` -Returns: `TRUE` if the write is successful	a pointer to a GError, or `NULL` +Returns: `TRUE` if the write is successful

@@ -449,11 +449,11 @@

dconf_client_write_async ()

void                dconf_client_write_async            (DConfClient *client,
-                                                         const gchar *key,
-                                                         GVariant *value,
-                                                         GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);

+ const gchar *key, + GVariant *value, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data);

Write a value to the given key, or reset key to its default value.

@@ -475,12 +475,12 @@

value :

-a GVariant, or NULL. [allow-none] +a GVariant, or NULL. [allow-none]

cancellable :

-a GCancellable, or NULL +a GCancellable, or NULL @@ -498,10 +498,10 @@

dconf_client_write_finish ()

gboolean            dconf_client_write_finish           (DConfClient *client,
-                                                         GAsyncResult *result,
-                                                         gchar **tag,
-                                                         GError **error);

gboolean            dconf_client_write_finish           (DConfClient *client,
+                                                         GAsyncResult *result,
+                                                         gchar **tag,
+                                                         GError **error);

Collects the result from a prior call to dconf_client_write_async().

@@ -515,7 +515,7 @@

result :

-the GAsyncResult passed to the GAsyncReadyCallback +the GAsyncResult passed to the GAsyncReadyCallback @@ -525,7 +525,7 @@

error :

-a pointer to a GError, or NULL +a pointer to a GError, or NULL @@ -534,24 +534,24 @@

dconf_client_write_many ()

gboolean            dconf_client_write_many             (DConfClient *client,
-                                                         const gchar *dir,
-                                                         const gchar * const *rels,
-                                                         GVariant **values,
-                                                         gint n_values,
-                                                         gchar **tag,
-                                                         GCancellable *cancellable,
-                                                         GError **error);

gboolean            dconf_client_write_many             (DConfClient *client,
+                                                         const gchar *dir,
+                                                         const gchar * const *rels,
+                                                         GVariant **values,
+                                                         gint n_values,
+                                                         gchar **tag,
+                                                         GCancellable *cancellable,
+                                                         GError **error);

Write multiple values at once.

For each pair of items from rels and values, the value is written to the result of concatenating -dir with the relative path. As with dconf_client_write(), if a given value is NULL then the effect +dir with the relative path. As with dconf_client_write(), if a given value is NULL then the effect is that the specified key is reset.

@@ -568,11 +568,11 @@ - + - + @@ -586,13 +586,13 @@ - - +

`rels` :	a `NULL`-terminated array of relative keys	a `NULL`-terminated array of relative keys
`values` :	an array of possibly-`NULL` GVariant pointers	an array of possibly-`NULL` GVariant pointers
`n_values` :
`cancellable` :	a GCancellable, or `NULL` +	a GCancellable, or `NULL`
`error` :	a pointer to a GError, or `NULL` -Returns: `TRUE` if the write is successful	a pointer to a GError, or `NULL` +Returns: `TRUE` if the write is successful

@@ -600,10 +600,10 @@

dconf_client_watch ()

gboolean            dconf_client_watch                  (DConfClient *client,
-                                                         const gchar *path,
-                                                         GCancellable *cancellable,
-                                                         GError **error);

gboolean            dconf_client_watch                  (DConfClient *client,
+                                                         const gchar *path,
+                                                         GCancellable *cancellable,
+                                                         GError **error);

Requests monitoring of a portion of the dconf database.

@@ -629,13 +629,13 @@

cancellable :

-a GCancellable, or NULL +a GCancellable, or NULL

error :

-a pointer to a NULL GError, or NULL -Returns: TRUE on success, else FALSE with error set +a pointer to a NULL GError, or NULL +Returns: TRUE on success, else FALSE with error set

@@ -644,10 +644,10 @@

dconf_client_watch_async ()

void                dconf_client_watch_async            (DConfClient *client,
-                                                         const gchar *path,
-                                                         GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);

+ const gchar *path, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data);

Requests monitoring of a portion of the dconf database.

@@ -669,12 +669,12 @@

cancellable :

-a GCancellable, or NULL +a GCancellable, or NULL

callback :

-a GAsyncReadyCallback to call when finished +a GAsyncReadyCallback to call when finished

user_data :

@@ -687,9 +687,9 @@

dconf_client_watch_finish ()

gboolean            dconf_client_watch_finish           (DConfClient *client,
-                                                         GAsyncResult *result,
-                                                         GError **error);

gboolean            dconf_client_watch_finish           (DConfClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);

Collects the result from a prior call to dconf_client_watch_async().

@@ -703,12 +703,12 @@

result :

-the GAsyncResult passed to the GAsyncReadyCallback +the GAsyncResult passed to the GAsyncReadyCallback

error :

-a pointer to a GError, or NULL +a pointer to a GError, or NULL @@ -717,10 +717,10 @@

dconf_client_unwatch ()

gboolean            dconf_client_unwatch                (DConfClient *client,
-                                                         const gchar *path,
-                                                         GCancellable *cancellable,
-                                                         GError **error);

gboolean            dconf_client_unwatch                (DConfClient *client,
+                                                         const gchar *path,
+                                                         GCancellable *cancellable,
+                                                         GError **error);

Cancels the effect of a previous call to dconf_client_watch().

@@ -747,13 +747,13 @@

cancellable :

-a GCancellable, or NULL +a GCancellable, or NULL

error :

@@ -762,10 +762,10 @@

dconf_client_unwatch_async ()

void                dconf_client_unwatch_async          (DConfClient *client,
-                                                         const gchar *path,
-                                                         GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);

+ const gchar *path, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data);

Cancels the effect of a previous call to dconf_client_watch().

@@ -788,12 +788,12 @@

cancellable :

-a GCancellable, or NULL +a GCancellable, or NULL

callback :

-a GAsyncReadyCallback to call when finished +a GAsyncReadyCallback to call when finished

user_data :

@@ -806,9 +806,9 @@

dconf_client_unwatch_finish ()

gboolean            dconf_client_unwatch_finish         (DConfClient *client,
-                                                         GAsyncResult *result,
-                                                         GError **error);

gboolean            dconf_client_unwatch_finish         (DConfClient *client,
+                                                         GAsyncResult *result,
+                                                         GError **error);

Collects the result from a prior call to dconf_client_unwatch_async(). @@ -823,12 +823,12 @@

result :

-the GAsyncResult passed to the GAsyncReadyCallback +the GAsyncResult passed to the GAsyncReadyCallback

error :

-a pointer to a GError, or NULL +a pointer to a GError, or NULL diff -Nru d-conf-0.11.7/docs/html/dconf-DConf-Paths.html d-conf-0.12.0/docs/html/dconf-DConf-Paths.html --- d-conf-0.11.7/docs/html/dconf-DConf-Paths.html 2012-03-19 18:09:54.000000000 +0000 +++ d-conf-0.12.0/docs/html/dconf-DConf-Paths.html 2012-03-26 14:35:08.000000000 +0000 @@ -37,18 +37,18 @@

Synopsis

gboolean            dconf_is_dir                        (const gchar *string,
-                                                         GError **error);
-gboolean            dconf_is_key                        (const gchar *string,
-                                                         GError **error);
-gboolean            dconf_is_path                       (const gchar *string,
-                                                         GError **error);
-gboolean            dconf_is_rel                        (const gchar *string,
-                                                         GError **error);
-gboolean            dconf_is_rel_dir                    (const gchar *string,
-                                                         GError **error);
-gboolean            dconf_is_rel_key                    (const gchar *string,
-                                                         GError **error);
+gboolean            dconf_is_dir                        (const gchar *string,
+                                                         GError **error);
+gboolean            dconf_is_key                        (const gchar *string,
+                                                         GError **error);
+gboolean            dconf_is_path                       (const gchar *string,
+                                                         GError **error);
+gboolean            dconf_is_rel                        (const gchar *string,
+                                                         GError **error);
+gboolean            dconf_is_rel_dir                    (const gchar *string,
+                                                         GError **error);
+gboolean            dconf_is_rel_key                    (const gchar *string,
+                                                         GError **error);

@@ -68,8 +68,8 @@

Details

dconf_is_dir ()

gboolean            dconf_is_dir                        (const gchar *string,
-                                                         GError **error);

gboolean            dconf_is_dir                        (const gchar *string,
+                                                         GError **error);

Checks if string is a valid dconf dir. dconf dirs must start and end with '/' and not contain '//'. @@ -93,8 +93,8 @@

error :

-a pointer to a GError, or NULL, set when FALSE is returned -Returns: TRUE if string is a dir +a pointer to a GError, or NULL, set when FALSE is returned +Returns: TRUE if string is a dir

@@ -102,8 +102,8 @@

dconf_is_key ()

gboolean            dconf_is_key                        (const gchar *string,
-                                                         GError **error);

gboolean            dconf_is_key                        (const gchar *string,
+                                                         GError **error);

Checks if string is a valid dconf key. dconf keys must start with '/', not contain '//' and not end with '/'. @@ -126,8 +126,8 @@

error :

-a pointer to a GError, or NULL, set when FALSE is returned -Returns: TRUE if string is a key +a pointer to a GError, or NULL, set when FALSE is returned +Returns: TRUE if string is a key

@@ -135,8 +135,8 @@

dconf_is_path ()

gboolean            dconf_is_path                       (const gchar *string,
-                                                         GError **error);

gboolean            dconf_is_path                       (const gchar *string,
+                                                         GError **error);

Checks if string is a valid dconf path. dconf keys must start with '/' and not contain '//'. @@ -154,8 +154,8 @@

error :

-a pointer to a GError, or NULL, set when FALSE is returned -Returns: TRUE if string is a path +a pointer to a GError, or NULL, set when FALSE is returned +Returns: TRUE if string is a path

@@ -163,8 +163,8 @@

dconf_is_rel ()

gboolean            dconf_is_rel                        (const gchar *string,
-                                                         GError **error);

gboolean            dconf_is_rel                        (const gchar *string,
+                                                         GError **error);

Checks if string is a valid dconf relative path. A relative path is a string that, when concatenated to a dir, forms a valid dconf path. @@ -183,8 +183,8 @@

error :

-a pointer to a GError, or NULL, set when FALSE is returned -Returns: TRUE if string is a relative path +a pointer to a GError, or NULL, set when FALSE is returned +Returns: TRUE if string is a relative path

@@ -192,8 +192,8 @@

dconf_is_rel_dir ()

gboolean            dconf_is_rel_dir                    (const gchar *string,
-                                                         GError **error);

gboolean            dconf_is_rel_dir                    (const gchar *string,
+                                                         GError **error);

Checks if string is a valid dconf relative dir. A relative dir is a string that, when appended to a dir, forms a valid dconf dir. This @@ -216,8 +216,8 @@

error :

-a pointer to a GError, or NULL, set when FALSE is returned -Returns: TRUE if string is a relative dir +a pointer to a GError, or NULL, set when FALSE is returned +Returns: TRUE if string is a relative dir

@@ -225,8 +225,8 @@

dconf_is_rel_key ()

gboolean            dconf_is_rel_key                    (const gchar *string,
-                                                         GError **error);

gboolean            dconf_is_rel_key                    (const gchar *string,
+                                                         GError **error);

Checks if string is a valid dconf relative key. A relative key is a string that, when concatenated to a dir, forms a valid dconf key. @@ -247,8 +247,8 @@

error :

-a pointer to a GError, or NULL, set when FALSE is returned -Returns: TRUE if string is a relative key +a pointer to a GError, or NULL, set when FALSE is returned +Returns: TRUE if string is a relative key

diff -Nru d-conf-0.11.7/docs/html/object-tree.html d-conf-0.12.0/docs/html/object-tree.html --- d-conf-0.11.7/docs/html/object-tree.html 2012-03-19 18:09:54.000000000 +0000 +++ d-conf-0.12.0/docs/html/object-tree.html 2012-03-26 14:35:08.000000000 +0000 @@ -23,7 +23,7 @@

Object Hierarchy

-    GObject
+    GObject
         DConfClient

diff -Nru d-conf-0.11.7/NEWS d-conf-0.12.0/NEWS --- d-conf-0.11.7/NEWS 2012-03-19 18:04:31.000000000 +0000 +++ d-conf-0.12.0/NEWS 2012-03-26 14:33:20.000000000 +0000 @@ -1,3 +1,8 @@ +Changes in dconf 0.12.0 +======================= + +No changes since last unstable release. + Changes in dconf 0.11.7 =======================

-DConf Client API

Synopsis

Object Hierarchy

DConfWatchFunc ()

dconf_client_new ()

dconf_client_read ()

dconf_client_read_default ()

dconf_client_read_no_default ()

dconf_client_list ()

dconf_client_is_writable ()

dconf_client_write ()

dconf_client_write_async ()

dconf_client_write_finish ()

dconf_client_write_many ()

dconf_client_watch ()

dconf_client_watch_async ()

dconf_client_watch_finish ()

dconf_client_unwatch ()

dconf_client_unwatch_async ()

dconf_client_unwatch_finish ()

Synopsis

Details

dconf_is_dir ()

dconf_is_key ()

dconf_is_path ()

dconf_is_rel ()

dconf_is_rel_dir ()

dconf_is_rel_key ()

Object Hierarchy