1 \section{\class{wxCheckBox
}}\label{wxcheckbox
}
3 A checkbox is a labelled box which is either on (checkmark is visible)
6 \wxheading{Derived from
}
8 \helpref{wxControl
}{wxcontrol
}\\
9 \helpref{wxWindow
}{wxwindow
}\\
10 \helpref{wxEvtHandler
}{wxevthandler
}\\
11 \helpref{wxObject
}{wxobject
}
13 \wxheading{Window styles
}
15 There are no special styles for wxCheckBox.
17 See also
\helpref{window styles overview
}{windowstyles
}.
21 \helpref{wxRadioButton
}{wxradiobutton
}
23 \latexignore{\rtfignore{\wxheading{Members
}}}
25 \membersection{wxCheckBox::wxCheckBox
}\label{wxcheckboxconstr
}
27 \func{}{wxCheckBox
}{\void}
31 \func{}{wxCheckBox
}{\param{wxWindow*
}{parent
},
\param{const wxWindowID
}{ id
},
\rtfsp
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"
}}
36 Constructor, creating and showing a checkbox.
38 \wxheading{Parameters
}
40 \docparam{parent
}{Parent window. Must not be NULL.
}
42 \docparam{id
}{Checkbox identifier. A value of -
1 indicates a default value.
}
44 \docparam{label
}{Text to be displayed next to the checkbox.
}
46 \docparam{pos
}{Checkbox position. If the position (-
1, -
1) is specified then a default position is chosen.
}
48 \docparam{size
}{Checkbox size. If the default size (-
1, -
1) is specified then a default size is chosen.
}
50 \docparam{style
}{Window style. See
\helpref{wxCheckBox
}{wxcheckbox
}.
}
52 \docparam{validator
}{Window validator.
}
54 \docparam{name
}{Window name.
}
58 \helpref{wxCheckBox::Create
}{wxcheckboxcreate
},
\helpref{wxValidator
}{wxvalidator
}
60 \membersection{wxCheckBox::
\destruct{wxCheckBox
}}
62 \func{}{\destruct{wxCheckBox
}}{\void}
64 Destructor, destroying the checkbox.
66 \membersection{wxCheckBox::Create
}\label{wxcheckboxcreate
}
68 \func{bool
}{Create
}{\param{wxWindow*
}{parent
},
\param{const wxWindowID
}{ id
},
\rtfsp
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"
}}
73 Creates the checkbox for two-step construction. See
\helpref{wxCheckBox::wxCheckBox
}{wxcheckboxconstr
}\rtfsp
76 \membersection{wxCheckBox::GetValue
}\label{wxcheckboxgetvalue
}
78 \constfunc{bool
}{GetValue
}{\void}
80 Gets the state of the checkbox.
82 \wxheading{Return value
}
84 Returns TRUE if it is checked, FALSE otherwise.
86 \membersection{wxCheckBox::SetValue
}\label{wxcheckboxsetvalue
}
88 \func{void
}{SetValue
}{\param{const bool
}{ state
}}
90 Sets the checkbox to the given state.
92 \wxheading{Parameters
}
94 \docparam{state
}{If TRUE, the check is on, otherwise it is off.
}