iKeyValuePair Struct Reference
A Key Value pair. More...
#include <keyval.h>
Inheritance diagram for iKeyValuePair:

Public Methods | |
virtual iObject * | QueryObject ()=0 |
Get the iObject. | |
virtual const char * | GetKey () const=0 |
Get the key string of the pair. | |
virtual void | SetKey (const char *key)=0 |
Set 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 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. |
Detailed Description
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:
- The main loader creates instances of this internally.
- SCF_QUERY_INTERFACE() from iObject instances you get by calling iObject::GetIterator() on iObject instances you get from CS objects (typically using QueryObject()).
Definition at line 47 of file keyval.h.
Member Function Documentation
|
Get the key string of the pair.
Implemented in csKeyValuePair. |
|
Get the 'value' string of the pair. This is the same as calling 'GetValue ("value")'. Implemented in csKeyValuePair. |
|
Get a value string from the pair.
Implemented in csKeyValuePair. |
|
Get the iObject.
Implemented in csKeyValuePair. |
|
Set the key string of the pair.
Implemented in csKeyValuePair. |
|
Set the value string of the pair. This is the same as calling 'SetValue ("value", value)'. Implemented in csKeyValuePair. |
|
Set a value string of the pair.
Implemented in csKeyValuePair. |
The documentation for this struct was generated from the following file:
- ivaria/keyval.h
Generated for Crystal Space by doxygen 1.2.18