CrystalSpace

Public API Reference

csOptionDescription Struct Reference
[Utilities]

Description of a configuration option, to be used by the iPluginConfig interfaces. More...

#include <iutil/pluginconfig.h>

List of all members.

Public Member Functions

 csOptionDescription (const char *name, const char *description, csVariantType type)
 Constructor.
 csOptionDescription (int id, const char *name, const char *description, csVariantType type)
 Constructor.
 csOptionDescription ()
 Constructor.

Public Attributes

csString description
 Description for this option.
int id
 Description index (or ID).
csString name
 Short name of this option.
csVariantType type
 Type to use for this option.

Detailed Description

Description of a configuration option, to be used by the iPluginConfig interfaces.

Definition at line 31 of file pluginconfig.h.


Constructor & Destructor Documentation

csOptionDescription::csOptionDescription (  )  [inline]

Constructor.

Definition at line 43 of file pluginconfig.h.

csOptionDescription::csOptionDescription ( int  id,
const char *  name,
const char *  description,
csVariantType  type 
) [inline]

Constructor.

Parameters:
id Description index (or ID)
name Short name of this option.
description Description for this option.
type Type to use for this option.

Definition at line 52 of file pluginconfig.h.

csOptionDescription::csOptionDescription ( const char *  name,
const char *  description,
csVariantType  type 
) [inline]

Constructor.

Parameters:
name Short name of this option.
description Description for this option.
type Type to use for this option.
Warning:
The id is initialized to 0 in this constructor!

Definition at line 62 of file pluginconfig.h.


Member Data Documentation

Description for this option.

Definition at line 38 of file pluginconfig.h.

Description index (or ID).

Definition at line 34 of file pluginconfig.h.

Short name of this option.

Definition at line 36 of file pluginconfig.h.

Type to use for this option.

Definition at line 40 of file pluginconfig.h.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1