X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/eaaa6a06a25774c18d10bb8182cc1934ed0ed9aa..a24d7726e6b5c1b727d97603a3b5e80fa27a9dd2:/docs/latex/wx/radiobut.tex diff --git a/docs/latex/wx/radiobut.tex b/docs/latex/wx/radiobut.tex index 8e963906d2..cc042eb24b 100644 --- a/docs/latex/wx/radiobut.tex +++ b/docs/latex/wx/radiobut.tex @@ -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}\\ @@ -10,12 +13,32 @@ exclusive options. It has a text label next to a (usually) round button. \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \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}. +\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 @@ -23,7 +46,7 @@ See also \helpref{window styles overview}{windowstyles}. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxRadioButton::wxRadioButton}\label{wxradiobuttonconstr} +\membersection{wxRadioButton::wxRadioButton}\label{wxradiobuttonctor} \func{}{wxRadioButton}{\void} @@ -59,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} @@ -73,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.}