CrystalSpace

Public API Reference

csKeyValuePair Class Reference

A Key Value pair. More...

#include <cstool/keyval.h>

Inherits scfImplementationExt1< csKeyValuePair, csObject, iKeyValuePair >.

List of all members.

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 iObjectQueryObject ()
virtual const char * GetKey () const
virtual void SetKey (const char *s)
virtual const char * GetValue () const
virtual const char * GetValue (const char *vname) const
virtual void SetValue (const char *value)
virtual void SetValue (const char *vname, const char *value)
virtual csRef< iStringArrayGetValueNames () const
virtual bool GetEditorOnly () const

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 43 of file keyval.h.


Constructor & Destructor Documentation

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.


Member Function Documentation

void csKeyValuePair::SetEditorOnly ( bool  flag  )  [inline]

Set the "editor only" flag of this key value pair.

Definition at line 60 of file keyval.h.


The documentation for this class was generated from the following file:

Generated for Crystal Space 1.4.1 by doxygen 1.7.1