ACCELTABLE Statement

The ACCELTABLE statement defines a table of accelerator keys for an application.

An accelerator is a keystroke defined by the application to give the user a quick way to perform a task. The WinGetMsg function automatically translates accelerator messages from the application queue into WM_COMMAND, WM_HELP, or WM_SYSCOMMAND messages.

The ACCELTABLE statement has the form:

 ───ACCELTABLE──┬──────┬────┬───────────┬───
                  └──id──┘    └─memoption─┘

 ────BEGIN───────────────────────────────────

   ┌────────────────────────────────────────┐
   │                        ┌──────,───────┐│
                                         ││
 ──┬───────┬─,─┬─────┬──,────acceloption──┴┴─
    └keyval─┘   └─cmd─┘

 ────END───

id (USHORT)

The resource identifier. This is either an integer in the range of 1 through 65535 or a unique string enclosed in double quote marks.
memoption
Optional. It consists of the following keyword or keywords, specifying whether the resource is fixed or movable, and whether it can be discarded:

FIXED

Resource remains at a fixed memory location.
MOVEABLE
Resource can be moved if necessary to compact memory.
DISCARDABLE
Resource can be discarded if no longer needed.
See Resource Load and Memory Options for a description of LOADOPTION.
keyval (USHORT)
The accelerator character code. This can be either a constant or a quoted character. If it is a quoted character, the CHAR acceloption is assumed. If the quoted character is preceded with a caret character (^), a control character is specified as if the CONTROL acceloption had been used.
cmd (USHORT)
The value of the WM_COMMAND, WM_HELP, or WM_SYSCOMMAND message generated from the accelerator for the indicated key.
acceloption (BIT_16)
Defines the kind of accelerator.

The following options are available:

ALT CHAR
CONTROL
HELP
LONEKEY
SCANCODE
SHIFT
SYSCOMMAND
VIRTUALKEY.

The VIRTUALKEY, SCANCODE, LONEKEY, and CHAR acceloptions specify the type of message that matches the accelerator. Only one of these options can be specified for each accelerator. For information on the corresponding KC_* values, see WM_CHAR.

The acceloptions SHIFT, CONTROL, and ALT, cause a match of the accelerator only if the corresponding key is down.

If there are two accelerators that use the same key with different SHIFT, CONTROL, or ALT options, the more restrictive accelerator should be specified first in the table. For example, Shift-Enter should be placed before Enter.

The SYSCOMMAND acceloption causes the keystroke to be passed to the application as a WM_SYSCOMMAND message. The HELP acceloption causes the keystroke to be passed to the application as a WM_HELP message. If neither is specified, a WM_COMMAND message is used.

Example:

ACCELTABLE "MainAcc"BEGIN
     VK_F1,101,HELP
     VK_F3,102,SYSCOMMAND
END

This generates a WM_HELP with value 101 from VIRTUALKEY accelerator F1 and a WM_SYSCOMMAND with value 102 from VIRTUALKEY accelerator F3.

---

[Back: Keyboard Resources]
[Next: ASSOCTABLE Statement]