Return to Index

CheckBox

Parent class: Widget

A simple toggleable check box widget.


Object Events:
ToggledThe event generated when the checkbox changes state.
Method Summary:
CheckBox::CheckBox();
void CheckBox::setLabel(const String& pLabel);
String CheckBox::getLabel();
void CheckBox::setState(bool pState);
bool CheckBox::getState();
void CheckBox::toggle();


CheckBox::CheckBox
CheckBox::CheckBox();

Constructs a new checkbox.
void CheckBox::setLabel
void CheckBox::setLabel(const String& pLabel);

Sets the text displayed on the checkbox.
Parameters:
const String& pLabelThe new checkbox label.
String CheckBox::getLabel
String CheckBox::getLabel();

Returns the checkbox's label.
void CheckBox::setState
void CheckBox::setState(bool pState);

Changes the state of the checkbox. Note that this does not generate a Toggle event.
Parameters:
bool pStateThe new state.
bool CheckBox::getState
bool CheckBox::getState();

Returns the current state of the checkbox.
void CheckBox::toggle
void CheckBox::toggle();

Changes to the opposite state. This generates a Toggled event.
Generated automatically by docgen 0.0.1
© 2003 Aron Dobos