Routines (alphabetical) > Object Classes > Graphics Object Classes > IDLgrWindow::OnKeyboard

# IDLgrWindow::OnKeyboard

Syntax | Arguments | Keywords | Version History

The IDLgrWindow::OnKeyboard procedure method handles notification from the window that a keyboard event has occurred.

Note: This method is only useful in conjunction with the Export Bridge. The method is only a stub and provides no functionality. In your subclass of IDLgrWindow, you should override this method to provide your own functionality. Your method will be automatically called by the Export Bridge. For more information, see "Exporting Drawable Objects"(Chapter 11, IDL Connectivity Bridges in the `help/pdf` directory of your IDL installation).

## Syntax

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

## Arguments

### IsASCII

A scalar byte 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 a byte value corresponding to the character of the pressed key. 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 a byte value corresponding to the ASCII character of the key that was pressed. Otherwise, this argument is set to zero.

### KeySymbol

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

1 | Shift
2 | Control
3 | Caps Lock
4 | Alt
5 | Left
6 | Right
7 | Up
8 | Down
9 | Page Up
10 | Page Down
11 | Home
12 | End

### X,Y

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

### Press

A long integer 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 long integer 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 long integer containing 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

6.3 | Introduced