Home | Categories | Alphabetical | Classes | All Contents | [ < ] | [ > ]

IDLitWindow::OnKeyboard


Syntax | Arguments | Keywords | Version History

The IDLitWindow::OnKeyboard procedure method handles notification (from the native window device) that a keyboard event has occurred, and passes along that notification to all observers in the list of window event observers. With proper event handling, these values are passed into the procedure arguments. Alternatively, keyboard events can be simulated by calling this method directly.

Syntax

Obj->[IDLitWindow::]OnKeyboard, IsASCII, Character, KeySymbol, X, Y, Press, Release, Modifiers

Arguments

IsASCII

A scalar value that indicates whether the keyboard event corresponds to a character in the ASCII character set. If IsASCII is non-zero, the Character argument will be set to that ASCII character. If IsASCII is zero, the KeySymbol argument will be set to a numeric value indicating the key that was pressed.

Character

If IsASCII is non-zero, this argument is set to the ASCII character that corresponds to the key that was pressed. Otherwise, this argument is set to zero.

KeySymbol

If IsASCII is zero, this argument is set to an unsigned long integer that indicates the key that was pressed. Otherwise, this argument is set to zero. Valid values for key symbols include:

X,Y

The x-coordinate and y-coordinate of the mouse cursor (in device coordinates) at the time of the event.

Press

A scalar value indicating whether this event represents a key press. This argument is non-zero if the event is the result of pressing the key.

Release

A scalar value indicating whether this event represents a key release. This argument is non-zero if the event is the result of releasing the key.

Modifiers

A bitwise mask indicating which modifier keys are active at the time of the keyboard event. If a bit is zero, the key is up; if the bit is set, the key is pressed. The following table describes the bits in this bit mask:

Bit
Value
Modifier Key
0 1 Shift
1 2 Control
2 4 Caps Lock
3 8 Alt

Keywords

None

Version History

Introduced: 6.0

Corrected syntax to read IsASCII instead of IsAlphaNumeric, corrected KeySymbol values, added X, Y, Press, Release, and Modifiers arguments: 6.1


Home | Categories | Alphabetical | Classes | All Contents | [ < ] | [ > ]