| Version: 3.2.5

Public Member Functions | List of all members
wxAcceleratorTable Class Reference
Class List by Category » Data Structures

`#include <wx/accel.h>`

Inheritance diagram for wxAcceleratorTable:
[legend]

## Detailed Description

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.

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);
wxACCEL_CTRL
@ wxACCEL_CTRL
hold Ctrl key down, corresponds to Command key on macOS
Definition: accel.h:19
wxACCEL_NORMAL
@ wxACCEL_NORMAL
no modifiers
Definition: accel.h:13
wxACCEL_SHIFT
@ wxACCEL_SHIFT
hold Shift key down
Definition: accel.h:22
wxAcceleratorEntry
An object used by an application wishing to create an accelerator table (see wxAcceleratorTable).
Definition: accel.h:44
wxAcceleratorEntry::Set
void Set(int flags, int keyCode, int cmd, wxMenuItem *item=NULL)
Sets the accelerator entry parameters.
wxAcceleratorTable
An accelerator table allows the application to specify a table of keyboard shortcuts for menu or butt...
Definition: accel.h:192
WXK_DELETE
@ WXK_DELETE
Definition: defs.h:918
wxID_EXIT
@ wxID_EXIT
Definition: defs.h:612
wxID_CUT
@ wxID_CUT
Definition: defs.h:631

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'.

##

Library: wxCore
Category: Data Structures

Predefined objects/pointers: wxNullAcceleratorTable

See also
  wxAcceleratorEntry, wxWindow::SetAcceleratorTable

## Public Member Functions

| wxAcceleratorTable ()
| Default ctor. More...
| wxAcceleratorTable (int n, const wxAcceleratorEntry entries[])
| Initializes the accelerator table from an array of wxAcceleratorEntry. More...
| wxAcceleratorTable (const wxString &resource)
| Loads the accelerator table from a Windows resource (Windows only). More...
virtual | ~wxAcceleratorTable ()
| Destroys the wxAcceleratorTable object. More...
bool | IsOk () const
| Returns true if the accelerator table is valid. More...
Public Member Functions inherited from wxObject
| wxObject ()
| Default ctor; initializes to NULL the internal reference data. More...
| wxObject (const wxObject &other)
| Copy ctor. More...
virtual | ~wxObject ()
| Destructor. More...
virtual wxClassInfo * | GetClassInfo () const
| This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
wxObjectRefData * | GetRefData () const
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
bool | IsKindOf (const wxClassInfo *info) const
| Determines whether this class is a subclass of (or the same class as) the given class. More...
bool | IsSameAs (const wxObject &obj) const
| Returns true if this object has the same data pointer as obj. More...
void | Ref (const wxObject &clone)
| Makes this object refer to the data in clone. More...
void | SetRefData (wxObjectRefData *data)
| Sets the wxObject::m_refData pointer. More...
void | UnRef ()
| Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
void | UnShare ()
| This is the same of AllocExclusive() but this method is public. More...
void | operator delete (void *buf)
| The delete operator is defined for debugging versions of the library only, when the identifier `__WXDEBUG__` is defined. More...
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
| The new operator is defined for debugging versions of the library only, when the identifier `__WXDEBUG__` is defined. More...

## Additional Inherited Members

Protected Member Functions inherited from wxObject
void | AllocExclusive ()
| Ensure that this object's data is not shared with any other object. More...
virtual wxObjectRefData * | CreateRefData () const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const
| Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
Protected Attributes inherited from wxObject
wxObjectRefData * | m_refData
| Pointer to an object which is the object's reference-counted data. More...

## Constructor & Destructor Documentation

## ◆ wxAcceleratorTable() [1/3]

wxAcceleratorTable::wxAcceleratorTable | ( |  | ) |

Default ctor.

## ◆ wxAcceleratorTable() [2/3]

wxAcceleratorTable::wxAcceleratorTable | ( | int | n,
|  | const wxAcceleratorEntry | entries[]
| ) |  |

Initializes the accelerator table from an array of wxAcceleratorEntry.

Parameters

  n | Number of accelerator entries.
  entries | The array of entries.

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() [3/3]

wxAcceleratorTable::wxAcceleratorTable | ( | const wxString & | resource | ) |

Loads the accelerator table from a Windows resource (Windows only).

Availability: only available for the wxMSW port.

Parameters

  resource | Name of a Windows accelerator.

## ◆ ~wxAcceleratorTable()

virtual wxAcceleratorTable::~wxAcceleratorTable | ( |  | ) |

virtual

Destroys the wxAcceleratorTable object.

See Object Destruction for more info.

## Member Function Documentation

## ◆ IsOk()

bool wxAcceleratorTable::IsOk | ( |  | ) | const

Returns true if the accelerator table is valid.