1wxRadioBox(3)              Erlang Module Definition              wxRadioBox(3)
2
3
4

NAME

6       wxRadioBox - Functions for wxRadioBox class
7

DESCRIPTION

9       A  radio box item is used to select one of number of mutually exclusive
10       choices. It is displayed as a vertical column or horizontal row of  la‐
11       belled buttons.
12
13       Styles
14
15       This class supports the following styles:
16
17       See: Overview events, wxRadioButton, wxCheckBox
18
19       This  class is derived (and can use functions) from: wxControl wxWindow
20       wxEvtHandler
21
22       wxWidgets docs: wxRadioBox
23

EVENTS

25       Event types emitted from this class: command_radiobox_selected
26

DATA TYPES

28       wxRadioBox() = wx:wx_object()
29

EXPORTS

31       new(Parent, Id, Label, Pos, Size, Choices) -> wxRadioBox()
32
33              Types:
34
35                 Parent = wxWindow:wxWindow()
36                 Id = integer()
37                 Label = unicode:chardata()
38                 Pos = {X :: integer(), Y :: integer()}
39                 Size = {W :: integer(), H :: integer()}
40                 Choices = [unicode:chardata()]
41
42       new(Parent, Id, Label, Pos, Size, Choices, Options :: [Option]) ->
43              wxRadioBox()
44
45              Types:
46
47                 Parent = wxWindow:wxWindow()
48                 Id = integer()
49                 Label = unicode:chardata()
50                 Pos = {X :: integer(), Y :: integer()}
51                 Size = {W :: integer(), H :: integer()}
52                 Choices = [unicode:chardata()]
53                 Option =
54                     {majorDim, integer()} |
55                     {style, integer()} |
56                     {val, wx:wx_object()}
57
58              Constructor, creating and showing a radiobox.
59
60              See: create/8, wxValidator (not implemented in wx)
61
62       destroy(This :: wxRadioBox()) -> ok
63
64              Destructor, destroying the radiobox item.
65
66       create(This, Parent, Id, Label, Pos, Size, Choices) -> boolean()
67
68              Types:
69
70                 This = wxRadioBox()
71                 Parent = wxWindow:wxWindow()
72                 Id = integer()
73                 Label = unicode:chardata()
74                 Pos = {X :: integer(), Y :: integer()}
75                 Size = {W :: integer(), H :: integer()}
76                 Choices = [unicode:chardata()]
77
78       create(This, Parent, Id, Label, Pos, Size, Choices,
79              Options :: [Option]) ->
80                 boolean()
81
82              Types:
83
84                 This = wxRadioBox()
85                 Parent = wxWindow:wxWindow()
86                 Id = integer()
87                 Label = unicode:chardata()
88                 Pos = {X :: integer(), Y :: integer()}
89                 Size = {W :: integer(), H :: integer()}
90                 Choices = [unicode:chardata()]
91                 Option =
92                     {majorDim, integer()} |
93                     {style, integer()} |
94                     {val, wx:wx_object()}
95
96              Creates the radiobox for two-step construction.
97
98              See new/7 for further details.
99
100       enable(This) -> boolean()
101
102              Types:
103
104                 This = wxRadioBox()
105
106       enable(This, N) -> boolean()
107
108       enable(This, N :: [Option]) -> boolean()
109
110              Types:
111
112                 This = wxRadioBox()
113                 Option = {enable, boolean()}
114
115              Enables or disables the radiobox.
116
117              See: wxWindow:enable/2
118
119       enable(This, N, Options :: [Option]) -> boolean()
120
121              Types:
122
123                 This = wxRadioBox()
124                 N = integer()
125                 Option = {enable, boolean()}
126
127              Enables or disables an individual button in the radiobox.
128
129              See: wxWindow:enable/2
130
131       getSelection(This) -> integer()
132
133              Types:
134
135                 This = wxRadioBox()
136
137              Returns the index of the selected item or wxNOT_FOUND if no item
138              is selected.
139
140              Return: The position of the current selection.
141
142              Remark: This method can be used with single selection list boxes
143              only, you should  use  wxListBox:getSelections/1  for  the  list
144              boxes with wxLB_MULTIPLE style.
145
146              See: setSelection/2, wxControlWithItems:getStringSelection/1
147
148       getString(This, N) -> unicode:charlist()
149
150              Types:
151
152                 This = wxRadioBox()
153                 N = integer()
154
155              Returns the label of the item with the given index.
156
157              Return: The label of the item or an empty string if the position
158              was invalid.
159
160       setSelection(This, N) -> ok
161
162              Types:
163
164                 This = wxRadioBox()
165                 N = integer()
166
167              Sets the selection to the given item.
168
169              Notice that a radio box always has selection, so n must be valid
170              here and passing wxNOT_FOUND is not allowed.
171
172       show(This, Item) -> boolean()
173
174              Types:
175
176                 This = wxRadioBox()
177                 Item = integer()
178
179       show(This, Item, Options :: [Option]) -> boolean()
180
181              Types:
182
183                 This = wxRadioBox()
184                 Item = integer()
185                 Option = {show, boolean()}
186
187              Shows or hides individual buttons.
188
189              Return:  true  if  the item has been shown or hidden or false if
190              nothing was done because it already was in the requested state.
191
192              See: show/3
193
194       getColumnCount(This) -> integer()
195
196              Types:
197
198                 This = wxRadioBox()
199
200              Returns the number of columns in the radiobox.
201
202       getItemHelpText(This, Item) -> unicode:charlist()
203
204              Types:
205
206                 This = wxRadioBox()
207                 Item = integer()
208
209              Returns the helptext associated with the specified item  if  any
210              or wxEmptyString.
211
212              See: setItemHelpText/3
213
214       getItemToolTip(This, Item) -> wxToolTip:wxToolTip()
215
216              Types:
217
218                 This = wxRadioBox()
219                 Item = integer()
220
221              Returns the tooltip associated with the specified item if any or
222              NULL.
223
224              See: setItemToolTip/3, wxWindow:getToolTip/1
225
226       getItemFromPoint(This, Pt) -> integer()
227
228              Types:
229
230                 This = wxRadioBox()
231                 Pt = {X :: integer(), Y :: integer()}
232
233              Returns a radio box item under the point, a zero-based item  in‐
234              dex, or wxNOT_FOUND if no item is under the point.
235
236       getRowCount(This) -> integer()
237
238              Types:
239
240                 This = wxRadioBox()
241
242              Returns the number of rows in the radiobox.
243
244       isItemEnabled(This, N) -> boolean()
245
246              Types:
247
248                 This = wxRadioBox()
249                 N = integer()
250
251              Returns  true if the item is enabled or false if it was disabled
252              using enable/3.
253
254              This function is currently only  implemented  in  wxMSW,  wxGTK,
255              wxQT and wxUniversal and always returns true in the other ports.
256
257       isItemShown(This, N) -> boolean()
258
259              Types:
260
261                 This = wxRadioBox()
262                 N = integer()
263
264              Returns  true  if the item is currently shown or false if it was
265              hidden using show/3.
266
267              Note that this function returns true for an  item  which  hadn't
268              been hidden even if the entire radiobox is not currently shown.
269
270              This  function  is  currently  only implemented in wxMSW, wxGTK,
271              wxQT and wxUniversal and always returns true in the other ports.
272
273       setItemHelpText(This, Item, Helptext) -> ok
274
275              Types:
276
277                 This = wxRadioBox()
278                 Item = integer()
279                 Helptext = unicode:chardata()
280
281              Sets the helptext for an item.
282
283              Empty string erases any existing helptext.
284
285              See: getItemHelpText/2
286
287       setItemToolTip(This, Item, Text) -> ok
288
289              Types:
290
291                 This = wxRadioBox()
292                 Item = integer()
293                 Text = unicode:chardata()
294
295              Sets the tooltip text for the specified item in the radio group.
296
297              This function is currently only implemented in wxMSW and  wxGTK2
298              and does nothing in the other ports.
299
300              See: getItemToolTip/2, wxWindow:setToolTip/2
301
302
303
304wxWidgets team.                    wx 2.2.1                      wxRadioBox(3)