![]() |
Public API Reference |
![]() |
Interface to a configurator object. More...
#include <iutil/pluginconfig.h>
Public Member Functions | |
virtual bool | GetOption (int index, csVariant *value)=0 |
Get the value of the option of index idx. | |
virtual bool | GetOptionDescription (int index, csOptionDescription *option)=0 |
Get the description of the option of index idx. | |
virtual bool | SetOption (int index, csVariant *value)=0 |
Set the value of the option of index idx. |
Interface to a configurator object.
If a SCF module has an object implementing this interface then this can be used to query or set configuration options.
Main creators of instances implementing this interface:
Main ways to get pointers to this interface:
Main users of this interface:
Definition at line 221 of file pluginconfig.h.
virtual bool iPluginConfig::GetOption | ( | int | index, |
csVariant * | value | ||
) | [pure virtual] |
Get the value of the option of index idx.
Return false if this option does not exist, true otherwise.
index | The index of the option |
value | A variant where to store the value of the option |
Implemented in csGraphics2D.
virtual bool iPluginConfig::GetOptionDescription | ( | int | index, |
csOptionDescription * | option | ||
) | [pure virtual] |
Get the description of the option of index idx.
Return false if this option does not exist, true otherwise.
index | The index of the option |
option | The returned description of the option |
Implemented in csGraphics2D.
virtual bool iPluginConfig::SetOption | ( | int | index, |
csVariant * | value | ||
) | [pure virtual] |
Set the value of the option of index idx.
Return false if this option does not exist, true otherwise.
index | The index of the option |
value | The new value to be set for the option |
Implemented in csGraphics2D.