Phoenix Logo

phoenix_title wx.AcceleratorTable

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

The object 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’.


class_hierarchy Class Hierarchy

Inheritance diagram for class AcceleratorTable:


method_summary Methods Summary

__init__ Default constructor.
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.


Methods



__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).





IsOk(self)

Returns True if the accelerator table is valid.

Return type:bool