Kanzi  3.9.6
Java API
LogicalKey Enum Reference

Platform independent key enumeration. More...

Inheritance diagram for LogicalKey:
[legend]

Public Member Functions

 LogicalKey (int mValue)
 
 LogicalKey (LogicalKey enum_)
 
int getValue ()
 Returns the integer value of the enumeration constant. More...
 
final int swigValue ()
 

Static Public Member Functions

static LogicalKey swigToEnum (int swigValue)
 
static LogicalKey toEnum (int value)
 Converts an integer value to the matching enumeration constant. More...
 

Public Attributes

 A
 Identifies the A key.
 
 Alt
 Identifies the Alt modifier key.
 
 ArrowDown
 Identifies the arrow down key.
 
 ArrowLeft
 Identifies the arrow left key.
 
 ArrowRight
 Identifies the arrow right key.
 
 ArrowUp
 Identifies the arrow up key.
 
 B
 Identifies the B key.
 
 Backspace
 Identifies the backspace key.
 
 BackTab
 Identifies the Back Tab key.
 
 Break
 Identifies the Break key.
 
 ButtonA
 Identifies the A button on game controllers.
 
 ButtonB
 Identifies the B button on game controllers.
 
 ButtonC
 Identifies the C button on game controllers.
 
 ButtonL1
 Identifies the L1 button on game controllers.
 
 ButtonL2
 Identifies the L2 button on game controllers.
 
 ButtonMode
 Identifies the mode button on game controllers.
 
 ButtonR1
 Identifies the R1 button on game controllers.
 
 ButtonR2
 Identifies the R2 button on game controllers.
 
 ButtonSelect
 Identifies the select button on game controllers.
 
 ButtonStart
 Identifies the start button on game controllers.
 
 ButtonThumbL
 Identifies the ThumbL button on game controllers.
 
 ButtonThumbR
 Identifies the ThumbR button on game controllers.
 
 ButtonX
 Identifies the X button on game controllers.
 
 ButtonY
 Identifies the Y button on game controllers.
 
 ButtonZ
 Identifies the Z button on game controllers.
 
 C
 Identifies the C key.
 
 CapsLock
 Identifies the CapsLock key.
 
 Comma
 Identifies the comma key.
 
 Control
 Identifies the Control modifier key.
 
 D
 Identifies the D key.
 
 DecimalSeparator
 Allows for the key mapping of a locale specific decimal separator.
 
 Delete
 Identifies the Delete key.
 
 Divide
 Identifies the slash key.
 
 E
 Identifies the E key.
 
 End
 Identifies the End key.
 
 Enter
 Identifies the Enter key.
 
 Escape
 Identifies the Escape key.
 
 F
 Identifies the F key.
 
 F1
 Identifies the F1 function key.
 
 F10
 Identifies the F10 function key.
 
 F11
 Identifies the F11 function key.
 
 F12
 Identifies the F12 function key.
 
 F2
 Identifies the F2 function key.
 
 F3
 Identifies the F3 function key.
 
 F4
 Identifies the F4 function key.
 
 F5
 Identifies the F5 function key.
 
 F6
 Identifies the F6 function key.
 
 F7
 Identifies the F7 function key.
 
 F8
 Identifies the F8 function key.
 
 F9
 Identifies the F9 function key.
 
 G
 Identifies the G key.
 
 H
 Identifies the H key.
 
 Home
 Identifies the Home key.
 
 I
 Identifies the I key.
 
 Insert
 Identifies the Insert key.
 
 J
 Identifies the J key.
 
 K
 Identifies the K key.
 
 L
 Identifies the L key.
 
 LeftAlt
 Identifies the left Alt modifier key.
 
 LeftControl
 Identifies the left Control modifier key.
 
 LeftShift
 Identifies the left Shift modifier key.
 
 LeftSuper
 Identifies the left Super key.
 
 M
 Identifies the M key.
 
 Menu
 Identifies the menu key on keyboards where the key is available. More...
 
 Minus
 Identifies the minus key.
 
 Multiply
 Identifies the asterisk key.
 
 N
 Identifies the N key.
 
 Number0
 Identifies the 0 key.
 
 Number1
 Identifies the 1 key.
 
 Number2
 Identifies the 2 key.
 
 Number3
 Identifies the 3 key.
 
 Number4
 Identifies the 4 key.
 
 Number5
 Identifies the 5 key.
 
 Number6
 Identifies the 6 key.
 
 Number7
 Identifies the 7 key.
 
 Number8
 Identifies the 8 key.
 
 Number9
 Identifies the 9 key.
 
 NumLock
 Identifies the NumLock key.
 
 Numpad0
 Identifies the 0 key from the numeric keypad.
 
 Numpad1
 Identifies the 1 key from the numeric keypad.
 
 Numpad2
 Identifies the 2 key from the numeric keypad.
 
 Numpad3
 Identifies the 3 key from the numeric keypad.
 
 Numpad4
 Identifies the 4 key from the numeric keypad.
 
 Numpad5
 Identifies the 5 key from the numeric keypad.
 
 Numpad6
 Identifies the 6 key from the numeric keypad.
 
 Numpad7
 Identifies the 7 key from the numeric keypad.
 
 Numpad8
 Identifies the 8 key from the numeric keypad.
 
 Numpad9
 Identifies the 9 key from the numeric keypad.
 
 NumpadComma
 Identifies the comma key from the numeric keypad.
 
 NumpadDivide
 Identifies the slash key from the numeric keypad.
 
 NumpadEnter
 Identifies the Enter key from the numeric keypad.
 
 NumpadMinus
 Identifies the minus key from the numeric keypad.
 
 NumpadMultiply
 Identifies the asterisk key from the numeric keypad.
 
 NumpadPlus
 Identifies the plus key from the numeric keypad.
 
 O
 Identifies the O key.
 
 P
 Identifies the P key.
 
 PageDown
 Identifies the PageDown key.
 
 PageUp
 Identifies the PageUp key.
 
 Period
 Identifies the period key.
 
 Pipe
 Identifies the pipe key.
 
 Plus
 Identifies the plus key.
 
 PrintScreen
 Identifies the PrintScreen key.
 
 Q
 Identifies the Q key.
 
 Quote
 Identifies the quote key.
 
 R
 Identifies the R key.
 
 RightAlt
 Identifies the right Alt modifier key.
 
 RightControl
 Identifies the right Control modifier key.
 
 RightShift
 Identifies the right Shift modifier key.
 
 RightSuper
 Identifies the right Super key.
 
 S
 Identifies the S key.
 
 ScrollLock
 Identifies the ScrollLock key.
 
 Semicolon
 Identifies the semicolon key.
 
 Shift
 Identifies the Shift modifier key.
 
 Softkey1
 Identifies the first softkey button, typically present on a phone layout.
 
 Softkey2
 Identifies the second softkey button, typically present on a phone layout.
 
 Softkey3
 Identifies the third softkey button, typically present on a phone layout.
 
 Softkey4
 Identifies the fourth softkey button, typically present on a phone layout.
 
 Space
 Identifies the white-space key.
 
 Super
 Identifies the Super key. More...
 
 T
 Identifies the T key.
 
 Tab
 Identifies the Tab key.
 
 ThousandsSeparator
 Allows for the key mapping of a locale specific thousands separator.
 
 U
 Identifies the U key.
 
 Unknown
 Unknown keys are used for unmapped keys.
 
 V
 Identifies the V key.
 
 VolumeDown
 Identifies the volume down key.
 
 VolumeUp
 Identifies the volume up key.
 
 W
 Identifies the W key.
 
 X
 Identifies the X key.
 
 Y
 Identifies the Y key.
 
 Z
 Identifies the Z key.
 

Detailed Description

Platform independent key enumeration.

Member Function Documentation

◆ getValue()

int getValue ( )

Returns the integer value of the enumeration constant.

Returns
Integer value.

Implements Enum.

◆ toEnum()

static LogicalKey toEnum ( int  value)
static

Converts an integer value to the matching enumeration constant.

Parameters
valueInteger value to convert to enumeration constant.
Returns
Enumeration constant matching the integer value.

Member Data Documentation

◆ Menu

Menu

Identifies the menu key on keyboards where the key is available.

The key is also
known as "hamburger button" on Android key layouts.

◆ Super

Super

Identifies the Super key.

You can map Windows key on Windows OS, or Command key on Mac OS to it.