docs/latex/wx/radiobox.tex

   1 \section{\class{wxRadioBox}}\label{wxradiobox}
   2
   3 A radio box item is used to select one of number of mutually exclusive
   4 choices.  It is displayed as a vertical column or horizontal row of
   5 labelled buttons.
   6
   7 \wxheading{Derived from}
   8
   9 \helpref{wxControl}{wxcontrol}\\
  10 \helpref{wxWindow}{wxwindow}\\
  11 \helpref{wxEvtHandler}{wxevthandler}\\
  12 \helpref{wxObject}{wxobject}
  13
  14 \wxheading{Include files}
  15
  16 <wx/radiobox.h>
  17
  18 \wxheading{Window styles}
  19
  20 \twocolwidtha{5cm}
  21 \begin{twocollist}\itemsep=0pt
  22 \twocolitem{\windowstyle{wxRA\_SPECIFY\_ROWS}}{The major dimension parameter refers to the
  23 maximum number of rows.}
  24 \twocolitem{\windowstyle{wxRA\_SPECIFY\_COLS}}{The major dimension parameter refers to the
  25 maximum number of columns.}
  26 \twocolitem{\windowstyle{wxRA\_USE\_CHECKBOX}}{Use of the checkbox controls instead of radio
  27 buttons (currently supported only on PalmOS)}
  28 \end{twocollist}
  29
  30 See also \helpref{window styles overview}{windowstyles}.
  31
  32 \wxheading{Event handling}
  33
  34 \twocolwidtha{7cm}
  35 \begin{twocollist}\itemsep=0pt
  36 \twocolitem{{\bf EVT\_RADIOBOX(id, func)}}{Process a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event,
  37 when a radiobutton is clicked.}
  38 \end{twocollist}
  39
  40 \wxheading{See also}
  41
  42 \helpref{Event handling overview}{eventhandlingoverview}, \helpref{wxRadioButton}{wxradiobutton},\rtfsp
  43 \helpref{wxCheckBox}{wxcheckbox}
  44
  45 \latexignore{\rtfignore{\wxheading{Members}}}
  46
  47 \membersection{wxRadioBox::wxRadioBox}\label{wxradioboxctor}
  48
  49 \func{}{wxRadioBox}{\void}
  50
  51 Default constructor.
  52
  53 \func{}{wxRadioBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
  54 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
  55 \param{int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp
  56 \param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_SPECIFY\_COLS},\rtfsp
  57 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
  58 \param{const wxString\& }{name = ``radioBox"}}
  59
  60 \func{}{wxRadioBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
  61 \param{const wxPoint\& }{point}, \param{const wxSize\& }{size},\rtfsp
  62 \param{const wxArrayString\&}{ choices},\rtfsp
  63 \param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_SPECIFY\_COLS},\rtfsp
  64 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
  65 \param{const wxString\& }{name = ``radioBox"}}
  66
  67 Constructor, creating and showing a radiobox.
  68
  69 \wxheading{Parameters}
  70
  71 \docparam{parent}{Parent window. Must not be NULL.}
  72
  73 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
  74
  75 \docparam{label}{Label for the static box surrounding the radio buttons.}
  76
  77 \docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}
  78
  79 \docparam{size}{Window size. If the default size (-1, -1) is specified then a default size is chosen.}
  80
  81 \docparam{n}{Number of choices with which to initialize the radiobox.}
  82
  83 \docparam{choices}{An array of choices with which to initialize the radiobox.}
  84
  85 \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
  86 radiobox.}
  87
  88 \docparam{style}{Window style. See \helpref{wxRadioBox}{wxradiobox}.}
  89
  90 \docparam{validator}{Window validator.}
  91
  92 \docparam{name}{Window name.}
  93
  94 \wxheading{See also}
  95
  96 \helpref{wxRadioBox::Create}{wxradioboxcreate}, \helpref{wxValidator}{wxvalidator}
  97
  98 \pythonnote{The wxRadioBox constructor in wxPython reduces the {\tt n}
  99 and {\tt choices} arguments are to a single argument, which is
 100 a list of strings.}
 101
 102 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
 103 and {\tt choices}.}
 104
 105 \membersection{wxRadioBox::\destruct{wxRadioBox}}\label{wxradioboxdtor}
 106
 107 \func{}{\destruct{wxRadioBox}}{\void}
 108
 109 Destructor, destroying the radiobox item.
 110
 111 \membersection{wxRadioBox::Create}\label{wxradioboxcreate}
 112
 113 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
 114 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 115 \param{int}{ n = 0}, \param{const wxString}{ choices[] = NULL},\rtfsp
 116 \param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_SPECIFY\_COLS},\rtfsp
 117 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
 118 \param{const wxString\& }{name = ``radioBox"}}
 119
 120 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp
 121 \param{const wxPoint\& }{point}, \param{const wxSize\& }{size},\rtfsp
 122 \param{const wxArrayString\&}{ choices},\rtfsp
 123 \param{int}{ majorDimension = 0}, \param{long}{ style = wxRA\_SPECIFY\_COLS},\rtfsp
 124 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
 125 \param{const wxString\& }{name = ``radioBox"}}
 126
 127 Creates the radiobox for two-step construction. See \helpref{wxRadioBox::wxRadioBox}{wxradioboxctor}\rtfsp
 128 for further details.
 129
 130 \membersection{wxRadioBox::Enable}\label{wxradioboxenable}
 131
 132 \func{void}{Enable}{\param{bool}{ enable = {\tt true}}}
 133
 134 Enables or disables the entire radiobox.
 135
 136 \func{void}{Enable}{\param{int}{ n}, \param{bool}{ enable = {\tt true}}}
 137
 138 Enables or disables an individual button in the radiobox.
 139
 140 \wxheading{Parameters}
 141
 142 \docparam{enable}{true to enable, false to disable.}
 143
 144 \docparam{n}{The zero-based button to enable or disable.}
 145
 146 \pythonnote{In place of a single overloaded method name, wxPython
 147 implements the following methods:\par
 148 \indented{2cm}{\begin{twocollist}
 149 \twocolitem{{\bf Enable(flag)}}{Enables or disables the entire radiobox.}
 150 \twocolitem{{\bf EnableItem(n, flag)}}{Enables or disables an
 151 individual button in the radiobox.}
 152 \end{twocollist}}
 153 }
 154
 155
 156 \membersection{wxRadioBox::FindString}\label{wxradioboxfindstring}
 157
 158 \constfunc{int}{FindString}{\param{const wxString\& }{string}}
 159
 160 Finds a button matching the given string, returning the position if found, or
 161 -1 if not found.
 162
 163 \wxheading{Parameters}
 164
 165 \docparam{string}{The string to find.}
 166
 167 \membersection{wxRadioBox::GetCount}\label{wxradioboxgetcount}
 168
 169 \constfunc{int}{GetCount}{\void}
 170
 171 Returns the number of items in the radiobox.
 172
 173 \membersection{wxRadioBox::GetLabel}\label{wxradioboxgetlabel}
 174
 175 \constfunc{wxString}{GetLabel}{\void}
 176
 177 Returns the radiobox label.
 178
 179 \constfunc{wxString}{GetLabel}{\param{int }{n}}
 180
 181 Returns the label for the given button.
 182
 183 \wxheading{Parameters}
 184
 185 \docparam{n}{The zero-based button index.}
 186
 187 \wxheading{See also}
 188
 189 \helpref{wxRadioBox::SetLabel}{wxradioboxsetlabel}
 190
 191 \pythonnote{In place of a single overloaded method name, wxPython
 192 implements the following methods:\par
 193 \indented{2cm}{\begin{twocollist}
 194 \twocolitem{{\bf GetLabel()}}{Returns the radiobox label.}
 195 \twocolitem{{\bf GetItemLabel(n)}}{Returns the label for the given button.}
 196 \end{twocollist}}
 197 }
 198
 199
 200 \membersection{wxRadioBox::GetSelection}\label{wxradioboxgetselection}
 201
 202 \constfunc{int}{GetSelection}{\void}
 203
 204 Returns the zero-based position of the selected button.
 205
 206 \membersection{wxRadioBox::GetStringSelection}\label{wxradioboxgetstringselection}
 207
 208 \constfunc{wxString}{GetStringSelection}{\void}
 209
 210 Returns the selected string.
 211
 212 \membersection{wxRadioBox::GetString}\label{wxradioboxgetstring}
 213
 214 \constfunc{wxString}{GetString}{\param{int}{ n}}
 215
 216 Returns the label for the button at the given position.
 217
 218 \wxheading{Parameters}
 219
 220 \docparam{n}{The zero-based button position.}
 221
 222 \membersection{wxRadioBox::Number}\label{wxradioboxnumber}
 223
 224 \constfunc{int}{Number}{\void}
 225
 226 {\bf Obsolescence note:} This method is obsolete and was replaced with
 227 \helpref{GetCount}{wxradioboxgetcount}, please use the new method in the new
 228 code. This method is only available if wxWidgets was compiled with
 229 {\tt WXWIN\_COMPATIBILITY\_2\_2} defined and will disappear completely in
 230 future versions.
 231
 232 Returns the number of buttons in the radiobox.
 233
 234 \membersection{wxRadioBox::SetLabel}\label{wxradioboxsetlabel}
 235
 236 \func{void}{SetLabel}{\param{const wxString\&}{ label}}
 237
 238 Sets the radiobox label.
 239
 240 \func{void}{SetLabel}{\param{int }{n}, \param{const wxString\&}{ label}}
 241
 242 Sets a label for a radio button.
 243
 244 \wxheading{Parameters}
 245
 246 \docparam{label}{The label to set.}
 247
 248 \docparam{n}{The zero-based button index.}
 249
 250 \pythonnote{In place of a single overloaded method name, wxPython
 251 implements the following methods:\par
 252 \indented{2cm}{\begin{twocollist}
 253 \twocolitem{{\bf SetLabel(string)}}{Sets the radiobox label.}
 254 \twocolitem{{\bf SetItemLabel(n, string)}}{Sets a label for a radio button.}
 255 \end{twocollist}}
 256 }
 257
 258 \membersection{wxRadioBox::SetSelection}\label{wxradioboxsetselection}
 259
 260 \func{void}{SetSelection}{\param{int}{ n}}
 261
 262 Sets a button by passing the desired string position. This does not cause
 263 a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event to get emitted.
 264
 265 \wxheading{Parameters}
 266
 267 \docparam{n}{The zero-based button position.}
 268
 269 \membersection{wxRadioBox::SetStringSelection}\label{wxradioboxsetstringselection}
 270
 271 \func{void}{SetStringSelection}{\param{const wxString\& }{string}}
 272
 273 Sets the selection to a button by passing the desired string. This does not cause
 274 a wxEVT\_COMMAND\_RADIOBOX\_SELECTED event to get emitted.
 275
 276 \wxheading{Parameters}
 277
 278 \docparam{string}{The label of the button to select.}
 279
 280 \membersection{wxRadioBox::Show}\label{wxradioboxshow}
 281
 282 \func{void}{Show}{\param{const bool}{ show}}
 283
 284 Shows or hides the entire radiobox.
 285
 286 \func{void}{Show}{\param{int }{item}, \param{const bool}{ show}}
 287
 288 Shows or hides individual buttons.
 289
 290 \wxheading{Parameters}
 291
 292 \docparam{show}{true to show, false to hide.}
 293
 294 \docparam{item}{The zero-based position of the button to show or hide.}
 295
 296 \pythonnote{In place of a single overloaded method name, wxPython
 297 implements the following methods:\par
 298 \indented{2cm}{\begin{twocollist}
 299 \twocolitem{{\bf Show(flag)}}{Shows or hides the entire radiobox.}
 300 \twocolitem{{\bf ShowItem(n, flag)}}{Shows or hides individual buttons.}
 301 \end{twocollist}}
 302 }
 303