CrystalSpace

Public API Reference

CS::Utility::BaseModifiableDescription Class Reference

Basic implementation of CS::Utility::iModifiableDescription, suitable for most uses. More...

#include <cstool/modifiableimpl.h>

Inheritance diagram for CS::Utility::BaseModifiableDescription:

List of all members.

Public Member Functions

virtual size_t FindParameter (csStringID id) const
 Default implementation for CS::Utility::iModifiableDescription::FindParameter().
virtual iModifiableDescriptionGetChild (size_t index) const
 Default implementation for CS::Utility::iModifiableDescription::GetChild().
virtual size_t GetChildrenCount () const
 Default implementation for CS::Utility::iModifiableDescription::GetChildrenCount().
virtual const char * GetLabel () const
 Default implementation for CS::Utility::iModifiableDescription::GetLabel().
virtual const char * GetName () const
 Default implementation for CS::Utility::iModifiableDescription::GetName().
virtual iModifiableParameterGetParameter (size_t index) const
 Default implementation for CS::Utility::iModifiableDescription::GetParameter(size_t).
virtual iModifiableParameterGetParameter (csStringID id) const
 Default implementation for CS::Utility::iModifiableDescription::GetParameter(csStringID).
virtual size_t GetParameterCount () const
 Default implementation for CS::Utility::iModifiableDescription::GetParameterCount().
virtual size_t GetTotalParameterCount () const
 Default implementation for CS::Utility::iModifiableDescription::GetTotalParameterCount().
void Push (const char *resource)
 Add the given resource to the list.
void Push (BaseModifiableDescription *child)
 Add the given description to the list of children.
void Push (iModifiableParameter *param)
 Add the given parameter to the list.

Detailed Description

Basic implementation of CS::Utility::iModifiableDescription, suitable for most uses.

Simply holds a csRefArray of CS::Utility::iModifiableParameter and implements GetParameterCount() and GetParameter().

Definition at line 262 of file modifiableimpl.h.


Member Function Documentation

virtual size_t CS::Utility::BaseModifiableDescription::FindParameter ( csStringID  id  )  const [inline, virtual]

Default implementation for CS::Utility::iModifiableDescription::FindParameter().

Definition at line 316 of file modifiableimpl.h.

virtual iModifiableDescription* CS::Utility::BaseModifiableDescription::GetChild ( size_t  index  )  const [inline, virtual]

Default implementation for CS::Utility::iModifiableDescription::GetChild().

Definition at line 344 of file modifiableimpl.h.

virtual size_t CS::Utility::BaseModifiableDescription::GetChildrenCount (  )  const [inline, virtual]

Default implementation for CS::Utility::iModifiableDescription::GetChildrenCount().

Definition at line 338 of file modifiableimpl.h.

virtual const char* CS::Utility::BaseModifiableDescription::GetLabel (  )  const [inline, virtual]

Default implementation for CS::Utility::iModifiableDescription::GetLabel().

Definition at line 273 of file modifiableimpl.h.

virtual const char* CS::Utility::BaseModifiableDescription::GetName (  )  const [inline, virtual]

Default implementation for CS::Utility::iModifiableDescription::GetName().

Definition at line 277 of file modifiableimpl.h.

virtual iModifiableParameter* CS::Utility::BaseModifiableDescription::GetParameter ( size_t  index  )  const [inline, virtual]

Default implementation for CS::Utility::iModifiableDescription::GetParameter(size_t).

Definition at line 310 of file modifiableimpl.h.

virtual iModifiableParameter* CS::Utility::BaseModifiableDescription::GetParameter ( csStringID  id  )  const [inline, virtual]

Default implementation for CS::Utility::iModifiableDescription::GetParameter(csStringID).

Definition at line 294 of file modifiableimpl.h.

virtual size_t CS::Utility::BaseModifiableDescription::GetParameterCount (  )  const [inline, virtual]

Default implementation for CS::Utility::iModifiableDescription::GetParameterCount().

Definition at line 281 of file modifiableimpl.h.

virtual size_t CS::Utility::BaseModifiableDescription::GetTotalParameterCount (  )  const [inline, virtual]

Default implementation for CS::Utility::iModifiableDescription::GetTotalParameterCount().

Definition at line 285 of file modifiableimpl.h.

void CS::Utility::BaseModifiableDescription::Push ( const char *  resource  )  [inline]

Add the given resource to the list.

Definition at line 359 of file modifiableimpl.h.

void CS::Utility::BaseModifiableDescription::Push ( BaseModifiableDescription child  )  [inline]

Add the given description to the list of children.

Definition at line 350 of file modifiableimpl.h.

void CS::Utility::BaseModifiableDescription::Push ( iModifiableParameter param  )  [inline]

Add the given parameter to the list.

Definition at line 332 of file modifiableimpl.h.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1