X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..0ff2a74d0cc65f081aafcff79bcd3fd14638814f:/docs/latex/wx/radiobut.tex diff --git a/docs/latex/wx/radiobut.tex b/docs/latex/wx/radiobut.tex index 48cae42ab5..cefad84a75 100644 --- a/docs/latex/wx/radiobut.tex +++ b/docs/latex/wx/radiobut.tex @@ -16,7 +16,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}}{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.} +\twocolitem{\windowstyle{wxRB\_USE\_CHECKBOX}}{Use of the checkbox control instead of radio +button (currently supported only on PalmOS)} +\end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -35,7 +43,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 +79,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 +93,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.}