state. Often this is used as a "Does Not Apply" state.
@beginStyleTable
- @style{wxCHK_2STATE}:
+ @style{wxCHK_2STATE}
Create a 2-state checkbox. This is the default.
- @style{wxCHK_3STATE}:
+ @style{wxCHK_3STATE}
Create a 3-state checkbox. Not implemented in wxMGL, wxOS2 and
wxGTK built against GTK+ 1.2.
- @style{wxCHK_ALLOW_3RD_STATE_FOR_USER}:
+ @style{wxCHK_ALLOW_3RD_STATE_FOR_USER}
By default a user can't set a 3-state checkbox to the third state.
It can only be done from code. Using this flags allows the user to
set the checkbox to the third state by clicking.
- @style{wxALIGN_RIGHT}:
+ @style{wxALIGN_RIGHT}
Makes the text appear on the left of the checkbox.
@endStyleTable
@beginEventTable{wxCommandEvent}
- @event{EVT_CHECKBOX(id, func)}:
+ @event{EVT_CHECKBOX(id, func)}
Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox
is clicked.
@endEventTable
/**
Gets the state of a 2-state checkbox.
- @returns Returns @true if it is checked, @false otherwise.
+ @return Returns @true if it is checked, @false otherwise.
*/
bool GetValue() const;
/**
Returns whether or not the checkbox is a 3-state checkbox.
- @returns Returns @true if this checkbox is a 3-state checkbox, @false
- if it's a 2-state checkbox.
+ @return @true if this checkbox is a 3-state checkbox, @false if it's
+ a 2-state checkbox.
*/
bool Is3State() const;
Returns whether or not the user can set the checkbox to the third
state.
- @returns 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.
+ @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.
*/
bool Is3rdStateAllowedForUser() const;