CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iKeyValuePair Struct Reference

A Key Value pair. More...

#include <keyval.h>

Inheritance diagram for iKeyValuePair:

iBase csKeyValuePair List of all members.

Public Methods

virtual iObjectQueryObject ()=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:

Main ways to get pointers to this interface:

Definition at line 47 of file keyval.h.


Member Function Documentation

virtual const char* iKeyValuePair::GetKey   [pure virtual]
 

Get the key string of the pair.

Implemented in csKeyValuePair.

virtual const char* iKeyValuePair::GetValue   [pure virtual]
 

Get the 'value' string of the pair.

This is the same as calling 'GetValue ("value")'.

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 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 *    value [pure virtual]
 

Set the value string of the pair.

This is the same as calling 'SetValue ("value", value)'.

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.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18