]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/checkbox.tex
rename UpdatePulse() to Pulse() (forgot to commit with the rest of the changes)
[wxWidgets.git] / docs / latex / wx / checkbox.tex
index a47d108e16c13882c253ddd1682487d62031eb0f..0e80714609d8738d46594661b332b42a48b9e607 100644 (file)
@@ -1,8 +1,9 @@
 \section{\class{wxCheckBox}}\label{wxcheckbox}
 
 \section{\class{wxCheckBox}}\label{wxcheckbox}
 
-A checkbox is a labelled box which by default is either on (checkmark is visible)
-or off (no checkmark). Optionally (When the wxCHK_3STATE style flag is set) it can have
-a third state, called the mixed or undetermined state. Often this is used as a "Does Not Apply" state.
+A checkbox is a labelled box which by default is either on (checkmark is
+visible) or off (no checkmark). Optionally (when the wxCHK\_3STATE style flag
+is set) it can have a third state, called the mixed or undetermined state.
+Often this is used as a "Does Not Apply" state.
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 
@@ -19,8 +20,9 @@ a third state, called the mixed or undetermined state. Often this is used as a "
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{\windowstyle{wxCHK\_2STATE}}{Create a 2-state checkbox (This is the default).}
-\twocolitem{\windowstyle{wxCHK\_3STATE}}{Create a 3-state checkbox.}
+\twocolitem{\windowstyle{wxCHK\_2STATE}}{Create a 2-state checkbox. This is the default.}
+\twocolitem{\windowstyle{wxCHK\_3STATE}}{Create a 3-state checkbox.
+Not implemented in wxMGL, wxOS2 and wxGTK built against GTK+ 1.2.}
 \twocolitem{\windowstyle{wxCHK\_ALLOW\_3RD\_STATE\_FOR\_USER}}{By default a user can't set a 3-state checkbox
 to the third state. It can only be done from code. Using this flags allows the user to set the checkbox to the third state by clicking. }
 \twocolitem{\windowstyle{wxALIGN\_RIGHT}}{Makes the text appear on the left of the checkbox.}
 \twocolitem{\windowstyle{wxCHK\_ALLOW\_3RD\_STATE\_FOR\_USER}}{By default a user can't set a 3-state checkbox
 to the third state. It can only be done from code. Using this flags allows the user to set the checkbox to the third state by clicking. }
 \twocolitem{\windowstyle{wxALIGN\_RIGHT}}{Makes the text appear on the left of the checkbox.}
@@ -42,7 +44,7 @@ when the checkbox is clicked.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxCheckBox::wxCheckBox}\label{wxcheckboxconstr}
+\membersection{wxCheckBox::wxCheckBox}\label{wxcheckboxctor}
 
 \func{}{wxCheckBox}{\void}
 
 
 \func{}{wxCheckBox}{\void}
 
@@ -77,7 +79,7 @@ Constructor, creating and showing a checkbox.
 
 \helpref{wxCheckBox::Create}{wxcheckboxcreate}, \helpref{wxValidator}{wxvalidator}
 
 
 \helpref{wxCheckBox::Create}{wxcheckboxcreate}, \helpref{wxValidator}{wxvalidator}
 
-\membersection{wxCheckBox::\destruct{wxCheckBox}}
+\membersection{wxCheckBox::\destruct{wxCheckBox}}\label{wxcheckboxdtor}
 
 \func{}{\destruct{wxCheckBox}}{\void}
 
 
 \func{}{\destruct{wxCheckBox}}{\void}
 
@@ -90,7 +92,7 @@ Destructor, destroying the checkbox.
 \param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp
 \param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}}
 
 \param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp
 \param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}}
 
-Creates the checkbox for two-step construction. See \helpref{wxCheckBox::wxCheckBox}{wxcheckboxconstr}\rtfsp
+Creates the checkbox for two-step construction. See \helpref{wxCheckBox::wxCheckBox}{wxcheckboxctor}\rtfsp
 for details.
 
 \membersection{wxCheckBox::GetValue}\label{wxcheckboxgetvalue}
 for details.
 
 \membersection{wxCheckBox::GetValue}\label{wxcheckboxgetvalue}
@@ -146,7 +148,7 @@ This is just a maybe more readable synonym for
 
 \membersection{wxCheckBox::SetValue}\label{wxcheckboxsetvalue}
 
 
 \membersection{wxCheckBox::SetValue}\label{wxcheckboxsetvalue}
 
-\func{void}{SetValue}{\param{const bool}{ state}}
+\func{void}{SetValue}{\param{bool}{ state}}
 
 Sets the checkbox to the given state. This does not cause a
 wxEVT\_COMMAND\_CHECKBOX\_CLICKED event to get emitted.
 
 Sets the checkbox to the given state. This does not cause a
 wxEVT\_COMMAND\_CHECKBOX\_CLICKED event to get emitted.