Inheritance diagram for Exponent::GUI::Controls::CLatchingButton:
Definition at line 32 of file CLatchingButton.hpp.
Exponent::GUI::Controls::CLatchingButton::CLatchingButton | ( | IControlRoot * | root, | |
const long | uniqueId, | |||
const CRect & | area, | |||
IActionListener * | listener = NULL | |||
) |
Construction
root | The root control that this control is being added to | |
uniqueId | The unique Identifier of this control or CCONTROL_NO_ID_REQUIRED if no id is required | |
area | The area of this control relative to the root controls top left | |
listener | The action listener |
virtual Exponent::GUI::Controls::CLatchingButton::~CLatchingButton | ( | ) | [virtual] |
Destruction
virtual void Exponent::GUI::Controls::CLatchingButton::drawControl | ( | CGraphics & | graphics | ) | [virtual] |
Draw the control
graphics | The graphics context |
Reimplemented from Exponent::GUI::Controls::CControl.
virtual void Exponent::GUI::Controls::CLatchingButton::handleLeftButtonDown | ( | CMouseEvent & | event | ) | [virtual] |
Handle left button being clicked
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
virtual void Exponent::GUI::Controls::CLatchingButton::handleLeftButtonUp | ( | CMouseEvent & | event | ) | [virtual] |
Handle left button being released
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
Implemented in Exponent::GUI::Controls::CPopupButton.
virtual void Exponent::GUI::Controls::CLatchingButton::handleMouseMovement | ( | CMouseEvent & | event | ) | [virtual] |
Handle mouse movement
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
virtual bool Exponent::GUI::Controls::CLatchingButton::isOn | ( | ) | const [inline, virtual] |
Is the button on or off?
bool | True if button is on, false otheriwse |
Definition at line 70 of file CLatchingButton.hpp.
References m_state.
virtual void Exponent::GUI::Controls::CLatchingButton::setDownImage | ( | IImage * | theImage | ) | [virtual] |
Set the off image
theImage | The image to use when the button is turned off |
void Exponent::GUI::Controls::CLatchingButton::setLabelText | ( | const CString & | text | ) | [inline] |
Set the label text
text | The text to display on the button if there is no image |
Definition at line 119 of file CLatchingButton.hpp.
References m_labelText.
virtual void Exponent::GUI::Controls::CLatchingButton::setValue | ( | const double | value | ) | [virtual] |
Set the vlaue of the control
value | In range of 0 - 1 with >= 0.5 Being on |
Reimplemented from Exponent::GUI::Controls::CControl.
virtual void Exponent::GUI::Controls::CLatchingButton::useCursorChange | ( | const bool | use = true |
) | [inline, virtual] |
Should we use cursor change?
use | If true then when mouse over occurs mouse is changed to hand cursor |
Definition at line 77 of file CLatchingButton.hpp.
References m_cursorChange.
bool Exponent::GUI::Controls::CLatchingButton::m_cursorChange [protected] |
Should the cursor change
Definition at line 129 of file CLatchingButton.hpp.
Referenced by useCursorChange().
IImage* Exponent::GUI::Controls::CLatchingButton::m_downImage [protected] |
The off image
Definition at line 127 of file CLatchingButton.hpp.
CString Exponent::GUI::Controls::CLatchingButton::m_labelText [protected] |
Text drawn on the face of the button if no image is set
Definition at line 130 of file CLatchingButton.hpp.
Referenced by setLabelText().
bool Exponent::GUI::Controls::CLatchingButton::m_state [protected] |
The current state (on or off)
Definition at line 128 of file CLatchingButton.hpp.
Referenced by isOn().