1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.RadioButton:
==========================================================================================================================================
|phoenix_title| **wx.RadioButton**
==========================================================================================================================================
A radio button item is a button which usually denotes one of several mutually exclusive options.
It has a text label next to a (usually) round button.
You can create a group of mutually-exclusive radio buttons by specifying ``RB_GROUP`` for the first in the group. The group ends when another radio button group is created, or there are no more radio buttons.
.. _RadioButton-styles:
|styles| Window Styles
================================
This class supports the following styles:
- ``wx.RB_GROUP``: Marks the beginning of a new group of radio buttons.
- ``wx.RB_SINGLE``: In some circumstances, radio buttons that are not consecutive siblings trigger a hang bug in Windows (only). If this happens, add this style to mark the button as not belonging to a group, and implement the mutually-exclusive group behaviour yourself.
.. _RadioButton-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.CommandEvent` parameter.
- EVT_RADIOBUTTON: Process a ``wxEVT_RADIOBUTTON`` event, when the radiobutton is clicked.
.. seealso:: :ref:`Events and Event Handling <events and event handling>`, :ref:`wx.RadioBox`, :ref:`wx.CheckBox`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>RadioButton</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.RadioButton_inheritance.png" alt="Inheritance diagram of RadioButton" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Control.html" title="wx.Control" alt="" coords="60,237,148,267"/> <area shape="rect" id="node3" href="wx.RadioButton.html" title="wx.RadioButton" alt="" coords="44,315,164,344"/> <area shape="rect" id="node2" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node6" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> </map>
</p>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.radiobutton.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/wx.radiobutton.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.radiobutton.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.RadioButton.__init__` Default constructor.
:meth:`~wx.RadioButton.Create` Creates the choice for two-step construction.
:meth:`~wx.RadioButton.GetValue` Returns ``True`` if the radio button is checked, ``False`` otherwise.
:meth:`~wx.RadioButton.SetValue` Sets the radio button to checked or unchecked status.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.RadioButton.Value` See :meth:`~wx.RadioButton.GetValue` and :meth:`~wx.RadioButton.SetValue`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.RadioButton(Control)
**Possible constructors**::
RadioButton()
RadioButton(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition,
size=DefaultSize, style=0, validator=DefaultValidator,
name=RadioButtonNameStr)
A radio button item is a button which usually denotes one of several
mutually exclusive options.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
.. seealso:: :meth:`Create` , :ref:`wx.Validator`
**~~~**
**__init__** `(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=RadioButtonNameStr)`
Constructor, creating and showing a radio button.
:param `parent`: Parent window. Must not be ``None``.
:type `parent`: wx.Window
:param `id`: Window identifier. The value ``ID_ANY`` indicates a default value.
:type `id`: wx.WindowID
:param `label`: Label for the radio button.
:type `label`: string
:param `pos`: Window position. If :ref:`wx.DefaultPosition` is specified then a default position is chosen.
:type `pos`: wx.Point
:param `size`: Window size. If :ref:`wx.DefaultSize` is specified then a default size is chosen.
:type `size`: wx.Size
:param `style`: Window style. See :ref:`wx.RadioButton`.
:type `style`: long
:param `validator`: Window validator.
:type `validator`: wx.Validator
:param `name`: Window name.
:type `name`: string
.. seealso:: :meth:`Create` , :ref:`wx.Validator`
**~~~**
.. method:: Create(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=RadioButtonNameStr)
Creates the choice for two-step construction.
See :ref:`wx.RadioButton` for further details.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `label`:
:type `label`: string
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `validator`:
:type `validator`: wx.Validator
:param `name`:
:type `name`: string
:rtype: `bool`
.. method:: GetValue(self)
Returns ``True`` if the radio button is checked, ``False`` otherwise.
:rtype: `bool`
.. method:: SetValue(self, value)
Sets the radio button to checked or unchecked status.
This does not cause a ``wxEVT_RADIOBUTTON`` event to get emitted.
If the radio button belongs to a radio group exactly one button in the group may be checked and so this method can be only called with `value` set to ``True``. To uncheck a radio button in a group you must check another button in the same group.
:param `value`: ``True`` to check, ``False`` to uncheck.
:type `value`: bool
.. attribute:: Value
See :meth:`~wx.RadioButton.GetValue` and :meth:`~wx.RadioButton.SetValue`
|
