1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %% Purpose: wxRadioBox documentation
4 %% Author: wxWidgets Team
8 %% Copyright: (c) wxWidgets Team
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12 \section{\class{wxRadioBox
}}\label{wxradiobox
}
14 A radio box item is used to select one of number of mutually exclusive
15 choices. It is displayed as a vertical column or horizontal row of
18 \wxheading{Derived from
}
20 \helpref{wxControlWithItems
}{wxcontrolwithitems
}\\
21 \helpref{wxControl
}{wxcontrol
}\\
22 \helpref{wxWindow
}{wxwindow
}\\
23 \helpref{wxEvtHandler
}{wxevthandler
}\\
24 \helpref{wxObject
}{wxobject
}
26 \wxheading{Include files
}
30 \wxheading{Window styles
}
33 \begin{twocollist
}\itemsep=
0pt
34 \twocolitem{\windowstyle{wxRA
\_SPECIFY\_ROWS}}{The major dimension parameter refers to the
35 maximum number of rows.
}
36 \twocolitem{\windowstyle{wxRA
\_SPECIFY\_COLS}}{The major dimension parameter refers to the
37 maximum number of columns.
}
38 \twocolitem{\windowstyle{wxRA
\_USE\_CHECKBOX}}{Use of the checkbox controls instead of radio
39 buttons (currently supported only on PalmOS)
}
42 See also
\helpref{window styles overview
}{windowstyles
}.
44 \wxheading{Event handling
}
47 \begin{twocollist
}\itemsep=
0pt
48 \twocolitem{{\bf EVT
\_RADIOBOX(id, func)
}}{Process a wxEVT
\_COMMAND\_RADIOBOX\_SELECTED event,
49 when a radiobutton is clicked.
}
54 \helpref{Event handling overview
}{eventhandlingoverview
},
\helpref{wxRadioButton
}{wxradiobutton
},
\rtfsp
55 \helpref{wxCheckBox
}{wxcheckbox
}
57 \latexignore{\rtfignore{\wxheading{Members
}}}
60 \membersection{wxRadioBox::wxRadioBox
}\label{wxradioboxctor
}
62 \func{}{wxRadioBox
}{\void}
66 \func{}{wxRadioBox
}{\param{wxWindow*
}{parent
},
\param{wxWindowID
}{id
},
\param{const wxString\&
}{label
},
\rtfsp
67 \param{const wxPoint\&
}{point = wxDefaultPosition
},
\param{const wxSize\&
}{size = wxDefaultSize
},
\rtfsp
68 \param{int
}{ n =
0},
\param{const wxString
}{ choices
[] = NULL
},
\rtfsp
69 \param{int
}{ majorDimension =
0},
\param{long
}{ style = wxRA
\_SPECIFY\_COLS},
\rtfsp
70 \param{const wxValidator\&
}{validator = wxDefaultValidator
},
\rtfsp
71 \param{const wxString\&
}{name = ``radioBox"
}}
73 \func{}{wxRadioBox
}{\param{wxWindow*
}{parent
},
\param{wxWindowID
}{id
},
\param{const wxString\&
}{label
},
\rtfsp
74 \param{const wxPoint\&
}{point
},
\param{const wxSize\&
}{size
},
\rtfsp
75 \param{const wxArrayString\&
}{ choices
},
\rtfsp
76 \param{int
}{ majorDimension =
0},
\param{long
}{ style = wxRA
\_SPECIFY\_COLS},
\rtfsp
77 \param{const wxValidator\&
}{validator = wxDefaultValidator
},
\rtfsp
78 \param{const wxString\&
}{name = ``radioBox"
}}
80 Constructor, creating and showing a radiobox.
82 \wxheading{Parameters
}
84 \docparam{parent
}{Parent window. Must not be NULL.
}
86 \docparam{id
}{Window identifier. A value of -
1 indicates a default value.
}
88 \docparam{label
}{Label for the static box surrounding the radio buttons.
}
90 \docparam{pos
}{Window position. If the position (-
1, -
1) is specified then a default position is chosen.
}
92 \docparam{size
}{Window size. If the default size (-
1, -
1) is specified then a default size is chosen.
}
94 \docparam{n
}{Number of choices with which to initialize the radiobox.
}
96 \docparam{choices
}{An array of choices with which to initialize the radiobox.
}
98 \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
101 \docparam{style
}{Window style. See
\helpref{wxRadioBox
}{wxradiobox
}.
}
103 \docparam{validator
}{Window validator.
}
105 \docparam{name
}{Window name.
}
109 \helpref{wxRadioBox::Create
}{wxradioboxcreate
},
\helpref{wxValidator
}{wxvalidator
}
111 \pythonnote{The wxRadioBox constructor in wxPython reduces the
{\tt n
}
112 and
{\tt choices
} arguments are to a single argument, which is
115 \perlnote{In wxPerl there is just an array reference in place of
{\tt n
}
119 \membersection{wxRadioBox::
\destruct{wxRadioBox
}}\label{wxradioboxdtor
}
121 \func{}{\destruct{wxRadioBox
}}{\void}
123 Destructor, destroying the radiobox item.
126 \membersection{wxRadioBox::Create
}\label{wxradioboxcreate
}
128 \func{bool
}{Create
}{\param{wxWindow*
}{parent
},
\param{wxWindowID
}{id
},
\param{const wxString\&
}{label
},
\rtfsp
129 \param{const wxPoint\&
}{point = wxDefaultPosition
},
\param{const wxSize\&
}{size = wxDefaultSize
},
\rtfsp
130 \param{int
}{ n =
0},
\param{const wxString
}{ choices
[] = NULL
},
\rtfsp
131 \param{int
}{ majorDimension =
0},
\param{long
}{ style = wxRA
\_SPECIFY\_COLS},
\rtfsp
132 \param{const wxValidator\&
}{validator = wxDefaultValidator
},
\rtfsp
133 \param{const wxString\&
}{name = ``radioBox"
}}
135 \func{bool
}{Create
}{\param{wxWindow*
}{parent
},
\param{wxWindowID
}{id
},
\param{const wxString\&
}{label
},
\rtfsp
136 \param{const wxPoint\&
}{point
},
\param{const wxSize\&
}{size
},
\rtfsp
137 \param{const wxArrayString\&
}{ choices
},
\rtfsp
138 \param{int
}{ majorDimension =
0},
\param{long
}{ style = wxRA
\_SPECIFY\_COLS},
\rtfsp
139 \param{const wxValidator\&
}{validator = wxDefaultValidator
},
\rtfsp
140 \param{const wxString\&
}{name = ``radioBox"
}}
142 Creates the radiobox for two-step construction. See
\helpref{wxRadioBox::wxRadioBox
}{wxradioboxctor
}\rtfsp
146 \membersection{wxRadioBox::Enable
}\label{wxradioboxenable
}
148 \func{virtual bool
}{Enable
}{\param{bool
}{ enable =
{\tt true
}}}
150 Enables or disables the entire radiobox.
152 \func{virtual bool
}{Enable
}{\param{int
}{ n
},
\param{bool
}{ enable =
{\tt true
}}}
154 Enables or disables an individual button in the radiobox.
156 \wxheading{Parameters
}
158 \docparam{enable
}{true to enable, false to disable.
}
160 \docparam{n
}{The zero-based button to enable or disable.
}
162 \pythonnote{In place of a single overloaded method name, wxPython
163 implements the following methods:
\par
164 \indented{2cm
}{\begin{twocollist
}
165 \twocolitem{{\bf Enable(flag)
}}{Enables or disables the entire radiobox.
}
166 \twocolitem{{\bf EnableItem(n, flag)
}}{Enables or disables an
167 individual button in the radiobox.
}
173 \helpref{wxWindow::Enable
}{wxwindowenable
}
177 \membersection{wxRadioBox::FindString
}\label{wxradioboxfindstring
}
179 \constfunc{int
}{FindString
}{\param{const wxString\&
}{string
}}
181 Finds a button matching the given string, returning the position if found, or
184 \wxheading{Parameters
}
186 \docparam{string
}{The string to find.
}
189 \membersection{wxRadioBox::GetColumnCount
}\label{wxradioboxgetcolumncount
}
191 \constfunc{int
}{GetColumnCount
}{\void}
193 Returns the number of columns in the radiobox.
196 \membersection{wxRadioBox::GetLabel
}\label{wxradioboxgetlabel
}
198 \constfunc{wxString
}{GetLabel
}{\void}
200 Returns the radiobox label.
202 \wxheading{Parameters
}
204 \docparam{n
}{The zero-based button index.
}
208 \helpref{wxRadioBox::SetLabel
}{wxradioboxsetlabel
}
210 \pythonnote{In place of a single overloaded method name, wxPython
211 implements the following methods:
\par
212 \indented{2cm
}{\begin{twocollist
}
213 \twocolitem{{\bf GetLabel()
}}{Returns the radiobox label.
}
214 \twocolitem{{\bf GetItemLabel(n)
}}{Returns the label for the given button.
}
219 \membersection{wxRadioBox::GetRowCount
}\label{wxradioboxgetrowcount
}
221 \constfunc{int
}{GetRowCount
}{\void}
223 Returns the number of rows in the radiobox.
226 \membersection{wxRadioBox::GetSelection
}\label{wxradioboxgetselection
}
228 \constfunc{int
}{GetSelection
}{\void}
230 Returns the zero-based position of the selected button.
233 \membersection{wxRadioBox::GetStringSelection
}\label{wxradioboxgetstringselection
}
235 \constfunc{wxString
}{GetStringSelection
}{\void}
237 Returns the selected string.
240 \membersection{wxRadioBox::GetString
}\label{wxradioboxgetstring
}
242 \constfunc{wxString
}{GetString
}{\param{int
}{ n
}}
244 Returns the label for the button at the given position.
246 \wxheading{Parameters
}
248 \docparam{n
}{The zero-based button position.
}
251 \membersection{wxRadioBox::IsItemEnabled
}\label{wxradioboxisitemenabled
}
253 \constfunc{bool
}{IsItemEnabled
}{\void}
255 Returns
\true if the item is enabled or
\false if it was disabled using
256 \helpref{Enable(n, false)
}{wxradioboxenable
}.
258 {\bf Platform note:
} Currently only implemented in wxMSW, wxGTK and wxUniversal
259 and always returns
\true in the other ports.
262 \membersection{wxRadioBox::IsItemShown
}\label{wxradioboxisitemshown
}
264 \constfunc{bool
}{IsItemShown
}{\void}
266 Returns
\true if the item is currently shown or
\false if it was hidden using
267 \helpref{Show(n, false)
}{wxradioboxshow
}.
269 Note that this function returns
\true for an item which hadn't been hidden even
270 if the entire radiobox is not currently shown.
272 {\bf Platform note:
} Currently only implemented in wxMSW, wxGTK and wxUniversal
273 and always returns
\true in the other ports.
276 \membersection{wxRadioBox::SetLabel
}\label{wxradioboxsetlabel
}
278 \func{void
}{SetLabel
}{\param{const wxString\&
}{ label
}}
280 Sets the radiobox label.
283 \wxheading{Parameters
}
285 \docparam{label
}{The label to set.
}
287 \docparam{n
}{The zero-based button index.
}
289 \pythonnote{In place of a single overloaded method name, wxPython
290 implements the following methods:
\par
291 \indented{2cm
}{\begin{twocollist
}
292 \twocolitem{{\bf SetLabel(string)
}}{Sets the radiobox label.
}
293 \twocolitem{{\bf SetItemLabel(n, string)
}}{Sets a label for a radio button.
}
298 \membersection{wxRadioBox::SetSelection
}\label{wxradioboxsetselection
}
300 \func{void
}{SetSelection
}{\param{int
}{ n
}}
302 Sets a button by passing the desired string position. This does not cause
303 a wxEVT
\_COMMAND\_RADIOBOX\_SELECTED event to get emitted.
305 \wxheading{Parameters
}
307 \docparam{n
}{The zero-based button position.
}
310 \membersection{wxRadioBox::SetStringSelection
}\label{wxradioboxsetstringselection
}
312 \func{void
}{SetStringSelection
}{\param{const wxString\&
}{string
}}
314 Sets the selection to a button by passing the desired string. This does not cause
315 a wxEVT
\_COMMAND\_RADIOBOX\_SELECTED event to get emitted.
317 \wxheading{Parameters
}
319 \docparam{string
}{The label of the button to select.
}
322 \membersection{wxRadioBox::Show
}\label{wxradioboxshow
}
324 \func{virtual bool
}{Show
}{\param{const bool
}{ show =
{\tt true
}}}
326 Shows or hides the entire radiobox.
328 \func{virtual bool
}{Show
}{\param{int
}{ item
},
\param{const bool
}{ show =
{\tt true
}}}
330 Shows or hides individual buttons.
332 \wxheading{Parameters
}
334 \docparam{show
}{true to show, false to hide.
}
336 \docparam{item
}{The zero-based position of the button to show or hide.
}
338 \wxheading{Return value
}
340 {\tt true
} if the box or item has been shown or hidden or
{\tt false
} if nothing was
341 done because it already was in the requested state.
345 \helpref{wxWindow::Show
}{wxwindowshow
}
347 \pythonnote{In place of a single overloaded method name, wxPython
348 implements the following methods:
\par
349 \indented{2cm
}{\begin{twocollist
}
350 \twocolitem{{\bf Show(flag)
}}{Shows or hides the entire radiobox.
}
351 \twocolitem{{\bf ShowItem(n, flag)
}}{Shows or hides individual buttons.
}