wxtogglebutton

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.

you can see wxtogglebutton in action in the sixth page of the controls sample.

derived from

wxcontrol
wxwindow
wxevthandler
wxobject

include files

window styles

there are no special styles for wxtogglebutton.

wxtogglebutton::wxtogglebutton

wxtogglebutton()

default constructor.

wxtogglebutton(wxwindow* parent, wxwindowid id, const wxstring& label, const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = 0, const wxvalidator& val, const wxstring& name = "checkbox")

constructor, creating and showing a toggle button.

parameters

parent

null

toggle button identifier. a value of -1 indicates a default value.

label

text to be displayed next to the toggle button.

pos

toggle button position. if the position (-1, -1) is specified then a default position is chosen.

size

toggle button size. if the default size (-1, -1) is specified then a default size is chosen.

style

wxtogglebutton

validator

window validator.

name

window name.

see also

wxtogglebutton::create, wxvalidator

wxtogglebutton::~wxtogglebutton

~wxtogglebutton()

destructor, destroying the toggle button.

wxtogglebutton::create

bool create(wxwindow* parent, wxwindowid id, const wxstring& label, const wxpoint& pos = wxdefaultposition, const wxsize& size = wxdefaultsize, long style = 0, const wxvalidator& val, const wxstring& name = "checkbox")

creates the toggle button for two-step construction. see wxtogglebutton::wxtogglebutton for details.

wxtogglebutton::getvalue

bool getvalue() const

gets the state of the toggle button.

return value

returns true if it is pressed, false otherwise.

wxtogglebutton::setvalue

void setvalue(const bool state)

sets the toggle button to the given state. this does not cause a evt_togglebutton event to be emitted.

parameters

state

true