csKeyValuePair Class Reference
A Key Value pair. More...
#include <cstool/keyval.h>
Inheritance diagram for csKeyValuePair:

Public Member Functions | |
csKeyValuePair (const char *Key, const char *Value) | |
The constructor. Requires both key and value. Data is being copied! | |
csKeyValuePair (const char *Key) | |
The constructor. Requires only key. | |
virtual | ~csKeyValuePair () |
The destructor as usual. | |
virtual iObject * | QueryObject () |
Get the iObject. | |
virtual const char * | GetKey () const |
Get the key string of the pair. | |
virtual void | SetKey (const char *s) |
Set the key string of the pair. | |
virtual const char * | GetValue () const |
Get the 'value' string of the pair. | |
virtual const char * | GetValue (const char *vname) const |
Get a value string from the pair. | |
virtual void | SetValue (const char *value) |
Set the value string of the pair. | |
virtual void | SetValue (const char *vname, const char *value) |
Set a value string of the pair. | |
virtual csRef< iStringArray > | GetValueNames () const |
Get a list of the names of values in the pair. |
Detailed Description
A Key Value pair.This object contains a 'key' string and a 'value' string. The 'key' string is the same as the name of the object as returned from the iObject.
One way to attach key value pairs to CS objects is to add the following xml to your object: <key name="somename" value="somevalue" />
Definition at line 38 of file keyval.h.
Constructor & Destructor Documentation
|
The constructor. Requires both key and value. Data is being copied!
|
|
The constructor. Requires only key.
|
|
The destructor as usual.
|
Member Function Documentation
|
Get the key string of the pair.
Implements iKeyValuePair. |
|
Get a value string from the pair.
Implements iKeyValuePair. |
|
Get the 'value' string of the pair. This is the same as calling 'GetValue ("value")'. Implements iKeyValuePair. |
|
Get a list of the names of values in the pair.
Implements iKeyValuePair. |
|
Get the iObject.
Implements iKeyValuePair. |
|
Set the key string of the pair.
Implements iKeyValuePair. |
|
Set a value string of the pair.
Implements iKeyValuePair. |
|
Set the value string of the pair. This is the same as calling 'SetValue ("value", value)'. Implements iKeyValuePair. |
The documentation for this class was generated from the following file:
- cstool/keyval.h
Generated for Crystal Space by doxygen 1.3.9.1