]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/tglbtn.tex
use wxChar correctly in wxString docs; mark wx1 compatibility functions
[wxWidgets.git] / docs / latex / wx / tglbtn.tex
index 78e059361bf66313f5a122aa157d04b516798da6..78b0413f6a440ae093371eddc30d37d545c56c65 100644 (file)
 
 \section{\class{wxToggleButton}}\label{wxtogglebutton}
 
-wxToggleButton is a button which stays pressed when clicked by the user. In
-other words, it is more similar to \helpref{wxCheckBox}{wxcheckbox} in
+wxToggleButton is a button that stays pressed when clicked by the user. In
+other words, it is similar to \helpref{wxCheckBox}{wxcheckbox} in
 functionality but looks like a \helpref{wxButton}{wxbutton}.
 
-You can see wxToggleButton in action in the sixth page of the 
+You can see wxToggleButton in action in the sixth page of the
 \helpref{controls}{samplecontrols} sample.
 
-{\bf NB: } This class is only available under wxMSW and wxGTK currently.
-
 \wxheading{Derived from}
 
 \helpref{wxControl}{wxcontrol}\\
@@ -41,7 +39,7 @@ See also \helpref{window styles overview}{windowstyles}.
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_TOGGLEBUTTON(id, func)}}{Handles button click event.}
+\twocolitem{{\bf EVT\_TOGGLEBUTTON(id, func)}}{Handles a toggle button click event.}
 \end{twocollist}
 
 \wxheading{See also}
@@ -85,7 +83,7 @@ Constructor, creating and showing a toggle button.
 
 \helpref{wxToggleButton::Create}{wxtogglebuttoncreate}, \helpref{wxValidator}{wxvalidator}
 
-\membersection{wxToggleButton::\destruct{wxToggleButton}}
+\membersection{wxToggleButton::\destruct{wxToggleButton}}\label{wxtogglebuttondtor}
 
 \func{}{\destruct{wxToggleButton}}{\void}
 
@@ -109,16 +107,15 @@ Gets the state of the toggle button.
 
 \wxheading{Return value}
 
-Returns {\tt TRUE} if it is pressed, {\tt FALSE} otherwise.
+Returns {\tt true} if it is pressed, {\tt false} otherwise.
 
 \membersection{wxToggleButton::SetValue}\label{wxtogglebuttonsetvalue}
 
 \func{void}{SetValue}{\param{const bool}{ state}}
 
 Sets the toggle button to the given state. This does not cause a
-{\tt EVT\_TOGGLEBUTTON} event to get emitted.
+{\tt EVT\_TOGGLEBUTTON} event to be emitted.
 
 \wxheading{Parameters}
 
-\docparam{state}{If {\tt TRUE}, the button is pressed.}
-
+\docparam{state}{If {\tt true}, the button is pressed.}