csKeyValuePair Class Reference
A Key Value pair. More...
#include <cstool/keyval.h>
Inherits scfImplementationExt1<csKeyValuePair, csObject, iKeyValuePair>.
Public Member Functions | |
csKeyValuePair (const char *Key) | |
The constructor. Requires only key. | |
csKeyValuePair (const char *Key, const char *Value) | |
The constructor. Requires both key and value. Data is being copied! | |
void | SetEditorOnly (bool flag) |
Set the "editor only" flag of this key value pair. | |
virtual | ~csKeyValuePair () |
The destructor as usual. | |
iKeyValuePair implementation | |
virtual bool | GetEditorOnly () const |
virtual const char * | GetKey () const |
virtual const char * | GetValue (const char *vname) const |
virtual const char * | GetValue () const |
virtual csRef< iStringArray > | GetValueNames () const |
virtual iObject * | QueryObject () |
virtual void | SetKey (const char *s) |
virtual void | SetValue (const char *vname, const char *value) |
virtual void | SetValue (const char *value) |
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 43 of file keyval.h.
Constructor & Destructor Documentation
csKeyValuePair::csKeyValuePair | ( | const char * | Key, | |
const char * | Value | |||
) |
The constructor. Requires both key and value. Data is being copied!
csKeyValuePair::csKeyValuePair | ( | const char * | Key | ) |
The constructor. Requires only key.
virtual csKeyValuePair::~csKeyValuePair | ( | ) | [virtual] |
The destructor as usual.
Member Function Documentation
void csKeyValuePair::SetEditorOnly | ( | bool | flag | ) | [inline] |
The documentation for this class was generated from the following file:
- cstool/keyval.h
Generated for Crystal Space 1.4.0 by doxygen 1.5.8