PG_PropertyField_Button Class Reference

#include <pgpropertyfield_button.h>

Inheritance diagram for PG_PropertyField_Button:

[legend]List of all members.

Public Types
typedef PG_Signal1< PG_PropertyField_Button * >	ButtonPropertySignal
Public Member Functions
	PG_PropertyField_Button (PG_PropertyEditor *propertyEditor, const std::string &name, const std::string &buttonname, int height=-1)
	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).
PG_Button *	GetButton ()
Public Attributes
ButtonPropertySignal	sigClick

---

Detailed Description

Author:

Martin Bickel

Button for a PG_PropertyEditor

Definition at line 42 of file pgpropertyfield_button.h.

---

Member Typedef Documentation

typedef PG_Signal1<PG_PropertyField_Button*> PG_PropertyField_Button::ButtonPropertySignal

Definition at line 52 of file pgpropertyfield_button.h.

---

Constructor & Destructor Documentation

PG_PropertyField_Button::PG_PropertyField_Button (  PG_PropertyEditor *  propertyEditor, const std::string &  name, const std::string &  buttonname, int  height = -1 )  [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 buttonname  The text that shown on the button height  The height of the line, -1 for default line height Definition at line 61 of file pgpropertyfield_button.h. References PG_NULLSTR, PG_PropertyEditor::RegisterProperty(), PG_Button::SetText(), and PG_Button::sigClick.

---

Member Function Documentation

bool PG_PropertyField_Button::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. Definition at line 71 of file pgpropertyfield_button.h.

PG_Button* PG_PropertyField_Button::GetButton (   )  [inline]

Definition at line 77 of file pgpropertyfield_button.h.

void PG_PropertyField_Button::Reload (   )  [inline, virtual]

Reloads the entry field with the current value of the referenced variable (if it exists). Implements PG_PropertyEditor::PG_PropertyEditorField. Definition at line 74 of file pgpropertyfield_button.h.

bool PG_PropertyField_Button::Valid (   )  [inline, virtual]

checks if the entered value is valid Implements PG_PropertyEditor::PG_PropertyEditorField. Definition at line 68 of file pgpropertyfield_button.h.

---

Member Data Documentation

ButtonPropertySignal PG_PropertyField_Button::sigClick

Definition at line 53 of file pgpropertyfield_button.h.

---

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

• pgpropertyfield_button.h

---