An accelerator table allows the application to specify a table of keyboard shortcuts for menu or button commands.
The object wxNullAcceleratorTable is defined to be a table with no data, and is the initial accelerator table for a window.
Derived from
Include files
<wx/accel.h>
Predefined objects
Objects:
wxNullAcceleratorTable
Example
wxAcceleratorEntry entries[4];
entries[0].Set(wxACCEL_CTRL, (int) 'N', ID_NEW_WINDOW);
entries[1].Set(wxACCEL_CTRL, (int) 'X', wxID_EXIT);
entries[2].Set(wxACCEL_SHIFT, (int) 'A', ID_ABOUT);
entries[3].Set(wxACCEL_NORMAL, WXK_DELETE, wxID_CUT);
wxAcceleratorTable accel(4, entries);
frame->SetAcceleratorTable(accel);
Remarks
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' (but not in GTK+ at present).
See also
wxAcceleratorEntry, wxWindow::SetAcceleratorTable
Members
wxAcceleratorTable::wxAcceleratorTable
wxAcceleratorTable::~wxAcceleratorTable
wxAcceleratorTable::IsOk
wxAcceleratorTable::operator =
wxAcceleratorTable()
Default constructor.
wxAcceleratorTable(const wxAcceleratorTable& table)
Copy constructor, uses reference counting.
wxAcceleratorTable(int n, wxAcceleratorEntry entries[])
Creates from an array of wxAcceleratorEntry objects.
wxAcceleratorTable(const wxString& resource)
Loads the accelerator table from a Windows resource (Windows only).
Parameters
n
entries
resource
wxPython note: The wxPython constructor accepts a list of wxAcceleratorEntry objects, or 3-tuples consisting of flags, keyCode, and cmd values like you would construct wxAcceleratorEntry objects with.
wxPerl note: The wxPerl constructor accepts a list of either Wx::AcceleratorEntry objects or references to 3-element arrays ( flags, keyCode, cmd ), like the parameters of Wx::AcceleratorEntry::new.
~wxAcceleratorTable()
Destroys the wxAcceleratorTable object. See reference-counted object destruction for more info.
bool IsOk() const
Returns true if the accelerator table is valid.
wxAcceleratorTable& operator =(const wxAcceleratorTable& accel)
Assignment operator, using reference counting.
Parameters
accel
Return value
Returns a reference to this object.