projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| a660d684 KB |
1 | \section{\class{wxCheckBox}}\label{wxcheckbox} |
| 2 | ||
| 3 | A checkbox is a labelled box which is either on (checkmark is visible) | |
| 4 | or off (no checkmark). | |
| 5 | ||
| 6 | \wxheading{Derived from} | |
| 7 | ||
| 8 | \helpref{wxControl}{wxcontrol}\\ | |
| 9 | \helpref{wxWindow}{wxwindow}\\ | |
| 10 | \helpref{wxEvtHandler}{wxevthandler}\\ | |
| 11 | \helpref{wxObject}{wxobject} | |
| 12 | ||
| 13 | \wxheading{Window styles} | |
| 14 | ||
| 15 | There are no special styles for wxCheckBox. | |
| 16 | ||
| 17 | See also \helpref{window styles overview}{windowstyles}. | |
| 18 | ||
| 19 | \wxheading{See also} | |
| 20 | ||
| 21 | \helpref{wxRadioButton}{wxradiobutton} | |
| 22 | ||
| 23 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 24 | ||
| 25 | \membersection{wxCheckBox::wxCheckBox}\label{wxcheckboxconstr} | |
| 26 | ||
| 27 | \func{}{wxCheckBox}{\void} | |
| 28 | ||
| 29 | Default constructor. | |
| 30 | ||
| eaaa6a06 | 31 | \func{}{wxCheckBox}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp |
| a660d684 KB |
32 | \param{const wxString\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp |
| 33 | \param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp | |
| 34 | \param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}} | |
| 35 | ||
| 36 | Constructor, creating and showing a checkbox. | |
| 37 | ||
| 38 | \wxheading{Parameters} | |
| 39 | ||
| 40 | \docparam{parent}{Parent window. Must not be NULL.} | |
| 41 | ||
| 42 | \docparam{id}{Checkbox identifier. A value of -1 indicates a default value.} | |
| 43 | ||
| 44 | \docparam{label}{Text to be displayed next to the checkbox.} | |
| 45 | ||
| 46 | \docparam{pos}{Checkbox position. If the position (-1, -1) is specified then a default position is chosen.} | |
| 47 | ||
| 48 | \docparam{size}{Checkbox size. If the default size (-1, -1) is specified then a default size is chosen.} | |
| 49 | ||
| 50 | \docparam{style}{Window style. See \helpref{wxCheckBox}{wxcheckbox}.} | |
| 51 | ||
| 52 | \docparam{validator}{Window validator.} | |
| 53 | ||
| 54 | \docparam{name}{Window name.} | |
| 55 | ||
| 56 | \wxheading{See also} | |
| 57 | ||
| 58 | \helpref{wxCheckBox::Create}{wxcheckboxcreate}, \helpref{wxValidator}{wxvalidator} | |
| 59 | ||
| 60 | \membersection{wxCheckBox::\destruct{wxCheckBox}} | |
| 61 | ||
| 62 | \func{}{\destruct{wxCheckBox}}{\void} | |
| 63 | ||
| 64 | Destructor, destroying the checkbox. | |
| 65 | ||
| 66 | \membersection{wxCheckBox::Create}\label{wxcheckboxcreate} | |
| 67 | ||
| eaaa6a06 | 68 | \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp |
| a660d684 KB |
69 | \param{const wxString\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp |
| 70 | \param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp | |
| 71 | \param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}} | |
| 72 | ||
| 73 | Creates the checkbox for two-step construction. See \helpref{wxCheckBox::wxCheckBox}{wxcheckboxconstr}\rtfsp | |
| 74 | for details. | |
| 75 | ||
| 76 | \membersection{wxCheckBox::GetValue}\label{wxcheckboxgetvalue} | |
| 77 | ||
| 78 | \constfunc{bool}{GetValue}{\void} | |
| 79 | ||
| 80 | Gets the state of the checkbox. | |
| 81 | ||
| 82 | \wxheading{Return value} | |
| 83 | ||
| 84 | Returns TRUE if it is checked, FALSE otherwise. | |
| 85 | ||
| 86 | \membersection{wxCheckBox::SetValue}\label{wxcheckboxsetvalue} | |
| 87 | ||
| 88 | \func{void}{SetValue}{\param{const bool}{ state}} | |
| 89 | ||
| 90 | Sets the checkbox to the given state. | |
| 91 | ||
| 92 | \wxheading{Parameters} | |
| 93 | ||
| 94 | \docparam{state}{If TRUE, the check is on, otherwise it is off.} | |
| 95 | ||
| 96 |