]>
git.saurik.com Git - wxWidgets.git/blob - interface/checkbox.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxCheckBox
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
13 A checkbox is a labelled box which by default is either on (checkmark is
14 visible) or off (no checkmark). Optionally (when the wxCHK_3STATE style flag
15 is set) it can have a third state, called the mixed or undetermined state.
16 Often this is used as a "Does Not Apply" state.
20 Create a 2-state checkbox. This is the default.
22 Create a 3-state checkbox. Not implemented in wxMGL, wxOS2 and
23 wxGTK built against GTK+ 1.2.
24 @style{wxCHK_ALLOW_3RD_STATE_FOR_USER}:
25 By default a user can't set a 3-state checkbox to the third state.
26 It can only be done from code. Using this flags allows the user to
27 set the checkbox to the third state by clicking.
28 @style{wxALIGN_RIGHT}:
29 Makes the text appear on the left of the checkbox.
33 @event{EVT_CHECKBOX(id, func)}:
34 Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox
40 @appearance{checkbox.png}
42 @see wxRadioButton, wxCommandEvent
44 class wxCheckBox
: public wxControl
49 Constructor, creating and showing a checkbox.
52 Parent window. Must not be @NULL.
54 Checkbox identifier. The value wxID_ANY indicates a default value.
56 Text to be displayed next to the checkbox.
58 Checkbox position. If wxDefaultPosition is specified then a default
61 Checkbox size. If wxDefaultSize is specified then a default
64 Window style. See wxCheckBox.
70 @see Create(), wxValidator
73 wxCheckBox(wxWindow
* parent
, wxWindowID id
,
74 const wxString
& label
,
75 const wxPoint
& pos
= wxDefaultPosition
,
76 const wxSize
& size
= wxDefaultSize
,
78 const wxValidator
& val
,
79 const wxString
& name
= "checkBox");
83 Destructor, destroying the checkbox.
88 Creates the checkbox for two-step construction. See wxCheckBox()
91 bool Create(wxWindow
* parent
, wxWindowID id
,
92 const wxString
& label
,
93 const wxPoint
& pos
= wxDefaultPosition
,
94 const wxSize
& size
= wxDefaultSize
,
96 const wxValidator
& val
,
97 const wxString
& name
= "checkBox");
100 Gets the state of a 3-state checkbox.
102 @returns Returns wxCHK_UNCHECKED when the checkbox is unchecked,
103 wxCHK_CHECKED when it is checked and
104 wxCHK_UNDETERMINED when it's in the undetermined state.
105 Asserts when the function is used with a 2-state
108 wxCheckBoxState
Get3StateValue() const;
111 Gets the state of a 2-state checkbox.
113 @returns Returns @true if it is checked, @false otherwise.
115 bool GetValue() const;
118 Returns whether or not the checkbox is a 3-state checkbox.
120 @returns Returns @true if this checkbox is a 3-state checkbox, @false if
121 it's a 2-state checkbox.
123 bool Is3State() const;
126 Returns whether or not the user can set the checkbox to the third state.
128 @returns Returns @true if the user can set the third state of this
129 checkbox, @false if it can only be set programmatically
130 or if it's a 2-state checkbox.
132 bool Is3rdStateAllowedForUser() const;
135 This is just a maybe more readable synonym for
136 GetValue(): just as the latter, it returns
137 @true if the checkbox is checked and @false otherwise.
139 bool IsChecked() const;
142 Sets the checkbox to the given state. This does not cause a
143 wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.
146 If @true, the check is on, otherwise it is off.
148 void SetValue(bool state
);