![]() |
Public API Reference |
![]() |
A Key Value pair. More...
#include <ivaria/keyval.h>
Public Member Functions | |
virtual bool | GetEditorOnly () const =0 |
Query whether this pair is an "editor-only" pair. | |
virtual const char * | GetKey () const =0 |
Get the key string of the pair. | |
virtual const char * | GetValue (const char *vname) const =0 |
Get a value string from the pair. | |
virtual const char * | GetValue () const =0 |
Get the 'value' string of the pair. | |
virtual csRef< iStringArray > | GetValueNames () const =0 |
Get a list of the names of values in the pair. | |
virtual iObject * | QueryObject ()=0 |
Get the iObject. | |
virtual void | SetKey (const char *key)=0 |
Set the key string of the pair. | |
virtual void | SetValue (const char *vname, const char *value)=0 |
Set a value string of the pair. | |
virtual void | SetValue (const char *value)=0 |
Set the value string of the pair. |
A Key Value pair.
This object contains a 'key' string and one or more 'value' strings. Typically key value pairs are specified in map files (using the <key> tag). They allow a game developer to tag game specific information to any Crystal Space object.
Main creators of instances implementing this interface:
Main ways to get pointers to this interface:
virtual bool iKeyValuePair::GetEditorOnly | ( | ) | const [pure 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.
Implemented in csKeyValuePair.
virtual const char* iKeyValuePair::GetKey | ( | ) | const [pure virtual] |
Get the key string of the pair.
Implemented in csKeyValuePair.
virtual const char* iKeyValuePair::GetValue | ( | const char * | vname | ) | const [pure virtual] |
Get a value string from the pair.
Implemented in csKeyValuePair.
virtual const char* iKeyValuePair::GetValue | ( | ) | const [pure virtual] |
Get the 'value' string of the pair.
This is the same as calling 'GetValue ("value")'.
Implemented in csKeyValuePair.
virtual csRef<iStringArray> iKeyValuePair::GetValueNames | ( | ) | const [pure virtual] |
Get a list of the names of values in the pair.
Implemented in csKeyValuePair.
virtual iObject* iKeyValuePair::QueryObject | ( | ) | [pure virtual] |
Get the iObject.
Implemented in csKeyValuePair.
virtual void iKeyValuePair::SetKey | ( | const char * | key | ) | [pure virtual] |
Set the key string of the pair.
Implemented in csKeyValuePair.
virtual void iKeyValuePair::SetValue | ( | const char * | vname, |
const char * | value | ||
) | [pure virtual] |
Set a value string of the pair.
Implemented in csKeyValuePair.
virtual void iKeyValuePair::SetValue | ( | const char * | value | ) | [pure virtual] |
Set the value string of the pair.
This is the same as calling 'SetValue ("value", value)'.
Implemented in csKeyValuePair.