Reference Manual

Inti::GConf::ChangeSet Class Reference

A GConfChangeSet C++ wrapper class. More...

#include <inti/gconf/chnageset.h>

List of all members.

Public Types

• typedef Slot2< void, String &,
  const Value * > ForeachSlot

  Signature for the foreach method called to iterate over each change in a ChangeSet.
  
  

Public Member Functions

Constructors

• ChangeSet ()

  Construct a new ChangeSet.
  
  

• ChangeSet (GConfChangeSet *cs)

  Constructs a ChangeSet with an exisitng GConfChangeSet.
  
  

Accessors

• GConfChangeSet * gconf_change_set () const

  Get a pointer to the GConfChangeSet structure.
  
  

Methods

• virtual void ref ()

  Increases the reference count of a ChangeSet by one.
  
  

• virtual void unref ()

  Decreases the reference count of a ChangeSet by one; if the reference count reaches 0, the ChangeSet is destroyed.
  
  

• void clear ()

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

• unsigned int size () const

  Returns the number of changes in a ChangeSet (a Change stores a key/value pair).
  
  

• void remove (const String &key)

  Removes a change from a ChangeSet.
  
  

• bool check_value (const String &key, Value *value=0)

  Checks whether the change set contains the given key;.
  
  

• void set (const String &key, const Value &value)

  Adds a "set" operation to a change set.
  
  

• void unset (const String &key)

  Adds an "unset" operation to a ChangeSet.
  
  

• void set_int (const String &key, int value)

  Adds a "set" operation; takes an int argument, so you can avoid creating a Value.
  
  

• void set_bool (const String &key, bool value)

  Adds a "set" operation; takes a bool argument, so you can avoid creating a Value.
  
  

• void set_float (const String &key, double value)

  Adds a "set" operation; takes a double argument, so you can avoid creating a Value.
  
  

• void set_string (const String &key, const String &value)

  Adds a "set" operation; takes a String argument, so you can avoid creating a Value.
  
  

• void set_schema (const String &key, const Schema &value)

  Adds a "set" operation; takes a Schema argument, so you can avoid creating a Value.
  
  

• void set_list (const String &key, const std::vector< int > &list)

  Adds a "set" operation; takes a vector of int, so you can avoid creating a list Value.
  
  

• void set_list (const String &key, const std::vector< bool > &list)

  Adds a "set" operation; takes a vector of bool, so you can avoid creating a list Value.
  
  

• void set_list (const String &key, const std::vector< double > &list)

  Adds a "set" operation; takes a vector of double, so you can avoid creating a list Value.
  
  

• void set_list (const String &key, const std::vector< String > &list)

  Adds a "set" operation; takes a vector of String, so you can avoid creating a list Value.
  
  

• void set_list (const String &key, const std::vector< Schema > &list)

  Adds a "set" operation; takes a vector of Schema, so you can avoid creating a list Value.
  
  

• void set_pair (const String &key, int car_data, int cdr_data)

  Adds a "set" operation; takes two ints, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, int car_data, bool cdr_data)

  Adds a "set" operation; takes an int and a bool, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, int car_data, double cdr_data)

  Adds a "set" operation; takes an int and a double, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, int car_data, const String &cdr_data)

  Adds a "set" operation; takes an int and a String, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, int car_data, const Schema &cdr_data)

  Adds a "set" operation; takes an int and a Schema, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, bool car_data, int cdr_data)

  Adds a "set" operation; takes a bool and an int, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, bool car_data, bool cdr_data)

  Adds a "set" operation; takes two bools, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, bool car_data, double cdr_data)

  Adds a "set" operation; takes a bool and a double, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, bool car_data, const String &cdr_data)

  Adds a "set" operation; takes a bool and a String, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, bool car_data, const Schema &cdr_data)

  Adds a "set" operation; takes a bool and a Schema, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, double car_data, int cdr_data)

  Adds a "set" operation; takes a double and a int, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, double car_data, bool cdr_data)

  Adds a "set" operation; takes a double and a bool, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, double car_data, double cdr_data)

  Adds a "set" operation; takes two doubles, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, double car_data, const String &cdr_data)

  Adds a "set" operation; takes a double and a String, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, double car_data, const Schema &cdr_data)

  Adds a "set" operation; takes a double and a Schema, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, const String &car_data, int cdr_data)

  Adds a "set" operation; takes a String and an int, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, const String &car_data, bool cdr_data)

  Adds a "set" operation; takes a String and a bool, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, const String &car_data, double cdr_data)

  Adds a "set" operation; takes a String and a double, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, const String &car_data, const String &cdr_data)

  Adds a "set" operation; takes two Strings, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, const String &car_data, const Schema &cdr_data)

  Adds a "set" operation; takes a String and a Schema, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, const Schema &car_data, int cdr_data)

  Adds a "set" operation; takes a Schema and a int, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, const Schema &car_data, bool cdr_data)

  Adds a "set" operation; takes a Schema and a bool, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, const Schema &car_data, double cdr_data)

  Adds a "set" operation; takes a Schema and a double, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, const Schema &car_data, const String &cdr_data)

  Adds a "set" operation; takes a Schema and a String, so you can avoid creating a pair Value.
  
  

