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
|
.. 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.AcceleratorEntry:
==========================================================================================================================================
|phoenix_title| **wx.AcceleratorEntry**
==========================================================================================================================================
An object used by an application wishing to create an accelerator table (see :ref:`wx.AcceleratorTable`).
.. seealso:: :ref:`wx.AcceleratorTable`, :meth:`wx.Window.SetAcceleratorTable`
|
|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>AcceleratorEntry</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.AcceleratorEntry_inheritance.png" alt="Inheritance diagram of AcceleratorEntry" 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.AcceleratorEntry.html" title="wx.AcceleratorEntry" alt="" coords="5,5,152,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.AcceleratorEntry.__init__` Constructor.
:meth:`~wx.AcceleratorEntry.FromString` Parses the given string and sets the accelerator accordingly.
:meth:`~wx.AcceleratorEntry.GetCommand` Returns the command identifier for the accelerator table entry.
:meth:`~wx.AcceleratorEntry.GetFlags` Returns the flags for the accelerator table entry.
:meth:`~wx.AcceleratorEntry.GetKeyCode` Returns the keycode for the accelerator table entry.
:meth:`~wx.AcceleratorEntry.GetMenuItem` Returns the menu item associated with this accelerator entry.
:meth:`~wx.AcceleratorEntry.IsOk` Returns ``True`` if this object is correctly initialized.
:meth:`~wx.AcceleratorEntry.Set` Sets the accelerator entry parameters.
:meth:`~wx.AcceleratorEntry.ToRawString` Returns a textual representation of this accelerator which is appropriate for saving in configuration files.
:meth:`~wx.AcceleratorEntry.ToString` Returns a textual representation of this accelerator.
:meth:`~wx.AcceleratorEntry.__ne__`
:meth:`~wx.AcceleratorEntry.__eq__`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.AcceleratorEntry.Command` See :meth:`~wx.AcceleratorEntry.GetCommand`
:attr:`~wx.AcceleratorEntry.Flags` See :meth:`~wx.AcceleratorEntry.GetFlags`
:attr:`~wx.AcceleratorEntry.KeyCode` See :meth:`~wx.AcceleratorEntry.GetKeyCode`
:attr:`~wx.AcceleratorEntry.MenuItem` See :meth:`~wx.AcceleratorEntry.GetMenuItem`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.AcceleratorEntry(object)
**Possible constructors**::
AcceleratorEntry(flags=0, keyCode=0, cmd=0, item=None)
AcceleratorEntry(entry)
An object used by an application wishing to create an accelerator
table (see AcceleratorTable).
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self, flags=0, keyCode=0, cmd=0, item=None)`
Constructor.
:param `flags`: A combination of the :ref:`wx.AcceleratorEntryFlags` values, which indicates which modifier keys are held down.
:type `flags`: int
:param `keyCode`: The keycode to be detected. See :ref:`wx.KeyCode` for a full list of keycodes.
:type `keyCode`: int
:param `cmd`: The menu or control command identifier (``ID``).
:type `cmd`: int
:param `item`: The menu item associated with this accelerator.
:type `item`: wx.MenuItem
**~~~**
**__init__** `(self, entry)`
Copy constructor.
:param `entry`:
:type `entry`: wx.AcceleratorEntry
**~~~**
.. method:: FromString(self, str)
Parses the given string and sets the accelerator accordingly.
:param `str`: This string may be either in the same format as returned by :ref:`wx.ToString`, i.e. contain the accelerator itself only, or have the format of a full menu item text with i.e. ``Label TAB Accelerator`` . In the latter case, the part of the string before the ``TAB`` is ignored. Notice that the latter format is only supported for the compatibility with the previous wxWidgets versions and the new code should pass only the accelerator string itself to this function.
:type `str`: string
:rtype: `bool`
:returns:
``True`` if the given string correctly initialized this object (i.e. if :meth:`IsOk` returns ``True`` after this call)
.. method:: GetCommand(self)
Returns the command identifier for the accelerator table entry.
:rtype: `int`
.. method:: GetFlags(self)
Returns the flags for the accelerator table entry.
:rtype: `int`
.. method:: GetKeyCode(self)
Returns the keycode for the accelerator table entry.
:rtype: `int`
.. method:: GetMenuItem(self)
Returns the menu item associated with this accelerator entry.
:rtype: :ref:`wx.MenuItem`
.. method:: IsOk(self)
Returns ``True`` if this object is correctly initialized.
:rtype: `bool`
.. method:: Set(self, flags, keyCode, cmd, item=None)
Sets the accelerator entry parameters.
:param `flags`: A combination of the :ref:`wx.AcceleratorEntryFlags` values, which indicates which modifier keys are held down.
:type `flags`: int
:param `keyCode`: The keycode to be detected. See :ref:`wx.KeyCode` for a full list of keycodes.
:type `keyCode`: int
:param `cmd`: The menu or control command identifier (``ID``).
:type `cmd`: int
:param `item`: The menu item associated with this accelerator.
:type `item`: wx.MenuItem
.. method:: ToRawString(self)
Returns a textual representation of this accelerator which is appropriate for saving in configuration files.
Unlike the string returned by :ref:`wx.ToString`, this one is never translated so, while it's not suitable for showing to the user, it can be used to uniquely identify the accelerator independently of the user language.
The returned string can still be parsed by :ref:`wx.FromString`.
:rtype: `string`
.. versionadded:: 2.9.4
.. method:: ToString(self)
Returns a textual representation of this accelerator.
The returned string is of the form ``[Alt+][Ctrl+][RawCtrl+][Shift+]Key`` where the modifier keys are present only if the corresponding flag is set.
:rtype: `string`
.. method:: __ne__(self)
:param `entry`:
:type `entry`: wx.AcceleratorEntry
.. method:: __eq__(self)
:param `entry`:
:type `entry`: wx.AcceleratorEntry
.. attribute:: Command
See :meth:`~wx.AcceleratorEntry.GetCommand`
.. attribute:: Flags
See :meth:`~wx.AcceleratorEntry.GetFlags`
.. attribute:: KeyCode
See :meth:`~wx.AcceleratorEntry.GetKeyCode`
.. attribute:: MenuItem
See :meth:`~wx.AcceleratorEntry.GetMenuItem`
|
