CrystalSpace

Public API Reference

CS::Utility::iModifiableParameter Struct Reference

Description of a specific parameter of a CS::Utility::iMovable. More...

#include <iutil/modifiable.h>

Inheritance diagram for CS::Utility::iModifiableParameter:

List of all members.

Public Member Functions

virtual iModifiableConstraintGetConstraint () const =0
 Get this parameter's constraint, or nullptr if there are none.
virtual const char * GetDescription () const =0
 Get the parameter's textual description.
virtual csStringID GetID () const =0
 Get the ID of this parameter.
virtual const char * GetLabel () const =0
 Get the label of this parameter.
virtual const char * GetName () const =0
 Get the parameter's name.
virtual csVariantType GetType () const =0
 Get the type of this parameter.

Detailed Description

Description of a specific parameter of a CS::Utility::iMovable.

See also:
BaseModifiableParameter for a default implementation

Definition at line 41 of file modifiable.h.


Member Function Documentation

virtual iModifiableConstraint* CS::Utility::iModifiableParameter::GetConstraint (  )  const [pure virtual]

Get this parameter's constraint, or nullptr if there are none.

virtual const char* CS::Utility::iModifiableParameter::GetDescription (  )  const [pure virtual]

Get the parameter's textual description.

Note:
You might want to process this string by the translator.
virtual csStringID CS::Utility::iModifiableParameter::GetID (  )  const [pure virtual]

Get the ID of this parameter.

This ID is built from the string returned by GetLabel()

virtual const char* CS::Utility::iModifiableParameter::GetLabel (  )  const [pure virtual]

Get the label of this parameter.

A label identifies (supposedly uniquely) this parameter.

virtual const char* CS::Utility::iModifiableParameter::GetName (  )  const [pure virtual]

Get the parameter's name.

Note:
You might want to process this string by the translator.
virtual csVariantType CS::Utility::iModifiableParameter::GetType (  )  const [pure virtual]

Get the type of this parameter.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1