Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

dtpf::GroupParameter Class Reference

#include <Parameter.h>

Inheritance diagram for dtpf::GroupParameter:

dtpf::SpecificParameter dtpf::Parameter dtpf::ParameterTreeVertex List of all members.

Detailed Description

GroupParameter is a SpecificParameter whose value can be is a selection from a group of items.


Public Member Functions

 GroupParameter (const muscle::String &name, const T &default)
 Construct an OnOffParmeter with the given name and default value.
virtual ~GroupParameter ()
 Destroy a GroupParameter.
virtual void SetValue (const T &value)
 Set the value to one of the items in the group.
void AddItem (const muscle::String label, const T &item)
 Add another item to the group.
void RemoveItem (const muscle::String &name)
 Remove an item from the group.
void RemoveItem (const T &item)
 Remove an item from the group.
void SetIsSingleSelection (bool singleSelection)
 Set the group parameter to be single selection or not.
bool GetIsSingleSelection () const
 Find out if the group parameter is single selection of not.
virtual void SetUIType (ParameterUIType uiType)
 Set the UI type to one comaptible with a group parameter.

Protected Attributes

bool m_singleSelection
 Indicates whether the group parameter is single selection or not.


Constructor & Destructor Documentation

dtpf::GroupParameter::GroupParameter const muscle::String &  name,
const T &  default
[inline]
 

Construct an OnOffParmeter with the given name and default value.

Parameters:
name The name of the parameter.
default THe default parameter value.

virtual dtpf::GroupParameter::~GroupParameter  )  [inline, virtual]
 

Destroy a GroupParameter.


Member Function Documentation

void dtpf::GroupParameter::AddItem const muscle::String  label,
const T &  item
[inline]
 

Add another item to the group.

Parameters:
label The UI text label display for the item.
item The item to add to the group.

bool dtpf::GroupParameter::GetIsSingleSelection  )  const [inline]
 

Find out if the group parameter is single selection of not.

Returns:
true if the group parameter is single selection.

void dtpf::GroupParameter::RemoveItem const T &  item  )  [inline]
 

Remove an item from the group.

Parameters:
item The item to remove.

void dtpf::GroupParameter::RemoveItem const muscle::String &  name  )  [inline]
 

Remove an item from the group.

Parameters:
name The name of the item to remove.

void dtpf::GroupParameter::SetIsSingleSelection bool  singleSelection  )  [inline]
 

Set the group parameter to be single selection or not.

Parameters:
singleSelection Set to true if the group is to be made single selection.

virtual void dtpf::GroupParameter::SetUIType ParameterUIType  uiType  )  [inline, virtual]
 

Set the UI type to one comaptible with a group parameter.

Parameters:
uiType The new ParameterUIType.

Implements dtpf::Parameter.

virtual void dtpf::GroupParameter::SetValue const T &  value  )  [inline, virtual]
 

Set the value to one of the items in the group.

Parameters:
value The new value.

Reimplemented from dtpf::SpecificParameter.


Member Data Documentation

bool dtpf::GroupParameter::m_singleSelection [protected]
 

Indicates whether the group parameter is single selection or not.


The documentation for this class was generated from the following file:
Generated on Wed Aug 3 07:26:19 2005 for DTPF by  doxygen 1.3.9.1