View Source wxAcceleratorTable (wx v2.4.2)
Functions for wxAcceleratorTable class
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:
Remark: 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'.
Predefined objects (include wx.hrl): ?wxNullAcceleratorTable
See: wxAcceleratorEntry
, wxWindow:setAcceleratorTable/2
wxWidgets docs: wxAcceleratorTable
Summary
Functions
Destroys the wxAcceleratorTable
object.
Returns true if the accelerator table is valid.
Default ctor.
Initializes the accelerator table from an array of wxAcceleratorEntry
.
Types
-type wxAcceleratorTable() :: wx:wx_object().
Functions
-spec destroy(This :: wxAcceleratorTable()) -> ok.
Destroys the wxAcceleratorTable
object.
See overview_refcount_destruct for more info.
-spec isOk(This) -> boolean() when This :: wxAcceleratorTable().
Returns true if the accelerator table is valid.
-spec new() -> wxAcceleratorTable().
Default ctor.
-spec new(N, Entries) -> wxAcceleratorTable() when N :: integer(), Entries :: [wxAcceleratorEntry:wxAcceleratorEntry()].
Initializes the accelerator table from an array of wxAcceleratorEntry
.
-spec ok(This) -> boolean() when This :: wxAcceleratorTable().
See: isOk/1
.