-GConfClient +GConfClientGConfClient — GObject-based convenience wrapper @@ -46,55 +46,29 @@ enum GConfClientPreloadType; enum GConfClientErrorHandlingMode; void (*GConfClientNotifyFunc) (GConfClient *client, - guint cnxn_id, + guint cnxn_id, GConfEntry *entry, - gpointer user_data); + gpointer user_data); void (*GConfClientErrorHandlerFunc) (GConfClient *client, - GError *error); + GError *error); #define GCONF_CLIENT (obj) GConfClient* gconf_client_get_default (void); GConfClient* gconf_client_get_for_engine (GConfEngine *engine); void gconf_client_add_dir (GConfClient *client, - const gchar *dir, + const gchar *dir, GConfClientPreloadType preload, - GError **err); + GError **err); void gconf_client_remove_dir (GConfClient *client, - const gchar *dir, - GError **err); -guint gconf_client_notify_add (GConfClient *client, - const gchar *namespace_section, + const gchar *dir, + GError **err); +guint gconf_client_notify_add (GConfClient *client, + const gchar *namespace_section, GConfClientNotifyFunc func, - gpointer user_data, - GFreeFunc destroy_notify, - GError **err); + gpointer user_data, + GFreeFunc destroy_notify, + GError **err); void gconf_client_notify_remove (GConfClient *client, - guint cnxn); + guint cnxn); void gconf_client_notify (GConfClient *client, const char *key); void gconf_client_set_error_handling (GConfClient *client, @@ -103,321 +77,135 @@ (GConfClientErrorHandlerFunc func); void gconf_client_clear_cache (GConfClient *client); void gconf_client_preload (GConfClient *client, - const gchar *dirname, + const gchar *dirname, GConfClientPreloadType type, - GError **err); + GError **err); void gconf_client_set (GConfClient *client, - const gchar *key, + const gchar *key, const GConfValue *val, - GError **err); + GError **err); GConfValue* gconf_client_get (GConfClient *client, - const gchar *key, - GError **err); + const gchar *key, + GError **err); GConfValue* gconf_client_get_without_default (GConfClient *client, - const gchar *key, - GError **err); + const gchar *key, + GError **err); GConfEntry* gconf_client_get_entry (GConfClient *client, - const gchar *key, - const gchar *locale, - gboolean use_schema_default, - GError **err); + const gchar *key, + const gchar *locale, + gboolean use_schema_default, + GError **err); GConfValue* gconf_client_get_default_from_schema (GConfClient *client, - const gchar *key, - GError **err); -gboolean gconf_client_unset (GConfClient *client, - const gchar *key, - GError **err); -gboolean gconf_client_recursive_unset (GConfClient *client, + const gchar *key, + GError **err); +gboolean gconf_client_unset (GConfClient *client, + const gchar *key, + GError **err); +gboolean gconf_client_recursive_unset (GConfClient *client, const char *key, GConfUnsetFlags flags, - GError **err); -GSList* gconf_client_all_entries (GConfClient *client, - const gchar *dir, - GError **err); -GSList* gconf_client_all_dirs (GConfClient *client, - const gchar *dir, - GError **err); + GError **err); +GSList* gconf_client_all_entries (GConfClient *client, + const gchar *dir, + GError **err); +GSList* gconf_client_all_dirs (GConfClient *client, + const gchar *dir, + GError **err); void gconf_client_suggest_sync (GConfClient *client, - GError **err); -gboolean gconf_client_dir_exists (GConfClient *client, - const gchar *dir, - GError **err); -gboolean gconf_client_key_is_writable (GConfClient *client, - const gchar *key, - GError **err); -gdouble gconf_client_get_float (GConfClient *client, - const gchar *key, - GError **err); -gint gconf_client_get_int (GConfClient *client, - const gchar *key, - GError **err); -gchar* gconf_client_get_string (GConfClient *client, - const gchar *key, - GError **err); -gboolean gconf_client_get_bool (GConfClient *client, - const gchar *key, - GError **err); + GError **err); +gboolean gconf_client_dir_exists (GConfClient *client, + const gchar *dir, + GError **err); +gboolean gconf_client_key_is_writable (GConfClient *client, + const gchar *key, + GError **err); +gdouble gconf_client_get_float (GConfClient *client, + const gchar *key, + GError **err); +gint gconf_client_get_int (GConfClient *client, + const gchar *key, + GError **err); +gchar* gconf_client_get_string (GConfClient *client, + const gchar *key, + GError **err); +gboolean gconf_client_get_bool (GConfClient *client, + const gchar *key, + GError **err); GConfSchema* gconf_client_get_schema (GConfClient *client, - const gchar *key, - GError **err); -GSList* gconf_client_get_list (GConfClient *client, - const gchar *key, + const gchar *key, + GError **err); +GSList* gconf_client_get_list (GConfClient *client, + const gchar *key, GConfValueType list_type, - GError **err); -gboolean gconf_client_get_pair (GConfClient *client, - const gchar *key, + GError **err); +gboolean gconf_client_get_pair (GConfClient *client, + const gchar *key, GConfValueType car_type, GConfValueType cdr_type, - gpointer car_retloc, - gpointer cdr_retloc, - GError **err); -gboolean gconf_client_set_float (GConfClient *client, - const gchar *key, - gdouble val, - GError **err); -gboolean gconf_client_set_int (GConfClient *client, - const gchar *key, - gint val, - GError **err); -gboolean gconf_client_set_string (GConfClient *client, - const gchar *key, - const gchar *val, - GError **err); -gboolean gconf_client_set_bool (GConfClient *client, - const gchar *key, - gboolean val, - GError **err); -gboolean gconf_client_set_schema (GConfClient *client, - const gchar *key, + gpointer car_retloc, + gpointer cdr_retloc, + GError **err); +gboolean gconf_client_set_float (GConfClient *client, + const gchar *key, + gdouble val, + GError **err); +gboolean gconf_client_set_int (GConfClient *client, + const gchar *key, + gint val, + GError **err); +gboolean gconf_client_set_string (GConfClient *client, + const gchar *key, + const gchar *val, + GError **err); +gboolean gconf_client_set_bool (GConfClient *client, + const gchar *key, + gboolean val, + GError **err); +gboolean gconf_client_set_schema (GConfClient *client, + const gchar *key, const GConfSchema *val, - GError **err); -gboolean gconf_client_set_list (GConfClient *client, - const gchar *key, + GError **err); +gboolean gconf_client_set_list (GConfClient *client, + const gchar *key, GConfValueType list_type, - GSList *list, - GError **err); -gboolean gconf_client_set_pair (GConfClient *client, - const gchar *key, + GSList *list, + GError **err); +gboolean gconf_client_set_pair (GConfClient *client, + const gchar *key, GConfValueType car_type, GConfValueType cdr_type, - gconstpointer address_of_car, - gconstpointer address_of_cdr, - GError **err); + gconstpointer address_of_car, + gconstpointer address_of_cdr, + GError **err); void gconf_client_error (GConfClient *client, - GError *error); + GError *error); void gconf_client_unreturned_error (GConfClient *client, - GError *error); + GError *error); void gconf_client_value_changed (GConfClient *client, - const gchar *key, + const gchar *key, GConfValue *value); -gboolean gconf_client_commit_change_set (GConfClient *client, +gboolean gconf_client_commit_change_set (GConfClient *client, GConfChangeSet *cs, - gboolean remove_committed, - GError **err); + gboolean remove_committed, + GError **err); GConfChangeSet* gconf_client_reverse_change_set (GConfClient *client, GConfChangeSet *cs, - GError **err); + GError **err); GConfChangeSet* gconf_client_change_set_from_currentv (GConfClient *client, - const gchar **keys, - GError **err); + const gchar **keys, + GError **err); GConfChangeSet* gconf_client_change_set_from_current (GConfClient *client, - GError **err, - const gchar *first_key, + GError **err, + const gchar *first_key, ...);
-
Description+DescriptionGConfClient adds the following features to plain GConf: @@ -444,7 +232,7 @@gconf_client_get_default(), there is no (legitimate) way to obtain a pointer to the
underlying GConfEngine. If you create a GConfClient from an existing engine,
you'll have to be disciplined enough to avoid using that engine directly.
-[1]
+[1]
@@ -457,16 +245,12 @@ There are two error-related signals in GConfClient. The first is plain "error"; it's emitted anytime an error occurs. The second is "unreturned_error"; this -signal is emitted if you pass NULL as the GError** to any +signal is emitted if you pass NULL as the GError** to any GConfClient function. The idea is that you can have a global error handler attached to the "unreturned_error" signal; if you want to use this handler, you don't need to use the normal GConf error handling mechanism. However, if you ever need to handle errors for a specific function call, you can override the -global handler by passing a non-NULL GError** to the +global handler by passing a non-NULL GError** to the function. If you want an error handler that's always invoked, use the "error" signal. @@ -517,11 +301,11 @@
- Details+Details
-
+typedef enum { /*< prefix=GCONF_CLIENT >*/
GCONF_CLIENT_PRELOAD_NONE, /* don't preload anything */
GCONF_CLIENT_PRELOAD_ONELEVEL, /* load entries directly under the directory. */
GCONF_CLIENT_PRELOAD_RECURSIVE /* recurse the directory tree; possibly quite expensive! */
@@ -561,9 +345,9 @@
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | @@ -684,9 +458,9 @@|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns : |
-a new GConfClient. g_object_unref() when you're done.
+ | a new GConfClient. g_object_unref() when you're done.
|
@@ -733,15 +503,13 @@
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | @@ -820,15 +582,11 @@||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | @@ -863,24 +619,14 @@||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | @@ -1128,16 +864,12 @@||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | @@ -1175,15 +905,11 @@||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | |||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | @@ -1624,17 +1286,11 @@|||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | |||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | |||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | |||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | |||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | |||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | |||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | |||||||||||||||||||||||||
GCONF_VALUE_INT |
-The integer itself, converted with GINT_TO_POINTER()
+ | The integer itself, converted with GINT_TO_POINTER()
|
|||||||||||||||||||||||||
GCONF_VALUE_BOOL |
-The bool itself, converted with GINT_TO_POINTER()
+ | The bool itself, converted with GINT_TO_POINTER()
|
|||||||||||||||||||||||||
GCONF_VALUE_FLOAT |
-A pointer to gdouble, which should be freed with g_free()
+ | A pointer to gdouble, which should be freed with g_free()
|
|||||||||||||||||||||||||
GCONF_VALUE_STRING |
-A pointer to gchar, which should be freed with g_free()
+ | A pointer to gchar, which should be freed with g_free()
|
|||||||||||||||||||||||||
|
-the return location for an allocated GError, or NULL to ignore errors. + | the return location for an allocated GError, or NULL to ignore errors. | |||||||||||||||||||||||||
GCONF_VALUE_INT |
-pointer to gint + | pointer to gint | |||||||||||||||||||||||||
GCONF_VALUE_BOOL |
-pointer to gboolean + | pointer to gboolean | |||||||||||||||||||||||||
GCONF_VALUE_FLOAT |
-pointer to gdouble + | pointer to gdouble | |||||||||||||||||||||||||
GCONF_VALUE_STRING |
-pointer to gchar* | +pointer to gchar* | |||||||||||||||||||||||||
GCONF_VALUE_SCHEMA |
@@ -2177,9 +1743,7 @@
-In the GCONF_VALUE_STRING case, you must g_free() the string(s)
+In the GCONF_VALUE_STRING case, you must g_free() the string(s)
stored in the return location(s). In the GCONF_VALUE_SCHEMA case you
must gconf_schema_free() the returned schema. If there's an error
or the value is unset, car_retloc and cdr_retloc are left unchanged.
@@ -2254,9 +1818,7 @@
err :
gboolean gconf_client_set_float (GConfClient *client, - const gchar *key, - gdouble val, - GError **err);+
gboolean gconf_client_set_float (GConfClient *client, + const gchar *key, + gdouble val, + GError **err);
Change the value of key to val. Automatically creates the key if it didn't exist before (ie it was unset or it only had a default value). If the key already exists but doesn't store a float (GCONF_VALUE_FLOAT), gconf_client_set_float() will fail.
Just like gconf_engine_set(), but uses GConfClient caching and error-handling features.
@@ -2310,9 +1864,7 @@
err :
gboolean gconf_client_set_int (GConfClient *client, - const gchar *key, - gint val, - GError **err);+
gboolean gconf_client_set_int (GConfClient *client, + const gchar *key, + gint val, + GError **err);
Change the value of key to val. Automatically creates the key if it didn't exist before (ie it was unset or it only had a default value). If the key already exists but doesn't store an integer (GCONF_VALUE_INT), gconf_client_set_int() will fail.
Just like gconf_engine_set(), but uses GConfClient caching and error-handling features.
@@ -2366,9 +1910,7 @@
err :
gboolean gconf_client_set_string (GConfClient *client, - const gchar *key, - const gchar *val, - GError **err);+
gboolean gconf_client_set_string (GConfClient *client, + const gchar *key, + const gchar *val, + GError **err);
Change the value of key to val. Automatically creates the key if it didn't exist before (ie it was unset or it only had a default value). If the key already exists but doesn't store a string (GCONF_VALUE_STRING), gconf_client_set_string() will fail.
Just like gconf_engine_set(), but uses GConfClient caching and error-handling features.
@@ -2422,9 +1956,7 @@
err :
gboolean gconf_client_set_bool (GConfClient *client, - const gchar *key, - gboolean val, - GError **err);+
gboolean gconf_client_set_bool (GConfClient *client, + const gchar *key, + gboolean val, + GError **err);
Change the value of key to val. Automatically creates the key if it didn't exist before (ie it was unset or it only had a default value). If the key already exists but but doesn't store a boolean (GCONF_VALUE_BOOL), gconf_client_set_bool() will fail.
Just like gconf_engine_set(), but uses GConfClient caching and error-handling features.
@@ -2478,9 +2002,7 @@
err :
gboolean gconf_client_set_schema (GConfClient *client,
- const gchar *key,
+gboolean gconf_client_set_schema (GConfClient *client,
+ const gchar *key,
const GConfSchema *val,
- GError **err);
+ GError **err);
Change the value of key to val. Automatically creates the key if it didn't exist before (ie it was unset or it only had a default value). If the key already exists but doesn't store a schema value (GCONF_VALUE_SCHEMA), gconf_client_set_schema() will fail.
Just like gconf_engine_set(), but uses GConfClient caching and error-handling features.
@@ -2532,9 +2048,7 @@
err :
gboolean gconf_client_set_list (GConfClient *client,
- const gchar *key,
+gboolean gconf_client_set_list (GConfClient *client,
+ const gchar *key,
GConfValueType list_type,
- GSList *list,
- GError **err);
+ GSList *list,
+ GError **err);
Changes the value of key to a list of type list_type. Automatically creates the key if it didn't exist before
(ie it was unset or it had a default value). If the key already exists but doesn't store a list value
@@ -2595,9 +2101,7 @@
err :
gboolean gconf_client_set_pair (GConfClient *client,
- const gchar *key,
+gboolean gconf_client_set_pair (GConfClient *client,
+ const gchar *key,
GConfValueType car_type,
GConfValueType cdr_type,
- gconstpointer address_of_car,
- gconstpointer address_of_cdr,
- GError **err);
+ gconstpointer address_of_car,
+ gconstpointer address_of_cdr,
+ GError **err);
Changes the value of key to a pair with the first field of type car_type and the second field of type cdr_type.
Automatically creates the key if it didn't exist before (ie it was unset or it had a default value). If the key
@@ -2673,9 +2167,7 @@
err :
void gconf_client_error (GConfClient *client, - GError *error);+
void gconf_client_error (GConfClient *client, + GError *error);
Emits the "error" signal. Rarely useful.
@@ -2720,12 +2210,10 @@void gconf_client_unreturned_error (GConfClient *client, - GError *error);+
void gconf_client_unreturned_error (GConfClient *client, + GError *error);
Emits the "unreturned_error" signal. Rarely useful.
@@ -2749,12 +2237,10 @@void gconf_client_value_changed (GConfClient *client, - const gchar *key, +void gconf_client_value_changed (GConfClient *client, + const gchar *key, GConfValue *value);Emits the "value_changed" signal. Rarely useful. @@ -2784,18 +2270,12 @@
gboolean gconf_client_commit_change_set (GConfClient *client,
+gboolean gconf_client_commit_change_set (GConfClient *client,
GConfChangeSet *cs,
- gboolean remove_committed,
- GError **err);
+ gboolean remove_committed,
+ GError **err);
Applies the changes in the change set to the GConfClient passed as
the first argument. If remove_committed is TRUE,
@@ -2831,9 +2311,7 @@
err :
GConfChangeSet* gconf_client_reverse_change_set (GConfClient *client, +GConfChangeSet* gconf_client_reverse_change_set (GConfClient *client, GConfChangeSet *cs, - GError **err);+ GError **err);
Creates a change set that would reverse cs. That is, for each change in cs,
save the current state of that key in the returned change set.
@@ -2875,9 +2351,7 @@
err :
GConfChangeSet* gconf_client_change_set_from_currentv +GConfChangeSet* gconf_client_change_set_from_currentv (GConfClient *client, - const gchar **keys, - GError **err);+ const gchar **keys, + GError **err);
Creates a change set that will change the keys in
NULL-terminated array keys to their current state. Use this to
@@ -2924,9 +2394,7 @@
err :
GConfChangeSet* gconf_client_change_set_from_current +GConfChangeSet* gconf_client_change_set_from_current (GConfClient *client, - GError **err, - const gchar *first_key, + GError **err, + const gchar *first_key, ...);Convenient varargs version of
gconf_client_change_set_from_currentv(). @@ -2965,9 +2429,7 @@
err :
[1] +
[1] This is all a white lie; some direct GConfEngine operations are safe. But it's complicated to know which, and if an operation isn't safe the resulting bugs will mangle the cache and cause weird bugs at an --- gconf-2.21.90.orig/doc/gconf/html/gconf-gconf-backend.html +++ gconf-2.21.90/doc/gconf/html/gconf-gconf-backend.html @@ -21,16 +21,16 @@
-gconf-backend +gconf-backendgconf-backend |
@@ -44,50 +44,30 @@
GConfBackendVTable;
GConfBackend;
-gchar* gconf_address_backend (const gchar *address);
-gchar* gconf_address_resource (const gchar *address);
-gchar* gconf_backend_file (const gchar *address);
-GConfBackend* gconf_get_backend (const gchar *address,
- GError **err);
+gchar* gconf_address_backend (const gchar *address);
+gchar* gconf_address_resource (const gchar *address);
+gchar* gconf_backend_file (const gchar *address);
+GConfBackend* gconf_get_backend (const gchar *address,
+ GError **err);
void gconf_backend_ref (GConfBackend *backend);
void gconf_backend_unref (GConfBackend *backend);
GConfSource* gconf_backend_resolve_address (GConfBackend *backend,
- const gchar *address,
- GError **err);
+ const gchar *address,
+ GError **err);