.. include:: headings.inc



.. _AcceleratorTable:

==========================================================================================================================================
|phoenix_title|  **AcceleratorTable**
==========================================================================================================================================

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

The object ``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, 'N', ID_NEW_WINDOW)
    entries[1].Set(wx.ACCEL_CTRL, 'X', wx.ID_EXIT)
    entries[2].Set(wx.ACCEL_SHIFT, '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 '``OK``'.  







.. seealso:: :ref:`AcceleratorEntry`, :meth:`Window.SetAcceleratorTable`     







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **AcceleratorTable**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/AcceleratorTable_inheritance.png" alt="Inheritance diagram of AcceleratorTable" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,77,35"/> <area shape="rect" id="node2" href="AcceleratorTable.html" title="An accelerator table allows the application to specify a table of keyboard shortcuts for menu or button commands." alt="" coords="127,5,271,35"/> </map> 
   </p>

|


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

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


|


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

.. class:: AcceleratorTable(Object)

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

       AcceleratorTable()
       
       AcceleratorTable(entries)
       



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



      |overload| **Overloaded Implementations**:

      **~~~**

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

      
      **__init__** `(self, entries)`
      
      ``TODO``  
      
      
      
      
      **~~~**






   .. method:: IsOk(self)

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

      :rtype: `bool`