BBjKeypressEvent::getKeyLocation

Description

In BBj 19.10 and higher, this method returns a flag that indicates the location of the key on the keyboard.

Syntax

Return Value

Method

int

getKeyLocation()

Parameters

None.

Return Value

Returns one of the following values indicating key location on the keyboard:

BBjKeypressEvent Constant

Value

Comments

KEY_LOCATION_UNKNOWN

0

The key location could not be determined.

KEY_LOCATION_STANDARD

1

There is only one version of this key, and this wasn't on the numeric keypad.

KEY_LOCATION_LEFT

2

There are two versions of this key, on the left and right sides of the keyboard, and the left-hand version was pressed.

KEY_LOCATION_RIGHT

3

There are two versions of this key, on the left and right sides of the keyboard, and the right-hand version was pressed.

KEY_LOCATION_NUMPAD

4

This key is on the numeric keypad.

Remarks

None.

See Also

BBjKeypressEvent

BBjAPI

BBj Object Syntax

BBj Object Diagram for an illustration of the relationship between BBjObjects.