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

dtpf::TextParameter Class Reference

#include <Parameter.h>

Inheritance diagram for dtpf::TextParameter:

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

Detailed Description

TextParameter is a StringParameter with values that can be single or multiple line text strings.


Public Member Functions

 TextParameter (const muscle::String &name, const T &value, const T &default)
 Construct a TextParameter with the given name, and initial and default values.
virtual ~TextParameter ()
 Destroy a TextParameter.
virtual void SetValue (const T &value)
 Set the parameter string.
void SetIsSingleLine (bool isSingleLine)
 Set the parameter to be single line or not.
bool GetIsSingleLine () const
 Find out if the parameter is set to be single line or not.
virtual void SetUIType (ParameterUIType uiType)
 Set the UI type to one comaptible with a text parameter.

Protected Attributes

bool m_isSingleLine
 Indicates if the parameter is set to single line or not.


Constructor & Destructor Documentation

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

Construct a TextParameter with the given name, and initial and default values.

By default TextParameters are single line.

Parameters:
name The name of the parameter.
value The initial parameter string.
default The default parameter string.

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

Destroy a TextParameter.


Member Function Documentation

bool dtpf::TextParameter::GetIsSingleLine  )  const [inline]
 

Find out if the parameter is set to be single line or not.

Returns:
true if the parameter is set to single line.

void dtpf::TextParameter::SetIsSingleLine bool  isSingleLine  )  [inline]
 

Set the parameter to be single line or not.

Parameters:
isSingleLine true if the parameter is to be single line.

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

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

Parameters:
uiType The new ParameterUIType.

Implements dtpf::Parameter.

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

Set the parameter string.

The value will not be set if the parameter is set to single line and the new value contains any newline characters.

Parameters:
value The new parameter string.

Reimplemented from dtpf::SpecificParameter.


Member Data Documentation

bool dtpf::TextParameter::m_isSingleLine [protected]
 

Indicates if the parameter is set to single line 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