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