File: wx.AcceleratorTable.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (169 lines) | stat: -rw-r--r-- 4,393 bytes parent folder | download
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
.. 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.AcceleratorTable:

==========================================================================================================================================
|phoenix_title|  **wx.AcceleratorTable**
==========================================================================================================================================

An accelerator table allows the application to specify a table of keyboard shortcuts for menu or button commands.          

The object :ref:`wx.NullAcceleratorTable`  is defined to be a table with no data, and is the initial accelerator table for a window. 

Example: 

::

    entries = [wx.AcceleratorEntry() for i in xrange(4)]

    entries[0].Set(wx.ACCEL_CTRL, ord('N'), ID_NEW_WINDOW)
    entries[1].Set(wx.ACCEL_CTRL, ord('X'), wx.ID_EXIT)
    entries[2].Set(wx.ACCEL_SHIFT, ord('A'), ID_ABOUT)
    entries[3].Set(wx.ACCEL_NORMAL, wx.WXK_DELETE, wx.ID_CUT)

    accel = wx.AcceleratorTable(entries)
    frame.SetAcceleratorTable(accel)











         



.. note:: 

   An accelerator takes precedence over normal processing and can be a convenient way to program some event handling. For example, you can use an accelerator table to enable a dialog with a multi-line text control to accept CTRL-Enter as meaning '``wx.OK``'.  







.. seealso:: :ref:`wx.AcceleratorEntry`, :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>AcceleratorTable</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.AcceleratorTable_inheritance.png" alt="Inheritance diagram of AcceleratorTable" 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.Object.html" title="wx.Object" alt="" coords="37,5,119,35"/> <area shape="rect" id="node2" href="wx.AcceleratorTable.html" title="wx.AcceleratorTable" alt="" coords="5,83,152,112"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.AcceleratorTable.__init__`                                            Default constructor.
:meth:`~wx.AcceleratorTable.IsOk`                                                Returns ``True`` if the accelerator table is valid.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.AcceleratorTable(Object)

   **Possible constructors**::

       AcceleratorTable()
       
       AcceleratorTable(entries)
       
   
   An accelerator table allows the application to specify a table of
   keyboard shortcuts for menu or button commands.



   .. method:: __init__(self, *args, **kw)



      |overload| Overloaded Implementations:

      **~~~**

      
      **__init__** `(self)`
      
      Default constructor.                   
      
      
      
      
      **~~~**

      
      **__init__** `(self, entries)`
      
                              Constructs an AcceleratorTable from a sequence of items
                              where each item is either a wx.AcceleratorEntry or a 
                              corresponding 3-element tuple like (modifiers, keyCode, cmd).
                                
      
      
      
      
      **~~~**






   .. method:: IsOk(self)

      Returns ``True`` if the accelerator table is valid.                  

      :rtype: `bool`