• void set_pair (const String &key, const Schema &car_data, const Schema &cdr_data)

  Adds a "set" operation; takes two Schemas, so you can avoid creating a pair Value.
  
  

---

Detailed Description

A GConfChangeSet C++ wrapper class.

A ChangeSet allows you to collect a set of changes to configuration keys (set/unset operations). You can then commit all the changes at once. This is convenient for something like a preferences dialog; you can collect all the pending changes in a ChangeSet, then when the user clicks apply send them all to the configuration database. The ChangeSet allows you to avoid sending every preferences setting when "apply" is clicked; you only have to send the settings the user changed.

---

Member Typedef Documentation

typedef Slot2<void, String&, const Value*> Inti::GConf::ChangeSet::ForeachSlot

Signature for the foreach method called to iterate over each change in a ChangeSet. Example: Method signature for ForeachSlot. void method(const String& key, const Value *value); // key: A key whose value has been changed. // value: The new value for <EM>key</EM>, or null if the value was unset. You must not call GConf::Change::set_remove() during the iteration, because you'll confuse the internal data structures and cause memory corruption.

---

Member Function Documentation

bool Inti::GConf::ChangeSet::check_value (  const String &  key, Value *  value = 0 )

Checks whether the change set contains the given key;. Parameters: key  The key to check. value  A pointer to an empty Value object. Returns: true if the key is in the ChangeSet. If you just want to check for a value, and don't care what it is, value can be null. To get the value pass a pointer to an empty Value object. This method copies the key's value into your value object. Example: An example of check_value() in action. GConf::Value value; if (check_value("/foo", &value) && value.is_set()) { // do something with the value ... }

void Inti::GConf::ChangeSet::remove (  const String &  key  )

Removes a change from a ChangeSet. Parameters: key  The key to remove from the change set. 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.

void Inti::GConf::ChangeSet::set (  const String &  key, const Value &  value )

Adds a "set" operation to a change set. Parameters: key  The key to change. value  The value to change the key to. This method is similar to gconf_engine_set(), except that no errors can occur (errors occur later, when you try to commit the change set).

void Inti::GConf::ChangeSet::set_bool (  const String &  key, bool  value )

Adds a "set" operation; takes a bool argument, so you can avoid creating a Value. Parameters: key  The key to set. value  The new value of key.

void Inti::GConf::ChangeSet::set_float (  const String &  key, double  value )

Adds a "set" operation; takes a double argument, so you can avoid creating a Value. Parameters: key  The key to set. value  The new value of key.

void Inti::GConf::ChangeSet::set_int (  const String &  key, int  value )

Adds a "set" operation; takes an int argument, so you can avoid creating a Value. Parameters: key  The key to set. value  The new value of key.

void Inti::GConf::ChangeSet::set_list (  const String &  key, const std::vector< Schema > &  list )

Adds a "set" operation; takes a vector of Schema, so you can avoid creating a list Value. Parameters: key  The key you want set. list  A reference to a vector of Schema that contains the list elements.

void Inti::GConf::ChangeSet::set_list (  const String &  key, const std::vector< String > &  list )

Adds a "set" operation; takes a vector of String, so you can avoid creating a list Value. Parameters: key  The key you want set. list  A reference to a vector of String that contains the list elements.

void Inti::GConf::ChangeSet::set_list (  const String &  key, const std::vector< double > &  list )

Adds a "set" operation; takes a vector of double, so you can avoid creating a list Value. Parameters: key  The key you want set. list  A reference to a vector of double that contains the list elements.

void Inti::GConf::ChangeSet::set_list (  const String &  key, const std::vector< bool > &  list )

Adds a "set" operation; takes a vector of bool, so you can avoid creating a list Value. Parameters: key  The key you want set. list  A reference to a vector of bool that contains the list elements.

void Inti::GConf::ChangeSet::set_list (  const String &  key, const std::vector< int > &  list )

Adds a "set" operation; takes a vector of int, so you can avoid creating a list Value. Parameters: key  The key you want set. list  A reference to a vector of int that contains the list elements.

void Inti::GConf::ChangeSet::set_schema (  const String &  key, const Schema &  value )

Adds a "set" operation; takes a Schema argument, so you can avoid creating a Value. Parameters: key  The key to set. value  The new value of key.

void Inti::GConf::ChangeSet::set_string (  const String &  key, const String &  value )

Adds a "set" operation; takes a String argument, so you can avoid creating a Value. Parameters: key  The key to set. value  The new value of key.

void Inti::GConf::ChangeSet::unset (  const String &  key  )

Adds an "unset" operation to a ChangeSet. Parameters: key  The key to change. This function schedules a gconf_engine_unset().

---

The documentation for this class was generated from the following file:

• changeset.h