CrystalSpace

Public API Reference

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

iConfig Struct Reference
[Utilities]

Interface to a configurator object. More...

#include <config.h>

Inheritance diagram for iConfig:

iBase csEngineConfig List of all members.

Public Methods

virtual bool GetOptionDescription (int idx, csOptionDescription *option)=0
 Get option description; return FALSE if there is no such option. More...

virtual bool SetOption (int id, csVariant *value)=0
 Set option. More...

virtual bool GetOption (int id, csVariant *value)=0
 Get option. More...


Detailed Description

Interface to a configurator object.

If a SCF module has an object implementing this interface then this can be used to query/set configuration options.

Definition at line 149 of file config.h.


Member Function Documentation

virtual bool iConfig::GetOption int    id,
csVariant   value
[pure virtual]
 

Get option.

Implemented in csEngineConfig.

virtual bool iConfig::GetOptionDescription int    idx,
csOptionDescription   option
[pure virtual]
 

Get option description; return FALSE if there is no such option.

Implemented in csEngineConfig.

virtual bool iConfig::SetOption int    id,
csVariant   value
[pure virtual]
 

Set option.

Implemented in csEngineConfig.


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