Wx::CheckBox

A checkbox is a labelled box which by default is either on (checkmark is visible) or off (no checkmark). Optionally (when the CHK_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

Control

Window

EvtHandler

Object

Window styles

See also window styles overview.

Event handling

See also

RadioButton, CommandEvent

CheckBox.new

CheckBox.new(Window parent,  Integer id,  String label, 
             Point pos = DEFAULT_POSITION, 
             Size size = DEFAULT_SIZE, 
             Integer style = 0, 
             Validator val, 
             String 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 CheckBox.
• validator Window validator.
• name Window name.

See also

CheckBox#create, Validator

destructor()

Destructor, destroying the checkbox.

CheckBox#create

Boolean create(Window parent,  Integer id,  String label, 
               Point pos = DEFAULT_POSITION, 
               Size size = DEFAULT_SIZE, 
               Integer style = 0, 
               Validator val, 
               String name = "checkBox")

Creates the checkbox for two-step construction. See CheckBox.new for details.

CheckBox#get_value

Boolean get_value()

Gets the state of a 2-state checkbox.

Return value

Returns if it is checked, otherwise.

CheckBox#get_3_state_value

CheckBoxState get_3_state_value()

Gets the state of a 3-state checkbox.

Return value

Returns CHK_UNCHECKED when the checkbox is unchecked, CHK_CHECKED when it is checked and CHK_UNDETERMINED when it’s in the undetermined state. Asserts when the function is used with a 2-state checkbox.

CheckBox#is_3_rd_state_allowed_for_user

Boolean is_3_rd_state_allowed_for_user()

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

Return value

Returns if the user can set the third state of this checkbox, if it can only be set programmatically or if it’s a 2-state checkbox.

CheckBox#is_3_state

Boolean is_3_state()

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

Return value

Returns if this checkbox is a 3-state checkbox, if it’s a 2-state checkbox.

CheckBox#is_checked

Boolean is_checked()

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

CheckBox#set_value

set_value(Boolean state)

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

Parameters

• state If , the check is on, otherwise it is off.

CheckBox#set_3_state_value

set_3_state_value(CheckBoxState state)

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

Parameters

• state Can be one of: CHK_UNCHECKED (Check is off), CHK_CHECKED (Check is on) or CHK_UNDETERMINED (Check is mixed). Asserts when the checkbox is a 2-state checkbox and setting the state to CHK_UNDETERMINED.

[This page automatically generated from the Textile source at Thu May 01 00:50:34 +0100 2008]