View Source wxCheckBox (wx v2.4.2)

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

Events

Event types emitted from this class: command_checkbox_clicked

Summary

Functions

Creates the checkbox for two-step construction.

Destructor, destroying the checkbox.

Gets the state of a 3-state checkbox.

Gets the state of a 2-state checkbox.

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

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

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.

Default constructor.

Constructor, creating and showing a checkbox.

Sets the checkbox to the given state.

Sets the checkbox to the given state.

Types

-type wxCheckBox() :: wx:wx_object().

Functions

Link to this function

create(This, Parent, Id, Label)

View Source
-spec create(This, Parent, Id, Label) -> boolean()
          when
              This :: wxCheckBox(),
              Parent :: wxWindow:wxWindow(),
              Id :: integer(),
              Label :: unicode:chardata().
-spec create(This, Parent, Id, Label, [Option]) -> boolean()
          when
              This :: wxCheckBox(),
              Parent :: wxWindow:wxWindow(),
              Id :: integer(),
              Label :: unicode:chardata(),
              Option ::
                  {pos, {X :: integer(), Y :: integer()}} |
                  {size, {W :: integer(), H :: integer()}} |
                  {style, integer()} |
                  {validator, wx:wx_object()}.

Creates the checkbox for two-step construction.

See new/4 for details.

-spec destroy(This :: wxCheckBox()) -> ok.

Destructor, destroying the checkbox.

-spec get3StateValue(This) -> wx:wx_enum() when This :: wxCheckBox().

Gets the state of a 3-state checkbox.

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

-spec getValue(This) -> boolean() when This :: wxCheckBox().

Gets the state of a 2-state checkbox.

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

Link to this function

is3rdStateAllowedForUser(This)

View Source
-spec is3rdStateAllowedForUser(This) -> boolean() when This :: wxCheckBox().

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.

-spec is3State(This) -> boolean() when This :: wxCheckBox().

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.

-spec isChecked(This) -> boolean() when This :: wxCheckBox().

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.

-spec new() -> wxCheckBox().

Default constructor.

See: create/5, wxValidator (not implemented in wx)

-spec new(Parent, Id, Label) -> wxCheckBox()
       when Parent :: wxWindow:wxWindow(), Id :: integer(), Label :: unicode:chardata().
-spec new(Parent, Id, Label, [Option]) -> wxCheckBox()
       when
           Parent :: wxWindow:wxWindow(),
           Id :: integer(),
           Label :: unicode:chardata(),
           Option ::
               {pos, {X :: integer(), Y :: integer()}} |
               {size, {W :: integer(), H :: integer()}} |
               {style, integer()} |
               {validator, wx:wx_object()}.

Constructor, creating and showing a checkbox.

See: create/5, wxValidator (not implemented in wx)

Link to this function

set3StateValue(This, State)

View Source
-spec set3StateValue(This, State) -> ok when This :: wxCheckBox(), 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.

-spec setValue(This, State) -> ok when This :: wxCheckBox(), State :: boolean().

Sets the checkbox to the given state.

This does not cause a wxEVT_CHECKBOX event to get emitted.