GConfChangeSet

typedef struct _GConfChangeSet GConfChangeSet;

An opaque data type representing a set of changes to be made. A change set can contain "set" and "unset" operations.

GConfChangeSetForeachFunc ()

void        (*GConfChangeSetForeachFunc)    (GConfChangeSet *cs,
                                             const gchar *key,
                                             GConfValue *value,
                                             gpointer user_data);

The type of a function passed to gconf_change_set_foreach(). The cs argument is the GConfChangeSet you're iterating over. key is a key in the change set. value is the value the key will be set to, or NULL if the key will be unset. user_data is the user data passed to gconf_change_set_foreach().

gconf_engine_commit_change_set ()

gboolean    gconf_engine_commit_change_set  (GConfEngine *conf,
                                             GConfChangeSet *cs,
                                             gboolean remove_committed,
                                             GError **err);

Applies the changes in the change set to the GConfEngine passed as the first argument. If remove_committed is TRUE, then any successfully-committed changes are removed from the change set. If remove_committed is FALSE, the GConfChangeSet is left unmodified.

If any set or unset operation results in an error, then processing terminates and the error is returned in err (unless err was NULL). If remove_committed was TRUE, then all the changes committed before the error occurred will have been removed from the set. If any error occurs, FALSE is returned.

gconf_engine_reverse_change_set ()

GConfChangeSet* gconf_engine_reverse_change_set
                                            (GConfEngine *conf,
                                             GConfChangeSet *cs,
                                             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.

gconf_engine_change_set_from_currentv ()

GConfChangeSet* gconf_engine_change_set_from_currentv
                                            (GConfEngine *conf,
                                             const gchar **keys,
                                             GError **err);

Creates a change set that will change the keys in NULLterminated array keys to their current state.

gconf_engine_change_set_from_current ()

GConfChangeSet* gconf_engine_change_set_from_current
                                            (GConfEngine *conf,
                                             GError **err,
                                             const gchar *first_key,
                                             ...);

Convenient Varags version of gconf_engine_change_set_from_current().

gconf_change_set_new ()

GConfChangeSet* gconf_change_set_new        (void);

Creates a new, empty GConfChangeSet. The caller assumes one reference count, and must call gconf_change_set_unref() eventually.

gconf_change_set_ref ()

void        gconf_change_set_ref            (GConfChangeSet *cs);

Increases the reference count of a GConfChangeSet by one.

gconf_change_set_unref ()

void        gconf_change_set_unref          (GConfChangeSet *cs);

Decreases the reference count of a GConfChangeSet by one. If the reference count reaches 0, destroys the GConfChangeSet.

gconf_change_set_clear ()

void        gconf_change_set_clear          (GConfChangeSet *cs);

Clears all changes from a GConfChangeSet, so that committing the change set would have no effect.

gconf_change_set_size ()

guint       gconf_change_set_size           (GConfChangeSet *cs);

Returns the size of the changeset, a guint value.

gconf_change_set_remove ()

void        gconf_change_set_remove         (GConfChangeSet *cs,
                                             const gchar *key);

Removes a change from a GConfChangeSet. The key given as the key argument will not be modified if this change set is committed. If key is not in the change set, this function has no effect.

gconf_change_set_foreach ()

void        gconf_change_set_foreach        (GConfChangeSet *cs,
                                             GConfChangeSetForeachFunc func,
                                             gpointer user_data);

Iterates over a GConfChangeSet by calling a GConfChangeSetForeachFunc for each change in the set. See the description of GConfChangeSetForeachFunc for details. You may not call gconf_change_set_remove() during the iteration, because you'll confuse the internal data structures and cause memory corruption.

gconf_change_set_check_value ()

gboolean    gconf_change_set_check_value    (GConfChangeSet *cs,
                                             const gchar *key,
                                             GConfValue **value_retloc);

Looks up the hash table associated with the GConfChangeSet for the key key. If the key is found , the value is set in value_retloc.

gconf_change_set_set ()

void        gconf_change_set_set            (GConfChangeSet *cs,
                                             const gchar *key,
                                             GConfValue *value);

Adds a "set" operation to a change set. This function is similar to gconf_engine_set(), except that no errors can occur (errors occur later, when you try to commit the change set).

gconf_change_set_set_nocopy ()

void        gconf_change_set_set_nocopy     (GConfChangeSet *cs,
                                             const gchar *key,
                                             GConfValue *value);

Like gconf_change_set_set(), except that the GConfChangeSet takes ownership of the GConfValue. You should not use the value again. It will be destroyed when the change is removed from the GConfChangeSet, the change is modified, or the GConfChangeSet is destroyed.

gconf_change_set_unset ()

void        gconf_change_set_unset          (GConfChangeSet *cs,
                                             const gchar *key);

Adds an "unset" operation to a GConfChangeSet. This function schedules a gconf_engine_unset().

gconf_change_set_set_float ()

void        gconf_change_set_set_float      (GConfChangeSet *cs,
                                             const gchar *key,
                                             gdouble val);

Adds a "set" operation; takes a gdouble argument, so you can avoid creating a GConfValue.

gconf_change_set_set_int ()

void        gconf_change_set_set_int        (GConfChangeSet *cs,
                                             const gchar *key,
                                             gint val);

Adds a "set" operation; takes a gint argument, so you can avoid creating a GConfValue.

gconf_change_set_set_string ()

void        gconf_change_set_set_string     (GConfChangeSet *cs,
                                             const gchar *key,
                                             const gchar *val);

Adds a "set" operation; takes a gchar* argument, so you can avoid creating a GConfValue.

gconf_change_set_set_bool ()

void        gconf_change_set_set_bool       (GConfChangeSet *cs,
                                             const gchar *key,
                                             gboolean val);

Adds a "set" operation; takes a gboolean argument, so you can avoid creating a GConfValue.

gconf_change_set_set_schema ()

void        gconf_change_set_set_schema     (GConfChangeSet *cs,
                                             const gchar *key,
                                             GConfSchema *val);

Adds a "set" operation; takes a GConfSchema argument, so you can avoid creating a GConfValue. The schema is copied, val is left unmodified.

gconf_change_set_set_list ()

void        gconf_change_set_set_list       (GConfChangeSet *cs,
                                             const gchar *key,
                                             GConfValueType list_type,
                                             GSList *list);

Adds a "set" operation; takes a GList argument and the type of the list, so you can avoid creating a GConfValue. This results in the list of values being set for the key.

gconf_change_set_set_pair ()

void        gconf_change_set_set_pair       (GConfChangeSet *cs,
                                             const gchar *key,
                                             GConfValueType car_type,
                                             GConfValueType cdr_type,
                                             gconstpointer address_of_car,
                                             gconstpointer address_of_cdr);

Adds a "set" operation; takes a pointer to the addresses of the pair of values, so you can avoid creating a GConfValue. This results in the pair of values being set for the key.

gconf_change_set_set_user_data ()

void        gconf_change_set_set_user_data  (GConfChangeSet *cs,
                                             gpointer data,
                                             GDestroyNotify dnotify);

Sets the user_data and the destroy notification function fields of the GConfChangeSet.

gconf_change_set_get_user_data ()

gpointer    gconf_change_set_get_user_data  (GConfChangeSet *cs);

Returns the user_data field of the GConfChangeSet.