]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/radiobut.tex
added wxTB_HORZ_TEXT (patch 713813); documented it; moved toolbar styles to toolbar.h
[wxWidgets.git] / docs / latex / wx / radiobut.tex
index 8e963906d2e5d9bd512f174e5068582502ab8cc3..58c0e040308e33f2ab82aa14e59c0ea35c6dfa16 100644 (file)
@@ -10,12 +10,30 @@ exclusive options. It has a text label next to a (usually) round button.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/radiobut.h>
+
 \wxheading{Window styles}
 
-There are no specific styles for this class.
+\twocolwidtha{5cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\windowstyle{wxRB\_GROUP}}{Marks the beginning of a new group of radio buttons.}
+\twocolitem{\windowstyle{wxRB\_SINGLE}}{If your radio buttons are not
+consecutive siblings, they cannot form a group under Windows and you should use
+this style to indicate that each of them is handled individually.}
+\end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.
 
+\wxheading{Event handling}
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_RADIOBUTTON(id, func)}}{Process a wxEVT\_COMMAND\_RADIOBUTTON\_SELECTED event,
+when the radiobutton is clicked.}
+\end{twocollist}
+
 \wxheading{See also}
 
 \helpref{Event handling overview}{eventhandlingoverview}, \helpref{wxRadioBox}{wxradiobox},\rtfsp
@@ -80,16 +98,17 @@ further details.
 
 \constfunc{bool}{GetValue}{\void}
 
-Returns TRUE if the radio button is depressed, FALSE otherwise.
+Returns true if the radio button is depressed, false otherwise.
 
 \membersection{wxRadioButton::SetValue}\label{wxradiobuttonsetvalue}
 
 \func{void}{SetValue}{\param{const bool}{ value}}
 
-Sets the radio button to selected or deselected status.
+Sets the radio button to selected or deselected status. This does not cause a
+wxEVT\_COMMAND\_RADIOBUTTON\_SELECTED event to get emitted.
 
 \wxheading{Parameters}
 
-\docparam{value}{TRUE to select, FALSE to deselect.}
+\docparam{value}{true to select, false to deselect.}