X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..d30ff492f0ee23d067e996c0a5f769e4dafb0225:/docs/latex/wx/checkbox.tex diff --git a/docs/latex/wx/checkbox.tex b/docs/latex/wx/checkbox.tex index c1910aa99f..e84881d0fa 100644 --- a/docs/latex/wx/checkbox.tex +++ b/docs/latex/wx/checkbox.tex @@ -10,15 +10,27 @@ or off (no checkmark). \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Window styles} There are no special styles for wxCheckBox. See also \helpref{window styles overview}{windowstyles}. +\wxheading{Event handling} + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_CHECKBOX(id, func)}}{Process a wxEVT\_COMMAND\_CHECKBOX\_CLICKED event, +when the checkbox is clicked.} +\end{twocollist} + \wxheading{See also} -\helpref{wxRadioButton}{wxradiobutton} +\helpref{wxRadioButton}{wxradiobutton}, \helpref{wxCommandEvent}{wxcommandevent} \latexignore{\rtfignore{\wxheading{Members}}} @@ -28,7 +40,7 @@ See also \helpref{window styles overview}{windowstyles}. Default constructor. -\func{}{wxCheckBox}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp +\func{}{wxCheckBox}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp \param{const wxString\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp \param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp \param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}} @@ -65,7 +77,7 @@ Destructor, destroying the checkbox. \membersection{wxCheckBox::Create}\label{wxcheckboxcreate} -\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp +\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp \param{const wxString\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp \param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp \param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}} @@ -81,16 +93,24 @@ Gets the state of the checkbox. \wxheading{Return value} -Returns TRUE if it is checked, FALSE otherwise. +Returns {\tt TRUE} if it is checked, {\tt FALSE} otherwise. + +\membersection{wxCheckBox::IsChecked}\label{wxcheckboxischecked} + +\constfunc{bool}{IsChecked}{\void} + +This is just a maybe more readable synonym for +\helpref{GetValue}{wxcheckboxgetvalue}: just as the latter, it returns +{\tt TRUE} if the checkbox is checked and {\tt FALSE} otherwise. \membersection{wxCheckBox::SetValue}\label{wxcheckboxsetvalue} \func{void}{SetValue}{\param{const bool}{ state}} -Sets the checkbox to the given state. +Sets the checkbox to the given state. This does not cause a +wxEVT\_COMMAND\_CHECKBOX\_CLICKED event to get emitted. \wxheading{Parameters} -\docparam{state}{If TRUE, the check is on, otherwise it is off.} - +\docparam{state}{If {\tt TRUE}, the check is on, otherwise it is off.}