LoomKey

private enum
loom.platform.LoomKey

Description

A uniform set of keycodes used cross-platform by Loom.

API overview

Constructor

LoomKey ()

Attributes

Public attributes

A: LoomKey static

@{

AC_BACK: LoomKey static
AC_BOOKMARKS: LoomKey static
AC_FORWARD: LoomKey static
AC_HOME: LoomKey static
AC_REFRESH: LoomKey static
AC_SEARCH: LoomKey static
AC_STOP: LoomKey static
AGAIN: LoomKey static
ALTERASE: LoomKey static

< reserved

APOSTROPHE: LoomKey static
APP1: LoomKey static
APP2: LoomKey static
APPLICATION: LoomKey static

< This is the additional key that ISO keyboards have over ANSI ones, located between left shift and Y

AUDIOMUTE: LoomKey static
AUDIONEXT: LoomKey static

@{

AUDIOPLAY: LoomKey static
AUDIOPREV: LoomKey static
AUDIOSTOP: LoomKey static
B: LoomKey static
BACKSLASH: LoomKey static
BACKSPACE: LoomKey static
BRIGHTNESSDOWN: LoomKey static

@{

BRIGHTNESSUP: LoomKey static
BUTTON_BACK: LoomKey static

Add any other keys here

C: LoomKey static
CALCULATOR: LoomKey static
CANCEL: LoomKey static
CAPSLOCK: LoomKey static
CLEAR: LoomKey static
CLEARAGAIN: LoomKey static
COMMA: LoomKey static

< Located in the top left corner (on both ANSI and ISO keyboards)

COMPUTER: LoomKey static
COPY: LoomKey static
CRSEL: LoomKey static
CURRENCYSUBUNIT: LoomKey static
CURRENCYUNIT: LoomKey static
CUT: LoomKey static
D: LoomKey static
DECIMALSEPARATOR: LoomKey static
DELETE: LoomKey static
DISPLAYSWITCH: LoomKey static
DOWN_ARROW: LoomKey static
E: LoomKey static
EIGHT: LoomKey static
EJECT: LoomKey static
END: LoomKey static
EQUALS: LoomKey static
ESCAPE: LoomKey static
EXECUTE: LoomKey static
EXSEL: LoomKey static
F: LoomKey static
F1: LoomKey static
F10: LoomKey static
F11: LoomKey static
F12: LoomKey static
F13: LoomKey static
F14: LoomKey static
F15: LoomKey static
F16: LoomKey static
F17: LoomKey static
F18: LoomKey static
F19: LoomKey static
F2: LoomKey static
F20: LoomKey static
F21: LoomKey static
F22: LoomKey static
F23: LoomKey static
F24: LoomKey static
F3: LoomKey static
F4: LoomKey static
F5: LoomKey static
F6: LoomKey static
F7: LoomKey static
F8: LoomKey static
F9: LoomKey static
FIND: LoomKey static
FIVE: LoomKey static
FOUR: LoomKey static
G: LoomKey static
GRAVE: LoomKey static
H: LoomKey static
HELP: LoomKey static
HOME: LoomKey static

< insert on PC, help on some Mac keyboards (but does send code 73, not 117)

HYPHEN: LoomKey static
I: LoomKey static
INSERT: LoomKey static
INTERNATIONAL1: LoomKey static
INTERNATIONAL2: LoomKey static

< used on Asian keyboards, see footnotes in USB doc

INTERNATIONAL3: LoomKey static
INTERNATIONAL4: LoomKey static

< Yen

INTERNATIONAL5: LoomKey static
INTERNATIONAL6: LoomKey static
INTERNATIONAL7: LoomKey static
INTERNATIONAL8: LoomKey static
INTERNATIONAL9: LoomKey static
J: LoomKey static
K: LoomKey static
KBDILLUMDOWN: LoomKey static
KBDILLUMTOGGLE: LoomKey static

< display mirroring/dual display switch, video mode switch

KBDILLUMUP: LoomKey static
KP_0: LoomKey static
KP_00: LoomKey static
KP_000: LoomKey static
KP_1: LoomKey static
KP_2: LoomKey static
KP_3: LoomKey static
KP_4: LoomKey static
KP_5: LoomKey static
KP_6: LoomKey static
KP_7: LoomKey static
KP_8: LoomKey static
KP_9: LoomKey static
KP_A: LoomKey static
KP_AMPERSAND: LoomKey static
KP_AT: LoomKey static
KP_B: LoomKey static
KP_BACKSPACE: LoomKey static
KP_BINARY: LoomKey static
KP_C: LoomKey static
KP_CLEAR: LoomKey static
KP_CLEARENTRY: LoomKey static
KP_COLON: LoomKey static
KP_COMMA: LoomKey static

LOCKINGSCROLLLOCK = 132,

KP_D: LoomKey static
KP_DBLAMPERSAND: LoomKey static
KP_DBLVERTICALBAR: LoomKey static
KP_DECIMAL: LoomKey static
KP_DIVIDE: LoomKey static

< num lock on PC, clear on Mac keyboards

KP_E: LoomKey static
KP_ENTER: LoomKey static
KP_EQUALS: LoomKey static

< The USB document says this is a status flag, not a physical key - but some Mac keyboards do have a power key

KP_EQUALSAS400: LoomKey static
KP_EXCLAM: LoomKey static
KP_F: LoomKey static
KP_GREATER: LoomKey static
KP_HASH: LoomKey static
KP_HEXADECIMAL: LoomKey static
KP_LEFTBRACE: LoomKey static
KP_LEFTPAREN: LoomKey static
KP_LESS: LoomKey static
KP_MEMADD: LoomKey static
KP_MEMCLEAR: LoomKey static
KP_MEMDIVIDE: LoomKey static
KP_MEMMULTIPLY: LoomKey static
KP_MEMRECALL: LoomKey static
KP_MEMSTORE: LoomKey static
KP_MEMSUBTRACT: LoomKey static
KP_MINUS: LoomKey static
KP_MULTIPLY: LoomKey static
KP_OCTAL: LoomKey static
KP_PERCENT: LoomKey static
KP_PERIOD: LoomKey static
KP_PLUS: LoomKey static
KP_PLUSMINUS: LoomKey static
KP_POWER: LoomKey static
KP_RIGHTBRACE: LoomKey static
KP_RIGHTPAREN: LoomKey static
KP_SPACE: LoomKey static
KP_TAB: LoomKey static
KP_VERTICALBAR: LoomKey static
KP_XOR: LoomKey static
L: LoomKey static
LALT: LoomKey static
LANG1: LoomKey static
LANG2: LoomKey static

< Hangul/English toggle

LANG3: LoomKey static

< Hanja conversion

LANG4: LoomKey static

< Katakana

LANG5: LoomKey static

< Hiragana

LANG6: LoomKey static

< Zenkaku/Hankaku

LANG7: LoomKey static

< reserved

LANG8: LoomKey static

< reserved

LANG9: LoomKey static

< reserved

LCTRL: LoomKey static
LEFTBRACKET: LoomKey static
LEFT_ARROW: LoomKey static
LGUI: LoomKey static

< alt, option

LSHIFT: LoomKey static
M: LoomKey static
MAIL: LoomKey static
MEDIASELECT: LoomKey static
MENU: LoomKey static
MINUS: LoomKey static
MODE: LoomKey static

< windows, command (apple), meta

MUTE: LoomKey static
N: LoomKey static
NINE: LoomKey static
NONUSBACKSLASH: LoomKey static
NONUSHASH: LoomKey static

< Located at the lower left of the return key on ISO keyboards and at the right end of the QWERTY row on ANSI keyboards

NUMLOCKCLEAR: LoomKey static
NUM_SCANCODES: LoomKey static

< not a key, just marks the number of scancodes for array bounds

O: LoomKey static
ONE: LoomKey static
OPER: LoomKey static
OUT: LoomKey static
P: LoomKey static
PADEQUAL_SIGN: LoomKey static
PAGEDOWN: LoomKey static
PAGEUP: LoomKey static
PASTE: LoomKey static
PAUSE: LoomKey static
PERIOD: LoomKey static
POWER: LoomKey static

< windows contextual menu, compose

PRINTSCREEN: LoomKey static
PRIOR: LoomKey static
Q: LoomKey static
R: LoomKey static
RALT: LoomKey static
RCTRL: LoomKey static

< windows, command (apple), meta

RETURN: LoomKey static
RETURN2: LoomKey static
RGUI: LoomKey static

< alt gr, option

RIGHTBRACKET: LoomKey static
RIGHT_ARROW: LoomKey static
RSHIFT: LoomKey static
S: LoomKey static
SCROLLLOCK: LoomKey static
SELECT: LoomKey static
SEMICOLON: LoomKey static

< ISO USB keyboards actually use this code instead of 49 for the same key, but all OSes I've seen treat the two codes identically

SEPARATOR: LoomKey static
SEVEN: LoomKey static
SIX: LoomKey static
SLASH: LoomKey static
SLEEP: LoomKey static
SPACE: LoomKey static
SPACEBAR: LoomKey static
STOP: LoomKey static
SYSREQ: LoomKey static

< Erase-Eaze

T: LoomKey static
TAB: LoomKey static
THOUSANDSSEPARATOR: LoomKey static
THREE: LoomKey static
TWO: LoomKey static
U: LoomKey static
UNDO: LoomKey static

< redo

UNKNOWN: LoomKey static
UP_ARROW: LoomKey static
V: LoomKey static
VOLUMEDOWN: LoomKey static
VOLUMEUP: LoomKey static
W: LoomKey static
WWW: LoomKey static
X: LoomKey static
Y: LoomKey static
Z: LoomKey static
ZERO: LoomKey static

Functions

Public functions

Constructor

LoomKey ()

Attributes

A: LoomKey

static

@{

AC_BACK: LoomKey

static

AC_BOOKMARKS: LoomKey

static

AC_FORWARD: LoomKey

static

AC_HOME: LoomKey

static

AC_REFRESH: LoomKey

static

AC_STOP: LoomKey

static

AGAIN: LoomKey

static

ALTERASE: LoomKey

static

< reserved

APOSTROPHE: LoomKey

static

APP1: LoomKey

static

APP2: LoomKey

static

APPLICATION: LoomKey

static

< This is the additional key that ISO keyboards have over ANSI ones, located between left shift and Y. Produces GRAVE ACCENT and TILDE in a US or UK Mac layout, REVERSE SOLIDUS (backslash) and VERTICAL LINE in a US or UK Windows layout, and LESS-THAN SIGN and GREATER-THAN SIGN in a Swiss German, German, or French layout.

AUDIOMUTE: LoomKey

static

AUDIONEXT: LoomKey

static

@{

AUDIOPLAY: LoomKey

static

AUDIOPREV: LoomKey

static

AUDIOSTOP: LoomKey

static

B: LoomKey

static

BACKSLASH: LoomKey

static

BACKSPACE: LoomKey

static

BRIGHTNESSDOWN: LoomKey

static

@{

BRIGHTNESSUP: LoomKey

static

BUTTON_BACK: LoomKey

static

Add any other keys here.

C: LoomKey

static

CALCULATOR: LoomKey

static

CANCEL: LoomKey

static

CAPSLOCK: LoomKey

static

CLEAR: LoomKey

static

CLEARAGAIN: LoomKey

static

COMMA: LoomKey

static

< Located in the top left corner (on both ANSI and ISO keyboards). Produces GRAVE ACCENT and TILDE in a US Windows layout and in US and UK Mac layouts on ANSI keyboards, GRAVE ACCENT and NOT SIGN in a UK Windows layout, SECTION SIGN and PLUS-MINUS SIGN in US and UK Mac layouts on ISO keyboards, SECTION SIGN and DEGREE SIGN in a Swiss German layout (Mac: only on ISO keyboards), CIRCUMFLEX ACCENT and DEGREE SIGN in a German layout (Mac: only on ISO keyboards), SUPERSCRIPT TWO and TILDE in a French Windows layout, COMMERCIAL AT and NUMBER SIGN in a French Mac layout on ISO keyboards, and LESS-THAN SIGN and GREATER-THAN SIGN in a Swiss German, German, or French Mac layout on ANSI keyboards.

COMPUTER: LoomKey

static

COPY: LoomKey

static

CRSEL: LoomKey

static

CURRENCYSUBUNIT: LoomKey

static

CURRENCYUNIT: LoomKey

static

CUT: LoomKey

static

D: LoomKey

static

DECIMALSEPARATOR: LoomKey

static

DELETE: LoomKey

static

DISPLAYSWITCH: LoomKey

static

DOWN_ARROW: LoomKey

static

E: LoomKey

static

EIGHT: LoomKey

static

EJECT: LoomKey

static

END: LoomKey

static

EQUALS: LoomKey

static

ESCAPE: LoomKey

static

EXECUTE: LoomKey

static

EXSEL: LoomKey

static

F: LoomKey

static

F1: LoomKey

static

F10: LoomKey

static

F11: LoomKey

static

F12: LoomKey

static

F13: LoomKey

static

F14: LoomKey

static

F15: LoomKey

static

F16: LoomKey

static

F17: LoomKey

static

F18: LoomKey

static

F19: LoomKey

static

F2: LoomKey

static

F20: LoomKey

static

F21: LoomKey

static

F22: LoomKey

static

F23: LoomKey

static

F24: LoomKey

static

F3: LoomKey

static

F4: LoomKey

static

F5: LoomKey

static

F6: LoomKey

static

F7: LoomKey

static

F8: LoomKey

static

F9: LoomKey

static

FIND: LoomKey

static

FIVE: LoomKey

static

FOUR: LoomKey

static

G: LoomKey

static

GRAVE: LoomKey

static

H: LoomKey

static

HELP: LoomKey

static

HOME: LoomKey

static

< insert on PC, help on some Mac keyboards (but does send code 73, not 117)

HYPHEN: LoomKey

static

I: LoomKey

static

INSERT: LoomKey

static

INTERNATIONAL1: LoomKey

static

INTERNATIONAL2: LoomKey

static

< used on Asian keyboards, see footnotes in USB doc

INTERNATIONAL3: LoomKey

static

INTERNATIONAL4: LoomKey

static

< Yen

INTERNATIONAL5: LoomKey

static

INTERNATIONAL6: LoomKey

static

INTERNATIONAL7: LoomKey

static

INTERNATIONAL8: LoomKey

static

INTERNATIONAL9: LoomKey

static

J: LoomKey

static

K: LoomKey

static

KBDILLUMDOWN: LoomKey

static

KBDILLUMTOGGLE: LoomKey

static

< display mirroring/dual display switch, video mode switch

KBDILLUMUP: LoomKey

static

KP_0: LoomKey

static

KP_00: LoomKey

static

KP_000: LoomKey

static

KP_1: LoomKey

static

KP_2: LoomKey

static

KP_3: LoomKey

static

KP_4: LoomKey

static

KP_5: LoomKey

static

KP_6: LoomKey

static

KP_7: LoomKey

static

KP_8: LoomKey

static

KP_9: LoomKey

static

KP_A: LoomKey

static

KP_AMPERSAND: LoomKey

static

KP_AT: LoomKey

static

KP_B: LoomKey

static

KP_BACKSPACE: LoomKey

static

KP_BINARY: LoomKey

static

KP_C: LoomKey

static

KP_CLEAR: LoomKey

static

KP_CLEARENTRY: LoomKey

static

KP_COLON: LoomKey

static

KP_COMMA: LoomKey

static

LOCKINGSCROLLLOCK = 132,

KP_D: LoomKey

static

KP_DBLAMPERSAND: LoomKey

static

KP_DBLVERTICALBAR: LoomKey

static

KP_DECIMAL: LoomKey

static

KP_DIVIDE: LoomKey

static

< num lock on PC, clear on Mac keyboards

KP_E: LoomKey

static

KP_ENTER: LoomKey

static

KP_EQUALS: LoomKey

static

< The USB document says this is a status flag, not a physical key - but some Mac keyboards do have a power key.

KP_EQUALSAS400: LoomKey

static

KP_EXCLAM: LoomKey

static

KP_F: LoomKey

static

KP_GREATER: LoomKey

static

KP_HASH: LoomKey

static

KP_HEXADECIMAL: LoomKey

static

KP_LEFTBRACE: LoomKey

static

KP_LEFTPAREN: LoomKey

static

KP_LESS: LoomKey

static

KP_MEMADD: LoomKey

static

KP_MEMCLEAR: LoomKey

static

KP_MEMDIVIDE: LoomKey

static

KP_MEMMULTIPLY: LoomKey

static

KP_MEMRECALL: LoomKey

static

KP_MEMSTORE: LoomKey

static

KP_MEMSUBTRACT: LoomKey

static

KP_MINUS: LoomKey

static

KP_MULTIPLY: LoomKey

static

KP_OCTAL: LoomKey

static

KP_PERCENT: LoomKey

static

KP_PERIOD: LoomKey

static

KP_PLUS: LoomKey

static

KP_PLUSMINUS: LoomKey

static

KP_POWER: LoomKey

static

KP_RIGHTBRACE: LoomKey

static

KP_RIGHTPAREN: LoomKey

static

KP_SPACE: LoomKey

static

KP_TAB: LoomKey

static

KP_VERTICALBAR: LoomKey

static

KP_XOR: LoomKey

static

L: LoomKey

static

LALT: LoomKey

static

LANG1: LoomKey

static

LANG2: LoomKey

static

< Hangul/English toggle

LANG3: LoomKey

static

< Hanja conversion

LANG4: LoomKey

static

< Katakana

LANG5: LoomKey

static

< Hiragana

LANG6: LoomKey

static

< Zenkaku/Hankaku

LANG7: LoomKey

static

< reserved

LANG8: LoomKey

static

< reserved

LANG9: LoomKey

static

< reserved

LCTRL: LoomKey

static

LEFTBRACKET: LoomKey

static

LEFT_ARROW: LoomKey

static

LGUI: LoomKey

static

< alt, option

LSHIFT: LoomKey

static

M: LoomKey

static

MAIL: LoomKey

static

MEDIASELECT: LoomKey

static

MENU: LoomKey

static

MINUS: LoomKey

static

MODE: LoomKey

static

< windows, command (apple), meta

MUTE: LoomKey

static

N: LoomKey

static

NINE: LoomKey

static

NONUSBACKSLASH: LoomKey

static

NONUSHASH: LoomKey

static

< Located at the lower left of the return key on ISO keyboards and at the right end of the QWERTY row on ANSI keyboards. Produces REVERSE SOLIDUS (backslash) and VERTICAL LINE in a US layout, REVERSE SOLIDUS and VERTICAL LINE in a UK Mac layout, NUMBER SIGN and TILDE in a UK Windows layout, DOLLAR SIGN and POUND SIGN in a Swiss German layout, NUMBER SIGN and APOSTROPHE in a German layout, GRAVE ACCENT and POUND SIGN in a French Mac layout, and ASTERISK and MICRO SIGN in a French Windows layout.

NUMLOCKCLEAR: LoomKey

static

NUM_SCANCODES: LoomKey

static

< not a key, just marks the number of scancodes for array bounds

O: LoomKey

static

ONE: LoomKey

static

OPER: LoomKey

static

OUT: LoomKey

static

P: LoomKey

static

PADEQUAL_SIGN: LoomKey

static

PAGEDOWN: LoomKey

static

PAGEUP: LoomKey

static

PASTE: LoomKey

static

PAUSE: LoomKey

static

PERIOD: LoomKey

static

POWER: LoomKey

static

< windows contextual menu, compose

PRINTSCREEN: LoomKey

static

PRIOR: LoomKey

static

Q: LoomKey

static

R: LoomKey

static

RALT: LoomKey

static

RCTRL: LoomKey

static

< windows, command (apple), meta

RETURN: LoomKey

static

RETURN2: LoomKey

static

RGUI: LoomKey

static

< alt gr, option

RIGHTBRACKET: LoomKey

static

RIGHT_ARROW: LoomKey

static

RSHIFT: LoomKey

static

S: LoomKey

static

SCROLLLOCK: LoomKey

static

SELECT: LoomKey

static

SEMICOLON: LoomKey

static

< ISO USB keyboards actually use this code instead of 49 for the same key, but all OSes I've seen treat the two codes identically. So, as an implementor, unless your keyboard generates both of those codes and your OS treats them differently, you should generate BACKSLASH instead of this code. As a user, you should not rely on this code because SDL will never generate it with most (all?) keyboards.

SEPARATOR: LoomKey

static

SEVEN: LoomKey

static

SIX: LoomKey

static

SLASH: LoomKey

static

SLEEP: LoomKey

static

SPACE: LoomKey

static

SPACEBAR: LoomKey

static

STOP: LoomKey

static

SYSREQ: LoomKey

static

< Erase-Eaze

T: LoomKey

static

TAB: LoomKey

static

THOUSANDSSEPARATOR: LoomKey

static

THREE: LoomKey

static

TWO: LoomKey

static

U: LoomKey

static

UNDO: LoomKey

static

< redo

UNKNOWN: LoomKey

static

UP_ARROW: LoomKey

static

V: LoomKey

static

VOLUMEDOWN: LoomKey

static

VOLUMEUP: LoomKey

static

W: LoomKey

static

WWW: LoomKey

static

X: LoomKey

static

Y: LoomKey

static

Z: LoomKey

static

ZERO: LoomKey

static

Functions

getFullTypeName (): String
Inherited from Object

native

Gets the fully qualified type name of the Object. The fully qualified type name includes the package of the type.


Returns

String fully qualified type name of the Object.

getType (): Type
Inherited from Object

native

Gets the Type that describes the Object.


Returns

Type The Type that describes the object.

getTypeName (): String
Inherited from Object

native

Gets the type name of the Object.


Returns

String type name of the Object.

toString (): String
Inherited from Object

native

Returns a String that describes the Object. This can be overriden to provide extra details when printing objects using trace().


Returns

String String that described the Object.

: