]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/radiobut.tex
The method is called CreatePopupMenu, not CreatePopupIcon
[wxWidgets.git] / docs / latex / wx / radiobut.tex
index 48cae42ab54ff5fe08bdc65952110ea85e59f12b..cc042eb24b032e49a8cd881262a432faea24460d 100644 (file)
@@ -3,6 +3,9 @@
 A radio button item is a button which usually denotes one of several mutually
 exclusive options. It has a text label next to a (usually) round button.
 
+You can create a group of mutually-exclusive radio buttons by specifying {\tt wxRB\_GROUP} for
+the first in the group. The group ends when another radio button group is created, or there are no more radio buttons.
+
 \wxheading{Derived from}
 
 \helpref{wxControl}{wxcontrol}\\
@@ -16,7 +19,15 @@ exclusive options. It has a text label next to a (usually) round button.
 
 \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}}{In some circumstances, radio buttons that are not
+consecutive siblings trigger a hang bug in Windows (only). If this happens, add this style
+to mark the button as not belonging to a group, and implement the mutually-exclusive group behaviour yourself.}
+\twocolitem{\windowstyle{wxRB\_USE\_CHECKBOX}}{Use a checkbox button instead of radio
+button (currently supported only on PalmOS).}
+\end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.
 
@@ -35,7 +46,7 @@ when the radiobutton is clicked.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxRadioButton::wxRadioButton}\label{wxradiobuttonconstr}
+\membersection{wxRadioButton::wxRadioButton}\label{wxradiobuttonctor}
 
 \func{}{wxRadioButton}{\void}
 
@@ -71,7 +82,7 @@ Constructor, creating and showing a radio button.
 
 \helpref{wxRadioButton::Create}{wxradiobuttoncreate}, \helpref{wxValidator}{wxvalidator}
 
-\membersection{wxRadioButton::\destruct{wxRadioButton}}
+\membersection{wxRadioButton::\destruct{wxRadioButton}}\label{wxradiobuttondtor}
 
 \func{void}{\destruct{wxRadioButton}}{\void}
 
@@ -85,23 +96,24 @@ Destructor, destroying the radio button item.
 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
 \param{const wxString\& }{name = ``radioButton"}}
 
-Creates the choice for two-step construction. See \helpref{wxRadioButton::wxRadioButton}{wxradiobuttonconstr} for
+Creates the choice for two-step construction. See \helpref{wxRadioButton::wxRadioButton}{wxradiobuttonctor} for
 further details.
 
 \membersection{wxRadioButton::GetValue}\label{wxradiobuttongetvalue}
 
 \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.}