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
338
339
340
341
342
343
344
345
346
347
348
349
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.ToggleButton:
==========================================================================================================================================
|phoenix_title| **wx.ToggleButton**
==========================================================================================================================================
:ref:`wx.ToggleButton` is a button that stays pressed when clicked by the user.
In other words, it is similar to :ref:`wx.CheckBox` in functionality but looks like a :ref:`wx.Button`.
Since wxWidgets version 2.9.0 this control emits an update UI event.
You can see :ref:`wx.ToggleButton` in action in :ref:`Widgets Sample <widgets sample>`.
^^
.. _ToggleButton-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.CommandEvent` parameter.
- EVT_TOGGLEBUTTON: Handles a wxEVT_TOGGLEBUTTON event. ^^
.. seealso:: :ref:`wx.CheckBox`, :ref:`wx.Button`, :ref:`wx.BitmapToggleButton`
|
|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>ToggleButton</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.ToggleButton_inheritance.png" alt="Inheritance diagram of ToggleButton" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.ToggleButton.html" title="wx.ToggleButton" alt="" coords="43,392,174,421"/> <area shape="rect" id="node2" href="wx.AnyButton.html" title="wx.AnyButton" alt="" coords="52,315,165,344"/> <area shape="rect" id="node3" href="wx.Control.html" title="wx.Control" alt="" coords="63,237,155,267"/> <area shape="rect" id="node4" href="wx.Window.html" title="wx.Window" alt="" coords="60,160,157,189"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="50,83,167,112"/> <area shape="rect" id="node6" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,92,35"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="117,5,223,35"/> </map>
</p>
</div>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.togglebutton.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/wx.togglebutton.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.togglebutton.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.BitmapToggleButton`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ToggleButton.__init__` Default constructor.
:meth:`~wx.ToggleButton.Create` Creates the toggle button for two-step construction.
:meth:`~wx.ToggleButton.GetClassDefaultAttributes`
:meth:`~wx.ToggleButton.GetValue` Gets the state of the toggle button.
:meth:`~wx.ToggleButton.SetValue` Sets the toggle button to the given state.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.ToggleButton.Value` See :meth:`~wx.ToggleButton.GetValue` and :meth:`~wx.ToggleButton.SetValue`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ToggleButton(AnyButton)
**Possible constructors**::
ToggleButton()
ToggleButton(parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition,
size=DefaultSize, style=0, val=DefaultValidator, name=CheckBoxNameStr)
ToggleButton is a button that stays pressed when clicked by the
user.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self)`
Default constructor.
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, val=DefaultValidator, name=CheckBoxNameStr)`
Constructor, creating and showing a toggle button.
:param `parent`: Parent window. Must not be ``None``.
:type `parent`: wx.Window
:param `id`: Toggle button identifier. The value ``wx.ID_ANY`` indicates a default value.
:type `id`: wx.WindowID
:param `label`: Text to be displayed next to the toggle button.
:type `label`: string
:param `pos`: Toggle button position. If :ref:`wx.DefaultPosition` is specified then a default position is chosen.
:type `pos`: wx.Point
:param `size`: Toggle button size. If :ref:`wx.DefaultSize` is specified then a default size is chosen.
:type `size`: wx.Size
:param `style`: Window style. See :ref:`wx.ToggleButton`.
:type `style`: long
:param `val`: Window validator.
:type `val`: wx.Validator
:param `name`: Window name.
:type `name`: string
.. seealso:: :meth:`Create` , :ref:`wx.Validator`
:html:`<hr class="overloadsep" /><br />`
.. method:: Create(self, parent, id=ID_ANY, label=EmptyString, pos=DefaultPosition, size=DefaultSize, style=0, val=DefaultValidator, name=CheckBoxNameStr)
Creates the toggle button for two-step construction.
See :ref:`wx.ToggleButton` for 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 `val`:
:type `val`: wx.Validator
:param `name`:
:type `name`: string
:rtype: `bool`
.. staticmethod:: GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
:param `variant`:
:type `variant`: wx.WindowVariant
:rtype: :ref:`wx.VisualAttributes`
.. method:: GetValue(self)
Gets the state of the toggle button.
:rtype: `bool`
:returns:
Returns ``True`` if it is pressed, ``False`` otherwise.
.. method:: SetValue(self, state)
Sets the toggle button to the given state.
This does not cause a ``EVT_TOGGLEBUTTON`` event to be emitted.
:param `state`: If ``True``, the button is pressed.
:type `state`: bool
.. attribute:: Value
See :meth:`~wx.ToggleButton.GetValue` and :meth:`~wx.ToggleButton.SetValue`
|
