X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..749bb9f1291c3c967a25cbbd9aed98a89f7e1511:/docs/latex/wx/radiobut.tex?ds=sidebyside diff --git a/docs/latex/wx/radiobut.tex b/docs/latex/wx/radiobut.tex index d8c2b8b84c..58c0e04030 100644 --- a/docs/latex/wx/radiobut.tex +++ b/docs/latex/wx/radiobut.tex @@ -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} + + + \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 @@ -29,9 +47,9 @@ See also \helpref{window styles overview}{windowstyles}. Default constructor. -\func{}{wxRadioButton}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp +\func{}{wxRadioButton}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp -\param{const long}{ style = 0},\rtfsp +\param{long}{ style = 0},\rtfsp \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{const wxString\& }{name = ``radioButton"}} @@ -67,9 +85,9 @@ Destructor, destroying the radio button item. \membersection{wxRadioButton::Create}\label{wxradiobuttoncreate} -\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{const wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp +\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp -\param{const long}{ style = 0},\rtfsp +\param{long}{ style = 0},\rtfsp \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{const wxString\& }{name = ``radioButton"}} @@ -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.}