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 Member Functions

virtual ~WAbstractToggleButton ()
 Destructor.
void setText (const WString &text)
 Sets the label text.
const WString text () const
 Returns the label text.
bool isChecked () const
 Returns the button state.
void setChecked (bool checked)
 Sets the button state.
virtual void setChecked ()
 Checks the button.
virtual void setUnChecked ()
 Unchecks the button.
EventSignalchecked ()
 Signal emitted when the button gets checked.
EventSignalunChecked ()
 Signal emitted when the button gets unChecked.

Protected Member Functions

 WAbstractToggleButton (WContainerWidget *parent=0)
 Creates an unchecked toggle button without label.
 WAbstractToggleButton (const WString &text, WContainerWidget *parent=0)
 Creates an unchecked toggle button with given text label.


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.


Constructor & Destructor Documentation

Wt::WAbstractToggleButton::WAbstractToggleButton ( const WString text,
WContainerWidget parent = 0 
) [protected]

Creates an unchecked toggle button with given text label.

The text label is rendered to the right side of the button.


Member Function Documentation

void Wt::WAbstractToggleButton::setText ( const WString text  ) 

Sets the label text.

The label is rendered to the right fo the button.

const WString Wt::WAbstractToggleButton::text (  )  const

Returns the label text.

See also:
setText()

bool Wt::WAbstractToggleButton::isChecked (  )  const [inline]

Returns the button state.

See also:
setChecked()

void Wt::WAbstractToggleButton::setChecked ( bool  checked  ) 

Sets the button state.

This method does not emit one of the checked() or unChecked() signals.

See also:
setChecked(), setUnChecked()

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

Checks the button.

Does not emit the checked() signal.

See also:
setChecked(bool)

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

Unchecks the button.

Does not emit the unChecked() signal.

See also:
setChecked(bool)

EventSignal & Wt::WAbstractToggleButton::checked (  ) 

Signal emitted when the button gets checked.

This signal is emitted when the user checks the button.

You can use the changed() signal to react to any change of the button state.

EventSignal & Wt::WAbstractToggleButton::unChecked (  ) 

Signal emitted when the button gets unChecked.

This signal is emitted when the user unchecks the button.

You can use the changed() signal to react to any change of the button state.


Generated on Fri Mar 26 17:12:06 2010 for Wt by doxygen 1.5.6