wxAcceleratorTable (wx v2.5.4)

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:

wxWidgets docs: wxAcceleratorTable

Summary

Types

wxAcceleratorTable()

Functions

destroy(This)

Destroys the object

isOk(This)

Returns true if the accelerator table is valid.

new()

Default ctor.

new(N, Entries)

Initializes the accelerator table from an array of wxAcceleratorEntry.

ok(This)

Equivalent to: isOk/1

Types

wxAcceleratorTable()

-type wxAcceleratorTable() :: wx:wx_object().

Functions

destroy(This :: wxAcceleratorTable()) -> ok

Destroys the object

isOk(This :: wxAcceleratorTable()) -> boolean()

Returns true if the accelerator table is valid.

new() -> Result

Types

Result = wxAcceleratorTable()

Default ctor.

new(N, Entries) -> Result

Types

N = integer()

Entries = [wxAcceleratorEntry:wxAcceleratorEntry()]

Result = wxAcceleratorTable()

Initializes the accelerator table from an array of wxAcceleratorEntry.

ok(This :: wxAcceleratorTable()) -> boolean()

Equivalent to: isOk/1