![]() |
Public API Reference |
![]() |
A Key Value pair. More...
#include <cstool/keyval.h>
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. | |
void | SetEditorOnly (bool flag) |
Set the "editor only" flag of this key value pair. | |
virtual | ~csKeyValuePair () |
The destructor as usual. | |
iKeyValuePair implementation | |
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. | |
virtual bool | GetEditorOnly () const |
Query whether this pair is an "editor-only" pair. |
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" />
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.
virtual bool csKeyValuePair::GetEditorOnly | ( | ) | const [inline, virtual] |
Query whether this pair is an "editor-only" pair.
They're marked as such in world files and are normally not kept in memory.
Implements iKeyValuePair.
virtual const char* csKeyValuePair::GetKey | ( | ) | const [virtual] |
Get the key string of the pair.
Implements iKeyValuePair.
virtual const char* csKeyValuePair::GetValue | ( | ) | const [virtual] |
Get the 'value' string of the pair.
This is the same as calling 'GetValue ("value")'.
Implements iKeyValuePair.
virtual const char* csKeyValuePair::GetValue | ( | const char * | vname | ) | const [virtual] |
Get a value string from the pair.
Implements iKeyValuePair.
virtual csRef<iStringArray> csKeyValuePair::GetValueNames | ( | ) | const [virtual] |
Get a list of the names of values in the pair.
Implements iKeyValuePair.
virtual iObject* csKeyValuePair::QueryObject | ( | ) | [inline, virtual] |
void csKeyValuePair::SetEditorOnly | ( | bool | flag | ) | [inline] |
virtual void csKeyValuePair::SetKey | ( | const char * | key | ) | [virtual] |
Set the key string of the pair.
Implements iKeyValuePair.
virtual void csKeyValuePair::SetValue | ( | const char * | value | ) | [virtual] |
Set the value string of the pair.
This is the same as calling 'SetValue ("value", value)'.
Implements iKeyValuePair.
virtual void csKeyValuePair::SetValue | ( | const char * | vname, |
const char * | value | ||
) | [virtual] |
Set a value string of the pair.
Implements iKeyValuePair.