wxCheckBox

wxCheckBox

wxCheckBox
Functions for wxCheckBox class

A checkbox is a labelled box which by default is either on (checkmark is visible) or off (no checkmark). Optionally (when the wxCHK_3STATE style flag is set) it can have a third state, called the mixed or undetermined state. Often this is used as a "Does Not Apply" state.

Styles

This class supports the following styles:

See: wxRadioButton, wxCommandEvent

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

wxWidgets docs: wxCheckBox

Event types emitted from this class: command_checkbox_clicked

Destructor, destroying the checkbox.

Types

Gets the state of a 2-state checkbox.

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

Types

Gets the state of a 3-state checkbox.

Asserts when the function is used with a 2-state checkbox.

Types

Returns whether or not the user can set the checkbox to the third state.

Return: true if the user can set the third state of this checkbox, false if it can only be set programmatically or if it's a 2-state checkbox.

Types

Returns whether or not the checkbox is a 3-state checkbox.

Return: true if this checkbox is a 3-state checkbox, false if it's a 2-state checkbox.

Types

This is just a maybe more readable synonym for getValue/1: just as the latter, it returns true if the checkbox is checked and false otherwise.

Types

State = boolean()

Sets the checkbox to the given state.

This does not cause a wxEVT_CHECKBOX event to get emitted.

Types

State = wx:wx_enum()

Sets the checkbox to the given state.

This does not cause a wxEVT_CHECKBOX event to get emitted.

Asserts when the checkbox is a 2-state checkbox and setting the state to wxCHK_UNDETERMINED.