Public Types | Public Member Functions | Protected Attributes | Related Functions

Gnome::Gda::QuarkList Class Reference
[Data Handlers]

Quark lists (lists of KEY=VALUE's). More...

Collaboration diagram for Gnome::Gda::QuarkList:
Collaboration graph
[legend]

List of all members.

Public Types

typedef sigc::slot< void,
Glib::ustring, Glib::ustring
ForeachSlot

Public Member Functions

 QuarkList ()
 QuarkList (GdaQuarkList* gobject, bool make_a_copy=true)
 QuarkList (const QuarkList& other)
QuarkListoperator= (const QuarkList& other)
 ~QuarkList ()
void swap (QuarkList& other)
GdaQuarkList* gobj ()
 Provides access to the underlying C instance.
const GdaQuarkList* gobj () const
 Provides access to the underlying C instance.
GdaQuarkList* gobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
void clear ()
 Removes all strings in the given Gda::QuarkList.
void add_from_string (const Glib::ustring& name, bool cleanup)
 string must be a semi-colon separated list of "<key>=<value>" strings (for example "DB_NAME=notes;USERNAME=alfred").
Glib::ustring find (const Glib::ustring& name) const
 Searches for the value identified by name in the given Gda::QuarkList.
void remove (const Glib::ustring& name)
 Removes an entry from the Gda::QuarkList, given its name.
void foreach (const ForeachSlot& func)
 Calls the given function for each of the key/value pairs in qlist.

Protected Attributes

GdaQuarkList* gobject_

Related Functions

(Note that these are not member functions.)


void swap (QuarkList& lhs, QuarkList& rhs)
Gnome::Gda::QuarkList wrap (GdaQuarkList* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

Quark lists (lists of KEY=VALUE's).

Parameter lists are used primarily in the parsing and creation of connection strings.


Member Typedef Documentation


Constructor & Destructor Documentation

Gnome::Gda::QuarkList::QuarkList (  )
Gnome::Gda::QuarkList::QuarkList ( GdaQuarkList *  gobject,
bool  make_a_copy = true 
) [explicit]
Gnome::Gda::QuarkList::QuarkList ( const QuarkList other )
Gnome::Gda::QuarkList::~QuarkList (  )

Member Function Documentation

void Gnome::Gda::QuarkList::add_from_string ( const Glib::ustring name,
bool  cleanup 
)

string must be a semi-colon separated list of "<key>=<value>" strings (for example "DB_NAME=notes;USERNAME=alfred").

Each key and value must respect the RFC 1738 recommendations: the <constant><>"#%{}|\^~[]';/?:@=&</constant> and space characters are replaced by <constant>"%ab"</constant> where <constant>ab</constant> is the hexadecimal number corresponding to the character (for example the "DB_NAME=notes;USERNAME=al%%20fred" string will specify a username as "al fred"). If this formalism is not respected, then some unexpected results may occur.

Adds new key->value pairs from the given string. If cleanup is set to true, the previous contents will be discarded before adding the new pairs.

Parameters:
stringA string.
cleanupWhether to cleanup the previous content or not.
void Gnome::Gda::QuarkList::clear (  )

Removes all strings in the given Gda::QuarkList.

Glib::ustring Gnome::Gda::QuarkList::find ( const Glib::ustring name ) const

Searches for the value identified by name in the given Gda::QuarkList.

Parameters:
nameThe name of the value to search for.
Returns:
The value associated with the given key if found, or 0 if not found.
void Gnome::Gda::QuarkList::foreach ( const ForeachSlot func )

Calls the given function for each of the key/value pairs in qlist.

The function is passed the key and value of each pair, and the given user_data parameter. qlist may not be modified while iterating over it.

Parameters:
funcThe function to call for each key/value pair.
user_dataUser data to pass to the function.
const GdaQuarkList* Gnome::Gda::QuarkList::gobj (  ) const [inline]

Provides access to the underlying C instance.

GdaQuarkList* Gnome::Gda::QuarkList::gobj (  ) [inline]

Provides access to the underlying C instance.

GdaQuarkList* Gnome::Gda::QuarkList::gobj_copy (  ) const

Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.

QuarkList& Gnome::Gda::QuarkList::operator= ( const QuarkList other )
void Gnome::Gda::QuarkList::remove ( const Glib::ustring name )

Removes an entry from the Gda::QuarkList, given its name.

Parameters:
nameAn entry name.
void Gnome::Gda::QuarkList::swap ( QuarkList other )

Friends And Related Function Documentation

void swap ( QuarkList lhs,
QuarkList rhs 
) [related]
Parameters:
lhsThe left-hand side
rhsThe right-hand side
Gnome::Gda::QuarkList wrap ( GdaQuarkList *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.

Member Data Documentation

GdaQuarkList* Gnome::Gda::QuarkList::gobject_ [protected]

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