Functions for wxToggleButton class

wxToggleButton is a button that stays pressed when clicked by the user. In other words, it is similar to wxCheckBox in functionality but looks like a wxButton.

Since wxWidgets version 2.9.0 this control emits an update UI event.

You can see wxToggleButton in action in page_samples_widgets.

See: wxCheckBox, wxButton, wxBitmapToggleButton (not implemented in wx)

This class is derived (and can use functions) from: wxControl wxWindow wxEvtHandler

wxWidgets docs: wxToggleButton

Event types emitted from this class: command_togglebutton_clicked

Destructor, destroying the toggle button.


Gets the state of the toggle button.

Return: Returns true if it is pressed, false otherwise.


State = boolean()

Sets the toggle button to the given state.

This does not cause a EVT_TOGGLEBUTTON event to be emitted.