1\section{\class{wxCheckBox}}\label{wxcheckbox} 2 3A checkbox is a labelled box which by default is either on (checkmark is 4visible) or off (no checkmark). Optionally (when the wxCHK\_3STATE style flag 5is set) it can have a third state, called the mixed or undetermined state. 6Often this is used as a "Does Not Apply" state. 7 8\wxheading{Derived from} 9 10\helpref{wxControl}{wxcontrol}\\ 11\helpref{wxWindow}{wxwindow}\\ 12\helpref{wxEvtHandler}{wxevthandler}\\ 13\helpref{wxObject}{wxobject} 14 15\wxheading{Include files} 16 17<wx/checkbox.h> 18 19\wxheading{Window styles} 20 21\twocolwidtha{7cm} 22\begin{twocollist}\itemsep=0pt 23\twocolitem{\windowstyle{wxCHK\_2STATE}}{Create a 2-state checkbox. This is the default.} 24\twocolitem{\windowstyle{wxCHK\_3STATE}}{Create a 3-state checkbox. 25Not implemented in wxMGL, wxOS2 and wxGTK built against GTK+ 1.2.} 26\twocolitem{\windowstyle{wxCHK\_ALLOW\_3RD\_STATE\_FOR\_USER}}{By default a user can't set a 3-state checkbox 27to 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. } 28\twocolitem{\windowstyle{wxALIGN\_RIGHT}}{Makes the text appear on the left of the checkbox.} 29\end{twocollist} 30 31See also \helpref{window styles overview}{windowstyles}. 32 33\wxheading{Event handling} 34 35\twocolwidtha{7cm} 36\begin{twocollist}\itemsep=0pt 37\twocolitem{{\bf EVT\_CHECKBOX(id, func)}}{Process a wxEVT\_COMMAND\_CHECKBOX\_CLICKED event, 38when the checkbox is clicked.} 39\end{twocollist} 40 41\wxheading{See also} 42 43\helpref{wxRadioButton}{wxradiobutton}, \helpref{wxCommandEvent}{wxcommandevent} 44 45\latexignore{\rtfignore{\wxheading{Members}}} 46 47\membersection{wxCheckBox::wxCheckBox}\label{wxcheckboxctor} 48 49\func{}{wxCheckBox}{\void} 50 51Default constructor. 52 53\func{}{wxCheckBox}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp 54\param{const wxString\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp 55\param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp 56\param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}} 57 58Constructor, creating and showing a checkbox. 59 60\wxheading{Parameters} 61 62\docparam{parent}{Parent window. Must not be NULL.} 63 64\docparam{id}{Checkbox identifier. A value of -1 indicates a default value.} 65 66\docparam{label}{Text to be displayed next to the checkbox.} 67 68\docparam{pos}{Checkbox position. If the position (-1, -1) is specified then a default position is chosen.} 69 70\docparam{size}{Checkbox size. If the default size (-1, -1) is specified then a default size is chosen.} 71 72\docparam{style}{Window style. See \helpref{wxCheckBox}{wxcheckbox}.} 73 74\docparam{validator}{Window validator.} 75 76\docparam{name}{Window name.} 77 78\wxheading{See also} 79 80\helpref{wxCheckBox::Create}{wxcheckboxcreate}, \helpref{wxValidator}{wxvalidator} 81 82\membersection{wxCheckBox::\destruct{wxCheckBox}}\label{wxcheckboxdtor} 83 84\func{}{\destruct{wxCheckBox}}{\void} 85 86Destructor, destroying the checkbox. 87 88\membersection{wxCheckBox::Create}\label{wxcheckboxcreate} 89 90\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp 91\param{const wxString\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp 92\param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp 93\param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}} 94 95Creates the checkbox for two-step construction. See \helpref{wxCheckBox::wxCheckBox}{wxcheckboxctor}\rtfsp 96for details. 97 98\membersection{wxCheckBox::GetValue}\label{wxcheckboxgetvalue} 99 100\constfunc{bool}{GetValue}{\void} 101 102Gets the state of a 2-state checkbox. 103 104\wxheading{Return value} 105 106Returns \true if it is checked, \false otherwise. 107 108\membersection{wxCheckBox::Get3StateValue}\label{wxcheckboxgetthreestatevalue} 109 110\constfunc{wxCheckBoxState}{Get3StateValue}{\void} 111 112Gets the state of a 3-state checkbox. 113 114\wxheading{Return value} 115 116Returns wxCHK\_UNCHECKED when the checkbox is unchecked, wxCHK\_CHECKED 117 when it is checked and wxCHK\_UNDETERMINED when it's in the undetermined 118state. Asserts when the function is used with a 2-state checkbox. 119 120\membersection{wxCheckBox::Is3rdStateAllowedForUser}\label{wxcheckboxis3rdstateallowedforuser} 121 122\constfunc{bool}{Is3rdStateAllowedForUser}{\void} 123 124Returns whether or not the user can set the checkbox to the third state. 125 126\wxheading{Return value} 127 128Returns \true if the user can set the third state of this checkbox, \false if it can only be set 129programmatically or if it's a 2-state checkbox. 130 131\membersection{wxCheckBox::Is3State}\label{wxcheckboxis3state} 132 133\constfunc{bool}{Is3State}{\void} 134 135Returns whether or not the checkbox is a 3-state checkbox. 136 137\wxheading{Return value} 138 139Returns \true if this checkbox is a 3-state checkbox, \false if it's a 2-state checkbox. 140 141\membersection{wxCheckBox::IsChecked}\label{wxcheckboxischecked} 142 143\constfunc{bool}{IsChecked}{\void} 144 145This is just a maybe more readable synonym for 146\helpref{GetValue}{wxcheckboxgetvalue}: just as the latter, it returns 147\true if the checkbox is checked and \false otherwise. 148 149\membersection{wxCheckBox::SetValue}\label{wxcheckboxsetvalue} 150 151\func{void}{SetValue}{\param{bool}{ state}} 152 153Sets the checkbox to the given state. This does not cause a 154wxEVT\_COMMAND\_CHECKBOX\_CLICKED event to get emitted. 155 156\wxheading{Parameters} 157 158\docparam{state}{If \true, the check is on, otherwise it is off.} 159 160\membersection{wxCheckBox::Set3StateValue}\label{wxcheckboxset3statevalue} 161 162\func{void}{Set3StateValue}{\param{const wxCheckBoxState}{ state}} 163 164Sets the checkbox to the given state. This does not cause a 165wxEVT\_COMMAND\_CHECKBOX\_CLICKED event to get emitted. 166 167\wxheading{Parameters} 168 169\docparam{state}{Can be one of: wxCHK\_UNCHECKED (Check is off), wxCHK\_CHECKED 170 (Check is on) or wxCHK\_UNDETERMINED (Check is mixed). Asserts when the checkbox 171 is a 2-state checkbox and setting the state to wxCHK\_UNDETERMINED.} 172