CrystalSpace

Public API Reference

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

iAwsParmList Struct Reference

Provides support for safely passing named parameters through to different functions in a portable manner. More...

#include <iaws/awsparm.h>

Inheritance diagram for iAwsParmList:

iBase List of all members.

Public Member Functions

virtual void AddInt (const char *name, int value)=0
 Adds an integer to the parmeter list.
virtual void AddFloat (const char *name, float value)=0
 Adds a float to the parmeter list.
virtual void AddBool (const char *name, bool value)=0
 Adds a bool to the parmeter list.
virtual void AddString (const char *name, const char *value)=0
 Adds a string to the parmeter list.
virtual void AddStringVector (const char *name, iStringArray *value)=0
 Adds a string vector to the parmeter list.
virtual void AddRect (const char *name, csRect *value)=0
 Adds a rect to the parmeter list.
virtual void AddPoint (const char *name, csPoint *value)=0
 Adds a point to the parmeter list.
virtual void AddOpaque (const char *name, void *value)=0
 Adds an opaque, undefined value to the parm list.
virtual bool GetInt (const char *name, int *value)=0
 Returns the int named "name" in value.
virtual bool GetFloat (const char *name, float *value)=0
 Returns the float named "name" in value.
virtual bool GetBool (const char *name, bool *value)=0
 Returns the bool named "name" in value.
virtual bool GetString (const char *name, iString **value)=0
 Returns the string named "name" in value.
virtual bool GetStringVector (const char *name, iStringArray **value)=0
 Returns the string vector named "name" in value.
virtual bool GetRect (const char *name, csRect **value)=0
 Returns the rect named "name" in value.
virtual bool GetPoint (const char *name, csPoint **value)=0
 Returns the point named "name" in value.
virtual bool GetOpaque (const char *name, void **value)=0
 Returns the opaque value named "name" in value.
virtual void Clear ()=0
 Clears the parameter list.

Detailed Description

Provides support for safely passing named parameters through to different functions in a portable manner.

Note that awsParmList does not utilize copy semantics. In the interests of space and speed, it simply takes a reference to the pointers passed in. This means that you should NOT use an awsParmList if any parm it references has gone out of scope!

Definition at line 36 of file awsparm.h.


Member Function Documentation

virtual void iAwsParmList::AddBool const char *  name,
bool  value
[pure virtual]
 

Adds a bool to the parmeter list.

virtual void iAwsParmList::AddFloat const char *  name,
float  value
[pure virtual]
 

Adds a float to the parmeter list.

virtual void iAwsParmList::AddInt const char *  name,
int  value
[pure virtual]
 

Adds an integer to the parmeter list.

virtual void iAwsParmList::AddOpaque const char *  name,
void *  value
[pure virtual]
 

Adds an opaque, undefined value to the parm list.

This is stored as a void *, but should never be assumed to be anything at all, except some value that fits in sizeof(void *)

virtual void iAwsParmList::AddPoint const char *  name,
csPoint value
[pure virtual]
 

Adds a point to the parmeter list.

virtual void iAwsParmList::AddRect const char *  name,
csRect value
[pure virtual]
 

Adds a rect to the parmeter list.

virtual void iAwsParmList::AddString const char *  name,
const char *  value
[pure virtual]
 

Adds a string to the parmeter list.

virtual void iAwsParmList::AddStringVector const char *  name,
iStringArray value
[pure virtual]
 

Adds a string vector to the parmeter list.

virtual void iAwsParmList::Clear  )  [pure virtual]
 

Clears the parameter list.

virtual bool iAwsParmList::GetBool const char *  name,
bool *  value
[pure virtual]
 

Returns the bool named "name" in value.

True if it was found, otherwise false.

virtual bool iAwsParmList::GetFloat const char *  name,
float *  value
[pure virtual]
 

Returns the float named "name" in value.

True if it was found, otherwise false.

virtual bool iAwsParmList::GetInt const char *  name,
int *  value
[pure virtual]
 

Returns the int named "name" in value.

True if it was found, otherwise false.

virtual bool iAwsParmList::GetOpaque const char *  name,
void **  value
[pure virtual]
 

Returns the opaque value named "name" in value.

True if it was found, otherwise false.

virtual bool iAwsParmList::GetPoint const char *  name,
csPoint **  value
[pure virtual]
 

Returns the point named "name" in value.

True if it was found, otherwise false.

virtual bool iAwsParmList::GetRect const char *  name,
csRect **  value
[pure virtual]
 

Returns the rect named "name" in value.

True if it was found, otherwise false.

virtual bool iAwsParmList::GetString const char *  name,
iString **  value
[pure virtual]
 

Returns the string named "name" in value.

True if it was found, otherwise false.

virtual bool iAwsParmList::GetStringVector const char *  name,
iStringArray **  value
[pure virtual]
 

Returns the string vector named "name" in value.

True if it was found, otherwise false.


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