wxCheckBox

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.

Derived from

wxControl
wxWindow
wxEvtHandler
wxObject

Include files

<wx/checkbox.h>

Window styles

See also window styles overview.

Event handling

See also

wxRadioButton, wxCommandEvent

Members

wxCheckBox::wxCheckBox
wxCheckBox::~wxCheckBox
wxCheckBox::Create
wxCheckBox::GetValue
wxCheckBox::Get3StateValue
wxCheckBox::Is3rdStateAllowedForUser
wxCheckBox::Is3State
wxCheckBox::IsChecked
wxCheckBox::SetValue
wxCheckBox::Set3StateValue

wxCheckBox::wxCheckBox

wxCheckBox()

Default constructor.

wxCheckBox(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 checkbox.

Parameters

parent

Parent window. Must not be NULL.

id

Checkbox identifier. A value of -1 indicates a default value.

label

Text to be displayed next to the checkbox.

pos

Checkbox position. If the position (-1, -1) is specified then a default position is chosen.

size

Checkbox size. If the default size (-1, -1) is specified then a default size is chosen.

style

Window style. See wxCheckBox.

validator

Window validator.

name

Window name.

See also

wxCheckBox::Create, wxValidator

wxCheckBox::~wxCheckBox

~wxCheckBox()

Destructor, destroying the checkbox.

wxCheckBox::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 checkbox for two-step construction. See wxCheckBox::wxCheckBox for details.

wxCheckBox::GetValue

bool GetValue() const

Gets the state of a 2-state checkbox.

Return value

Returns true if it is checked, false otherwise.

wxCheckBox::Get3StateValue

wxCheckBoxState Get3StateValue() const

Gets the state of a 3-state checkbox.

Return value

Returns wxCHK_UNCHECKED when the checkbox is unchecked, wxCHK_CHECKED when it is checked and wxCHK_UNDETERMINED when it's in the undetermined state. Asserts when the function is used with a 2-state checkbox.

wxCheckBox::Is3rdStateAllowedForUser

bool Is3rdStateAllowedForUser() const

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

Return value

Returns 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.

wxCheckBox::Is3State

bool Is3State() const

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

Return value

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

wxCheckBox::IsChecked

bool IsChecked() const

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

wxCheckBox::SetValue

void SetValue(bool state)

Sets the checkbox to the given state. This does not cause a wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.

Parameters

state

If true, the check is on, otherwise it is off.

wxCheckBox::Set3StateValue

void Set3StateValue(const wxCheckBoxState state)

Sets the checkbox to the given state. This does not cause a wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.

Parameters

state

Can be one of: wxCHK_UNCHECKED (Check is off), wxCHK_CHECKED (Check is on) or wxCHK_UNDETERMINED (Check is mixed). Asserts when the checkbox is a 2-state checkbox and setting the state to wxCHK_UNDETERMINED.