Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Examples

PG_PropertyField_Checkbox< B > Class Template Reference

Inheritance diagram for PG_PropertyField_Checkbox< B >:

Inheritance graph
[legend]
Collaboration diagram for PG_PropertyField_Checkbox< B >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<typename B>
class PG_PropertyField_Checkbox< B >

Author:
Martin Bickel
Checkbox for a PG_PropertyEditor
Examples:

paratest.cpp.


Public Types

typedef PG_Signal2< PG_PropertyField_Checkbox *,
B > 		CheckboxPropertySignal

Public Member Functions

 PG_PropertyField_Checkbox (PG_PropertyEditor *propertyEditor, const std::string &name, B *b, bool inverted=false)
 Creates a PG_PropertyField_Checkbox.
 PG_PropertyField_Checkbox (PG_PropertyEditor *propertyEditor, const std::string &name, const B &b, bool inverted=false)
 Creates a PG_PropertyField_Checkbox.
bool Valid ()
 checks if the entered value is valid
bool Apply ()
 Write the entered value back into the referenced variable (if it exists), provided the value is valid.
void Reload ()
 Reloads the entry field with the current value of the referenced variable (if it exists).

Public Attributes

CheckboxPropertySignal sigValueChanged
CheckboxPropertySignal sigValueApplied

Member Typedef Documentation

template<typename B>
typedef PG_Signal2<PG_PropertyField_Checkbox*, B> PG_PropertyField_Checkbox< B >::CheckboxPropertySignal
 

Constructor & Destructor Documentation

template<typename B>
PG_PropertyField_Checkbox< B >::PG_PropertyField_Checkbox (  PG_PropertyEditor *  propertyEditor,
const std::string &  name,
B *  b,
bool  inverted = false
)  [inline]
 

Creates a PG_PropertyField_Checkbox.

Parameters:
propertyEditor The PG_PropertyEditor for which the PropertyField shall be registered for
name The label shown for the PropertyField
b The variable that is edited. Make sure the variable exists for the whole lifetime of the PG_PropertyEditor
inverted If set the checkbox will be ticked on false and not ticked on true

template<typename B>
PG_PropertyField_Checkbox< B >::PG_PropertyField_Checkbox (  PG_PropertyEditor *  propertyEditor,
const std::string &  name,
const B &  b,
bool  inverted = false
)  [inline]
 

Creates a PG_PropertyField_Checkbox.

Parameters:
propertyEditor The PG_PropertyEditor for which the PropertyField shall be registered for
name The label shown for the PropertyField
b The initial value.
inverted If set the checkbox will be ticked on false and not ticked on true

Member Function Documentation

template<typename B>
bool PG_PropertyField_Checkbox< B >::Apply (   )  [inline, virtual]
 

Write the entered value back into the referenced variable (if it exists), provided the value is valid.

Returns:
false if the value is not valid

Implements PG_PropertyEditor::PG_PropertyEditorField.

template<typename B>
void PG_PropertyField_Checkbox< B >::Reload (   )  [inline, virtual]
 

Reloads the entry field with the current value of the referenced variable (if it exists).

Implements PG_PropertyEditor::PG_PropertyEditorField.

template<typename B>
bool PG_PropertyField_Checkbox< B >::Valid (   )  [inline, virtual]
 

checks if the entered value is valid

Implements PG_PropertyEditor::PG_PropertyEditorField.

Member Data Documentation

template<typename B>
CheckboxPropertySignal PG_PropertyField_Checkbox< B >::sigValueApplied
 

template<typename B>
CheckboxPropertySignal PG_PropertyField_Checkbox< B >::sigValueChanged
 


The ParaGUI Project - Alexander Pipelka