X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5de76427c87d8289f5c343cef16e9375056fc49f..552861bf308cf2fd12f786a5443d379b55f63d81:/docs/latex/wx/checkbox.tex diff --git a/docs/latex/wx/checkbox.tex b/docs/latex/wx/checkbox.tex index b12e416a44..e84881d0fa 100644 --- a/docs/latex/wx/checkbox.tex +++ b/docs/latex/wx/checkbox.tex @@ -10,6 +10,10 @@ or off (no checkmark). \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Window styles} There are no special styles for wxCheckBox. @@ -89,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.}