X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5de76427c87d8289f5c343cef16e9375056fc49f..57c5293e49b50007e8fb19f4953d65d6aeb45293:/docs/latex/wx/checkbox.tex?ds=sidebyside diff --git a/docs/latex/wx/checkbox.tex b/docs/latex/wx/checkbox.tex index b12e416a44..673cb679fc 100644 --- a/docs/latex/wx/checkbox.tex +++ b/docs/latex/wx/checkbox.tex @@ -10,9 +10,16 @@ or off (no checkmark). \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Window styles} -There are no special styles for wxCheckBox. +\twocolwidtha{5cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{\windowstyle{wxALIGN\_RIGHT}}{Makes the text appear on the left of the checkbox.} +\end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -89,16 +96,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.}