Wt::WAbstractToggleButton Class Reference

An abstract base class for radio buttons and check boxes. More...

Inheritance diagram for Wt::WAbstractToggleButton:

Inheritance graph
[legend]

List of all members.

Public Slots

void setChecked (bool)
 Change the state of the button.
virtual void setChecked ()
 Set the button checked.
virtual void setUnChecked ()
 Set the button unChecked.

Public Member Functions

void setText (const WString &text)
 Change the text of the label.
const WString text () const
 Get the text of the label.
bool isChecked () const
 Returns the state of the button.

Public Attributes

EventSignal< void > checked
 Signal emitted when the button gets checked.
EventSignal< void > unChecked
 Signal emitted when the button gets unChecked.

Protected Member Functions

 WAbstractToggleButton (WContainerWidget *parent=0)
 Create an unchecked toggle button with empty label and optional parent.
 WAbstractToggleButton (const WString &text, WContainerWidget *parent=0)
 Create an unchecked toggle button with given text and optional parent.


Detailed Description

An abstract base class for radio buttons and check boxes.

A toggle button provides a button with a boolean state (checked or unchecked), and a text label.

To act on a change of the state, either connect a slot to the changed() signal, or connect a slot to the checked or unChecked signals.

The current state (checked or unchecked) may be inspected using the isChecked() method.

FIXME: add image functionality for the label.


Member Function Documentation

void Wt::WAbstractToggleButton::setChecked ( bool  how  )  [slot]

Change the state of the button.

Does not emit one of the checked or unChecked signals.

See also:
setChecked(), setUnChecked()

void Wt::WAbstractToggleButton::setChecked (  )  [virtual, slot]

Set the button checked.

Does not emit the checked signal.

See also:
setChecked(bool)

void Wt::WAbstractToggleButton::setUnChecked (  )  [virtual, slot]

Set the button unChecked.

Does not emit the unChecked signal.

See also:
setChecked(bool)


Generated on Mon Nov 3 15:00:58 2008 for Wt by doxygen 1.5.6