1998-05-20 10:25:30 -04:00
\section { \class { wxRadioBox} } \label { wxradiobox}
A radio box item is used to select one of number of mutually exclusive
choices. It is displayed as a vertical column or horizontal row of
labelled buttons.
\wxheading { Derived from}
\helpref { wxControl} { wxcontrol} \\
\helpref { wxWindow} { wxwindow} \\
\helpref { wxEvtHandler} { wxevthandler} \\
\helpref { wxObject} { wxobject}
1999-02-15 15:41:29 -05:00
\wxheading { Include files}
<wx/radiobox.h>
1998-05-20 10:25:30 -04:00
\wxheading { Window styles}
\twocolwidtha { 5cm}
\begin { twocollist} \itemsep =0pt
1998-12-18 09:40:38 -05:00
\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.}
1998-05-20 10:25:30 -04:00
\end { twocollist}
See also \helpref { window styles overview} { windowstyles} .
1998-08-06 15:42:06 -04:00
\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}
1998-05-20 10:25:30 -04:00
\wxheading { See also}
\helpref { Event handling overview} { eventhandlingoverview} , \helpref { wxRadioButton} { wxradiobutton} ,\rtfsp
\helpref { wxCheckBox} { wxcheckbox}
\latexignore { \rtfignore { \wxheading { Members} } }
\membersection { wxRadioBox::wxRadioBox} \label { wxradioboxconstr}
\func { } { wxRadioBox} { \void }
Default constructor.
1998-06-14 08:11:50 -04:00
\func { } { wxRadioBox} { \param { wxWindow* } { parent} , \param { wxWindowID } { id} , \param { const wxString\& } { label} ,\rtfsp
1998-05-20 10:25:30 -04:00
\param { const wxPoint\& } { point = wxDefaultPosition} , \param { const wxSize\& } { size = wxDefaultSize} ,\rtfsp
1998-06-14 08:11:50 -04:00
\param { int} { n = 0} , \param { const wxString} { choices[] = NULL} ,\rtfsp
1998-12-18 09:40:38 -05:00
\param { int} { majorDimension = 0} , \param { long} { style = wxRA\_ SPECIFY\_ COLS} ,\rtfsp
1998-05-20 10:25:30 -04:00
\param { const wxValidator\& } { validator = wxDefaultValidator} ,\rtfsp
\param { const wxString\& } { name = ``radioBox"} }
Constructor, creating and showing a radiobox.
\wxheading { Parameters}
\docparam { parent} { Parent window. Must not be NULL.}
\docparam { id} { Window identifier. A value of -1 indicates a default value.}
\docparam { label} { Label for the static box surrounding the radio buttons.}
\docparam { pos} { Window position. If the position (-1, -1) is specified then a default position is chosen.}
\docparam { size} { Window size. If the default size (-1, -1) is specified then a default size is chosen.}
\docparam { n} { Number of choices with which to initialize the radiobox.}
\docparam { choices} { An array of choices with which to initialize the radiobox.}
1998-12-18 09:40:38 -05:00
\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
1998-05-20 10:25:30 -04:00
radiobox.}
\docparam { style} { Window style. See \helpref { wxRadioBox} { wxradiobox} .}
\docparam { validator} { Window validator.}
\docparam { name} { Window name.}
\wxheading { See also}
\helpref { wxRadioBox::Create} { wxradioboxcreate} , \helpref { wxValidator} { wxvalidator}
\membersection { wxRadioBox::\destruct { wxRadioBox} }
\func { } { \destruct { wxRadioBox} } { \void }
Destructor, destroying the radiobox item.
\membersection { wxRadioBox::Create} \label { wxradioboxcreate}
1998-06-14 08:11:50 -04:00
\func { bool} { Create} { \param { wxWindow* } { parent} , \param { wxWindowID } { id} , \param { const wxString\& } { label} ,\rtfsp
1998-05-20 10:25:30 -04:00
\param { const wxPoint\& } { point = wxDefaultPosition} , \param { const wxSize\& } { size = wxDefaultSize} ,\rtfsp
1998-06-14 08:11:50 -04:00
\param { int} { n = 0} , \param { const wxString} { choices[] = NULL} ,\rtfsp
1998-12-18 09:40:38 -05:00
\param { int} { majorDimension = 0} , \param { long} { style = wxRA\_ SPECIFY\_ COLS} ,\rtfsp
1998-05-20 10:25:30 -04:00
\param { const wxValidator\& } { validator = wxDefaultValidator} ,\rtfsp
\param { const wxString\& } { name = ``radioBox"} }
Creates the radiobox for two-step construction. See \helpref { wxRadioBox::wxRadioBox} { wxradioboxconstr} \rtfsp
for further details.
\membersection { wxRadioBox::Enable} \label { wxradioboxenable}
\func { void} { Enable} { \param { const bool} { enable} }
Enables or disables the entire radiobox.
1998-06-14 08:11:50 -04:00
\func { void} { Enable} { \param { int} { n} , \param { const bool} { enable} }
1998-05-20 10:25:30 -04:00
Enables or disables an individual button in the radiobox.
\wxheading { Parameters}
\docparam { enable} { TRUE to enable, FALSE to disable.}
\docparam { n} { The zero-based button to enable or disable.}
\membersection { wxRadioBox::FindString} \label { wxradioboxfindstring}
\constfunc { int} { FindString} { \param { const wxString\& } { string} }
Finds a button matching the given string, returning the position if found, or
-1 if not found.
\wxheading { Parameters}
\docparam { string} { The string to find.}
\membersection { wxRadioBox::GetLabel} \label { wxradioboxgetlabel}
\constfunc { wxString} { GetLabel} { \void }
Returns the radiobox label.
1998-06-14 08:11:50 -04:00
\constfunc { wxString} { GetLabel} { \param { int } { n} }
1998-05-20 10:25:30 -04:00
Returns the label for the given button.
\wxheading { Parameters}
\docparam { n} { The zero-based button index.}
\wxheading { See also}
\helpref { wxRadioBox::SetLabel} { wxradioboxsetlabel}
\membersection { wxRadioBox::GetSelection} \label { wxradioboxgetselection}
\constfunc { int} { GetSelection} { \void }
Returns the zero-based position of the selected button.
\membersection { wxRadioBox::GetStringSelection} \label { wxradioboxgetstringselection}
\constfunc { wxString} { GetStringSelection} { \void }
Returns the selected string.
\membersection { wxRadioBox::Number} \label { wxradioboxnumber}
\constfunc { int} { Number} { \void }
Returns the number of buttons in the radiobox.
\membersection { wxRadioBox::SetLabel} \label { wxradioboxsetlabel}
\func { void} { SetLabel} { \param { const wxString\& } { label} }
Sets the radiobox label.
1998-06-14 08:11:50 -04:00
\func { void} { SetLabel} { \param { int } { n} , \param { const wxString\& } { label} }
1998-05-20 10:25:30 -04:00
Sets a label for a radio button.
\wxheading { Parameters}
\docparam { label} { The label to set.}
\docparam { n} { The zero-based button index.}
\membersection { wxRadioBox::SetSelection} \label { wxradioboxsetselection}
1998-06-14 08:11:50 -04:00
\func { void} { SetSelection} { \param { int} { n} }
1998-05-20 10:25:30 -04:00
Sets a button by passing the desired string position.
\wxheading { Parameters}
\docparam { n} { The zero-based button position.}
\membersection { wxRadioBox::SetStringSelection} \label { wxradioboxsetstringselection}
\func { void} { SetStringSelection} { \param { const wxString\& } { string} }
Sets a button by passing the desired string.
\wxheading { Parameters}
\docparam { string} { The label of the button to select.}
\membersection { wxRadioBox::Show} \label { wxradioboxshow}
\func { void} { Show} { \param { const bool} { show} }
Shows or hides the entire radiobox.
1998-06-14 08:11:50 -04:00
\func { void} { Show} { \param { int } { item} , \param { const bool} { show} }
1998-05-20 10:25:30 -04:00
Shows or hides individual buttons.
\wxheading { Parameters}
\docparam { show} { TRUE to show, FALSE to hide.}
\docparam { item} { The zero-based position of the button to show or hide.}
\membersection { wxRadioBox::GetString} \label { wxradioboxgetstring}
1998-06-14 08:11:50 -04:00
\constfunc { wxString} { GetString} { \param { int} { n} }
1998-05-20 10:25:30 -04:00
Returns the label for the button at the given position.
\wxheading { Parameters}
\docparam { n} { The zero-based button position.}