wxAcceleratorEntry — wx v2.4.3

Search documentation of wx

# View Source wxAcceleratorEntry (wx v2.4.3)

An object used by an application wishing to create an accelerator table (see `wxAcceleratorTable`).

See:

- `wxAcceleratorTable`

- `wxWindow:setAcceleratorTable/2`

wxWidgets docs: wxAcceleratorEntry

# Summary

## Types

wxAcceleratorEntry()

## Functions

destroy(This)

Destroys the object

getCommand(This)

Returns the command identifier for the accelerator table entry.

getFlags(This)

Returns the flags for the accelerator table entry.

getKeyCode(This)

Returns the keycode for the accelerator table entry.

new()

Equivalent to `new([])`.

new/1

Copy ctor.

set(This, Flags, KeyCode, Cmd)

Equivalent to `set(This, Flags, KeyCode, Cmd, [])`.

set/5

Sets the accelerator entry parameters.

# Types

Link to this type

# wxAcceleratorEntry()

View Source

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

# Functions

Link to this function

# destroy(This)

View Source

    -spec destroy(This :: wxAcceleratorEntry()) -> ok.

Destroys the object

Link to this function

# getCommand(This)

View Source

    -spec getCommand(This) -> integer() when This :: wxAcceleratorEntry().

Returns the command identifier for the accelerator table entry.

Link to this function

# getFlags(This)

View Source

    -spec getFlags(This) -> integer() when This :: wxAcceleratorEntry().

Returns the flags for the accelerator table entry.

Link to this function

# getKeyCode(This)

View Source

    -spec getKeyCode(This) -> integer() when This :: wxAcceleratorEntry().

Returns the keycode for the accelerator table entry.

Link to this function

# new()

View Source

    -spec new() -> wxAcceleratorEntry().

Equivalent to `new([])`.

Link to this function

# new/1

View Source

    -spec new([Option]) -> wxAcceleratorEntry()
                 when
                     Option ::
                         {flags, integer()} |
                         {keyCode, integer()} |
                         {cmd, integer()} |
                         {item, wxMenuItem:wxMenuItem()};
             (Entry) -> wxAcceleratorEntry() when Entry :: wxAcceleratorEntry().

Copy ctor.

Link to this function

# set(This, Flags, KeyCode, Cmd)

View Source

    -spec set(This, Flags, KeyCode, Cmd) -> ok
                 when
                     This :: wxAcceleratorEntry(),
                     Flags :: integer(),
                     KeyCode :: integer(),
                     Cmd :: integer().

Equivalent to `set(This, Flags, KeyCode, Cmd, [])`.

Link to this function

# set/5

View Source

    -spec set(This, Flags, KeyCode, Cmd, [Option]) -> ok
                 when
                     This :: wxAcceleratorEntry(),
                     Flags :: integer(),
                     KeyCode :: integer(),
                     Cmd :: integer(),
                     Option :: {item, wxMenuItem:wxMenuItem()}.

Sets the accelerator entry parameters.