]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/checkbox.tex
fixed typos which resulted in 2 broken links
[wxWidgets.git] / docs / latex / wx / checkbox.tex
index c1910aa99f1a55249ccbd0dc8e59b2a20d945961..673cb679fc1cb4f47ed52b66820da74f5cd4e36b 100644 (file)
@@ -10,15 +10,30 @@ or off (no checkmark).
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/checkbox.h>
+
 \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}.
 
+\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 +43,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 +80,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 +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.}