X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..2432b92dd7a837db13d3938a56c1959decd03203:/docs/latex/wx/radiobox.tex?ds=sidebyside diff --git a/docs/latex/wx/radiobox.tex b/docs/latex/wx/radiobox.tex index 36918afb48..a98a59a22e 100644 --- a/docs/latex/wx/radiobox.tex +++ b/docs/latex/wx/radiobox.tex @@ -15,12 +15,22 @@ labelled buttons. \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxRA\_HORIZONTAL}}{Lays the radiobox out in rows.} -\twocolitem{\windowstyle{wxRA\_VERTICAL}}{Lays the radiobox out in columns.} +\twocolitem{\windowstyle{wxRA\_SPECIFY\_ROWS}}{The major dimension parameter refers to the +maximum number of rows.} +\twocolitem{\windowstyle{wxRA\_SPECIFY\_COLS}}{The major dimension parameter refers to the +maximum number of columns.} \end{twocollist} See also \helpref{window styles overview}{windowstyles}. +\wxheading{Event handling} + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_RADIOBOX(id, func)}}{Process a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event, +when a radiobutton is clicked.} +\end{twocollist} + \wxheading{See also} \helpref{Event handling overview}{eventhandlingoverview}, \helpref{wxRadioButton}{wxradiobutton},\rtfsp @@ -34,10 +44,10 @@ See also \helpref{window styles overview}{windowstyles}. Default constructor. -\func{}{wxRadioBox}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp +\func{}{wxRadioBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp -\param{const int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp -\param{const int}{ majorDimension = 0}, \param{const long}{ style = wxRA\_HORIZONTAL},\rtfsp +\param{int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp +\param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_SPECIFY\_COLS},\rtfsp \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{const wxString\& }{name = ``radioBox"}} @@ -59,7 +69,7 @@ Constructor, creating and showing a radiobox. \docparam{choices}{An array of choices with which to initialize the radiobox.} -\docparam{majorDimension}{Specifies the number of rows (if style is wxRA\_VERTICAL) or columns (if style is wxRA\_HORIZONTAL) for a two-dimensional +\docparam{majorDimension}{Specifies the maximum number of rows (if style contains wxRA\_SPECIFY\_ROWS) or columns (if style contains wxRA\_SPECIFY\_COLS) for a two-dimensional radiobox.} \docparam{style}{Window style. See \helpref{wxRadioBox}{wxradiobox}.} @@ -80,10 +90,10 @@ Destructor, destroying the radiobox item. \membersection{wxRadioBox::Create}\label{wxradioboxcreate} -\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\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp -\param{const int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp -\param{const int}{ majorDimension = 0}, \param{const long}{ style = wxRA\_HORIZONTAL},\rtfsp +\param{int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp +\param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_SPECIFY\_COLS},\rtfsp \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp \param{const wxString\& }{name = ``radioBox"}} @@ -96,7 +106,7 @@ for further details. Enables or disables the entire radiobox. -\func{void}{Enable}{\param{const int}{ n}, \param{const bool}{ enable}} +\func{void}{Enable}{\param{int}{ n}, \param{const bool}{ enable}} Enables or disables an individual button in the radiobox. @@ -123,7 +133,7 @@ Finds a button matching the given string, returning the position if found, or Returns the radiobox label. -\constfunc{wxString}{GetLabel}{\param{const int }{n}} +\constfunc{wxString}{GetLabel}{\param{int }{n}} Returns the label for the given button. @@ -159,7 +169,7 @@ Returns the number of buttons in the radiobox. Sets the radiobox label. -\func{void}{SetLabel}{\param{const int }{n}, \param{const wxString\&}{ label}} +\func{void}{SetLabel}{\param{int }{n}, \param{const wxString\&}{ label}} Sets a label for a radio button. @@ -171,7 +181,7 @@ Sets a label for a radio button. \membersection{wxRadioBox::SetSelection}\label{wxradioboxsetselection} -\func{void}{SetSelection}{\param{const int}{ n}} +\func{void}{SetSelection}{\param{int}{ n}} Sets a button by passing the desired string position. @@ -195,7 +205,7 @@ Sets a button by passing the desired string. Shows or hides the entire radiobox. -\func{void}{Show}{\param{const int }{item}, \param{const bool}{ show}} +\func{void}{Show}{\param{int }{item}, \param{const bool}{ show}} Shows or hides individual buttons. @@ -207,7 +217,7 @@ Shows or hides individual buttons. \membersection{wxRadioBox::GetString}\label{wxradioboxgetstring} -\constfunc{wxString}{GetString}{\param{const int}{ n}} +\constfunc{wxString}{GetString}{\param{int}{ n}} Returns the label for the button at the given position.