CrystalSpace

Public API Reference

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

csKeyValuePair Class Reference

A Key Value pair. More...

#include <keyval.h>

Inheritance diagram for csKeyValuePair:

csObject iObject iBase List of all members.

Public Methods

 csKeyValuePair (const char *Key, const char *Value)
 The constructor. Requires both key and value. Data is being copied! More...

virtual ~csKeyValuePair ()
 The destructor as usual. More...

const char * GetKey () const
 Get the key string of the pair. More...

void SetKey (const char *s)
 Set the key string of the pair. More...

const char * GetValue () const
 Get the value string of the pair. More...

void SetValue (const char *value)
 Set the value of a key in an object. More...


Public Attributes

csKeyValuePair::KeyValuePair scfiKeyValuePair
 iKeyValuePair implementation. More...


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 34 of file cstool/keyval.h.


Constructor & Destructor Documentation

csKeyValuePair::csKeyValuePair const char *    Key,
const char *    Value
 

The constructor. Requires both key and value. Data is being copied!

virtual csKeyValuePair::~csKeyValuePair   [virtual]
 

The destructor as usual.


Member Function Documentation

const char* csKeyValuePair::GetKey   const
 

Get the key string of the pair.

const char* csKeyValuePair::GetValue   const
 

Get the value string of the pair.

void csKeyValuePair::SetKey const char *    s
 

Set the key string of the pair.

void csKeyValuePair::SetValue const char *    value
 

Set the value of a key in an object.


Member Data Documentation

csKeyValuePair::KeyValuePair csKeyValuePair::scfiKeyValuePair
 

iKeyValuePair implementation.


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