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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
|
.. 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.KeyboardState:
==========================================================================================================================================
|phoenix_title| **wx.KeyboardState**
==========================================================================================================================================
Provides methods for testing the state of the keyboard modifier keys.
This class is used as a base class of :ref:`wx.KeyEvent` and :ref:`wx.MouseState` and, hence, indirectly, of :ref:`wx.MouseEvent`, so its methods may be used to get information about the modifier keys which were pressed when the event occurred.
This class is implemented entirely inline in <:ref:`/kbdstate.h`> and thus has no linking requirements.
.. seealso:: :ref:`wx.KeyEvent`, :ref:`wx.MouseState`
|
|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>KeyboardState</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.KeyboardState_inheritance.png" alt="Inheritance diagram of KeyboardState" 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.KeyboardState.html" title="wx.KeyboardState" alt="" coords="4,5,139,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.KeyEvent`, :ref:`wx.MouseState`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.KeyboardState.__init__` Constructor initializes the modifier key settings.
:meth:`~wx.KeyboardState.AltDown` Returns ``True`` if the Alt key is pressed.
:meth:`~wx.KeyboardState.CmdDown` Returns ``True`` if the key used for command accelerators is pressed.
:meth:`~wx.KeyboardState.ControlDown` Returns ``True`` if the Control key or Apple/Command key under OS X is pressed.
:meth:`~wx.KeyboardState.GetModifiers` Return the bit mask of all pressed modifier keys.
:meth:`~wx.KeyboardState.HasAnyModifiers` Returns ``True`` if any modifiers at all are pressed.
:meth:`~wx.KeyboardState.HasModifiers` Returns ``True`` if Control or Alt are pressed.
:meth:`~wx.KeyboardState.MetaDown` Returns ``True`` if the Meta/Windows/Apple key is pressed.
:meth:`~wx.KeyboardState.RawControlDown` Returns ``True`` if the Control key (also under OS X).
:meth:`~wx.KeyboardState.SetAltDown`
:meth:`~wx.KeyboardState.SetControlDown`
:meth:`~wx.KeyboardState.SetMetaDown`
:meth:`~wx.KeyboardState.SetRawControlDown`
:meth:`~wx.KeyboardState.SetShiftDown`
:meth:`~wx.KeyboardState.ShiftDown` Returns ``True`` if the Shift key is pressed.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.KeyboardState.altDown` See :meth:`~wx.KeyboardState.AltDown` and :meth:`~wx.KeyboardState.SetAltDown`
:attr:`~wx.KeyboardState.cmdDown` See :meth:`~wx.KeyboardState.CmdDown`
:attr:`~wx.KeyboardState.controlDown` See :meth:`~wx.KeyboardState.ControlDown` and :meth:`~wx.KeyboardState.SetControlDown`
:attr:`~wx.KeyboardState.metaDown` See :meth:`~wx.KeyboardState.MetaDown` and :meth:`~wx.KeyboardState.SetMetaDown`
:attr:`~wx.KeyboardState.rawControlDown` See :meth:`~wx.KeyboardState.RawControlDown` and :meth:`~wx.KeyboardState.SetRawControlDown`
:attr:`~wx.KeyboardState.shiftDown` See :meth:`~wx.KeyboardState.ShiftDown` and :meth:`~wx.KeyboardState.SetShiftDown`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.KeyboardState(object)
**Possible constructors**::
KeyboardState(controlDown=False, shiftDown=False, altDown=False,
metaDown=False)
Provides methods for testing the state of the keyboard modifier keys.
.. method:: __init__(self, controlDown=False, shiftDown=False, altDown=False, metaDown=False)
Constructor initializes the modifier key settings.
By default, no modifiers are active.
:param `controlDown`:
:type `controlDown`: bool
:param `shiftDown`:
:type `shiftDown`: bool
:param `altDown`:
:type `altDown`: bool
:param `metaDown`:
:type `metaDown`: bool
.. method:: AltDown(self)
Returns ``True`` if the Alt key is pressed.
Notice that :meth:`GetModifiers` should usually be used instead of this one.
:rtype: `bool`
.. method:: CmdDown(self)
Returns ``True`` if the key used for command accelerators is pressed.
Same as :meth:`ControlDown` . Deprecated.
Notice that :meth:`GetModifiers` should usually be used instead of this one.
:rtype: `bool`
.. method:: ControlDown(self)
Returns ``True`` if the Control key or Apple/Command key under OS X is pressed.
This function doesn't distinguish between right and left control keys.
Notice that :meth:`GetModifiers` should usually be used instead of this one.
:rtype: `bool`
.. method:: GetModifiers(self)
Return the bit mask of all pressed modifier keys.
The return value is a combination of ``MOD_ALT`` , ``MOD_CONTROL`` , ``MOD_SHIFT`` and ``MOD_META`` bit masks. Additionally, ``MOD_NONE`` is defined as 0, i.e. corresponds to no modifiers (see :meth:`HasAnyModifiers` ) and ``MOD_CMD`` is either ``MOD_CONTROL`` (MSW and Unix) or ``MOD_META`` (Mac), see :meth:`CmdDown` . See :ref:`wx.KeyModifier` for the full list of modifiers.
Notice that this function is easier to use correctly than, for example, :meth:`ControlDown` because when using the latter you also have to remember to test that none of the other modifiers is pressed:
::
if ControlDown() and not AltDown() and not ShiftDown() and not MetaDown():
# handle Ctrl-XXX ...
HandleControl()
and forgetting to do it can result in serious program bugs (e.g. program not working with European keyboard layout where ``AltGr`` key which is seen by the program as combination of ``CTRL`` and ``ALT`` is used). On the other hand, you can simply write:
::
if GetModifiers() == wx.MOD_CONTROL:
# handle Ctrl-XXX ...
HandleControl()
with this function.
:rtype: `int`
.. method:: HasAnyModifiers(self)
Returns ``True`` if any modifiers at all are pressed.
This is equivalent to :meth:`GetModifiers` ``!=`` ``MOD_NONE`` .
Notice that this is different from :meth:`HasModifiers` method which doesn't take e.g. Shift modifier into account. This method is most suitable for mouse events when any modifier, including Shift, can change the interpretation of the event.
:rtype: `bool`
.. versionadded:: 2.9.5
.. method:: HasModifiers(self)
Returns ``True`` if Control or Alt are pressed.
Checks if Control, Alt or, under OS X only, Command key are pressed (notice that the real Control key is still taken into account under OS X too).
This method returns ``False`` if only Shift is pressed for compatibility reasons and also because pressing Shift usually doesn't change the interpretation of key events, see :meth:`HasAnyModifiers` if you want to take Shift into account as well.
:rtype: `bool`
.. method:: MetaDown(self)
Returns ``True`` if the Meta/Windows/Apple key is pressed.
This function tests the state of the key traditionally called Meta under Unix systems, Windows keys under MSW Notice that :meth:`GetModifiers` should usually be used instead of this one.
:rtype: `bool`
.. seealso:: :meth:`CmdDown`
.. method:: RawControlDown(self)
Returns ``True`` if the Control key (also under OS X).
This function doesn't distinguish between right and left control keys.
Notice that :meth:`GetModifiers` should usually be used instead of this one.
:rtype: `bool`
.. method:: SetAltDown(self, down)
:param `down`:
:type `down`: bool
.. method:: SetControlDown(self, down)
:param `down`:
:type `down`: bool
.. method:: SetMetaDown(self, down)
:param `down`:
:type `down`: bool
.. method:: SetRawControlDown(self, down)
:param `down`:
:type `down`: bool
.. method:: SetShiftDown(self, down)
:param `down`:
:type `down`: bool
.. method:: ShiftDown(self)
Returns ``True`` if the Shift key is pressed.
This function doesn't distinguish between right and left shift keys.
Notice that :meth:`GetModifiers` should usually be used instead of this one.
:rtype: `bool`
.. attribute:: altDown
See :meth:`~wx.KeyboardState.AltDown` and :meth:`~wx.KeyboardState.SetAltDown`
.. attribute:: cmdDown
See :meth:`~wx.KeyboardState.CmdDown`
.. attribute:: controlDown
See :meth:`~wx.KeyboardState.ControlDown` and :meth:`~wx.KeyboardState.SetControlDown`
.. attribute:: metaDown
See :meth:`~wx.KeyboardState.MetaDown` and :meth:`~wx.KeyboardState.SetMetaDown`
.. attribute:: rawControlDown
See :meth:`~wx.KeyboardState.RawControlDown` and :meth:`~wx.KeyboardState.SetRawControlDown`
.. attribute:: shiftDown
See :meth:`~wx.KeyboardState.ShiftDown` and :meth:`~wx.KeyboardState.SetShiftDown`
|
