Key enum representing all keyboard keys.
Each key has its own enum value for type-safe key handling.
Modifiers (Ctrl, Alt, Shift) are tracked separately in the Modifier flags.
Example:
event = termisu.poll_event
if event.is_a?(Termisu::Event::Key)
case event.key
when .escape? then puts "Escape pressed"
when .enter? then puts "Enter pressed"
when .lower_a? then puts "a pressed"
when .upper_a? then puts "A pressed"
end
end
Constants
Backtick = 62
Punctuation & Symbols (unshifted)
CapsLock = 133
Special / Modifier keys (only detectable with enhanced keyboard protocols)
PasteStart = 140
Bracketed paste boundaries (DEC private mode 2004), only ever reported
while Terminal#enable_bracketed_paste is active.
These are not keystrokes: they bracket a run of bytes the terminal pasted
verbatim, so a caller can tell a pasted line break from one the operator
typed. The bytes between them are reported unchanged — a pasted CR is
still Enter with char == '\r'.
Appended after Unknown deliberately. key_code crosses the C ABI and the
JS binding as a plain integer with no enum mirror on the other side (see
FFI::Conversions.write_key_event), so inserting these next to the other
non-character keys would renumber every key above them.
Constructors
from_char(c : Char) : Key
Creates a Key from a printable character.
Maps ASCII characters to their corresponding Key enum values.
Returns Key::Unknown for unmapped characters.
Instance methods
ampersand?
Returns true if this enum value equals Ampersand
asterisk?
Returns true if this enum value equals Asterisk
at?
Returns true if this enum value equals At
back_tab?
Returns true if this enum value equals BackTab
backslash?
Returns true if this enum value equals Backslash
backspace?
Returns true if this enum value equals Backspace
backtick?
Returns true if this enum value equals Backtick
caps_lock?
Returns true if this enum value equals CapsLock
caret?
Returns true if this enum value equals Caret
colon?
Returns true if this enum value equals Colon
comma?
Returns true if this enum value equals Comma
delete?
Returns true if this enum value equals Delete
digit?
Returns true if this is a digit key (0-9).
dollar?
Returns true if this enum value equals Dollar
double_quote?
Returns true if this enum value equals DoubleQuote
down?
Returns true if this enum value equals Down
end?
Returns true if this enum value equals End
enter?
Returns true if this enum value equals Enter
equals?
Returns true if this enum value equals Equals
escape?
Returns true if this enum value equals Escape
exclaim?
Returns true if this enum value equals Exclaim
f10?
Returns true if this enum value equals F10
f11?
Returns true if this enum value equals F11
f12?
Returns true if this enum value equals F12
f13?
Returns true if this enum value equals F13
f14?
Returns true if this enum value equals F14
f15?
Returns true if this enum value equals F15
f16?
Returns true if this enum value equals F16
f17?
Returns true if this enum value equals F17
f18?
Returns true if this enum value equals F18
f19?
Returns true if this enum value equals F19
f1?
Returns true if this enum value equals F1
f20?
Returns true if this enum value equals F20
f21?
Returns true if this enum value equals F21
f22?
Returns true if this enum value equals F22
f23?
Returns true if this enum value equals F23
f24?
Returns true if this enum value equals F24
f2?
Returns true if this enum value equals F2
f3?
Returns true if this enum value equals F3
f4?
Returns true if this enum value equals F4
f5?
Returns true if this enum value equals F5
f6?
Returns true if this enum value equals F6
f7?
Returns true if this enum value equals F7
f8?
Returns true if this enum value equals F8
f9?
Returns true if this enum value equals F9
function_key?
Returns true if this is a function key (F1-F24).
greater_than?
Returns true if this enum value equals GreaterThan
hash?
Returns true if this enum value equals Hash
home?
Returns true if this enum value equals Home
insert?
Returns true if this enum value equals Insert
left?
Returns true if this enum value equals Left
left_brace?
Returns true if this enum value equals LeftBrace
left_bracket?
Returns true if this enum value equals LeftBracket
left_paren?
Returns true if this enum value equals LeftParen
less_than?
Returns true if this enum value equals LessThan
letter?
Returns true if this is a letter key (A-Z or a-z).
lower_a?
Returns true if this enum value equals LowerA
lower_b?
Returns true if this enum value equals LowerB
lower_c?
Returns true if this enum value equals LowerC
lower_d?
Returns true if this enum value equals LowerD
lower_e?
Returns true if this enum value equals LowerE
lower_f?
Returns true if this enum value equals LowerF
lower_g?
Returns true if this enum value equals LowerG
lower_h?
Returns true if this enum value equals LowerH
lower_i?
Returns true if this enum value equals LowerI
lower_j?
Returns true if this enum value equals LowerJ
lower_k?
Returns true if this enum value equals LowerK
lower_l?
Returns true if this enum value equals LowerL
lower_m?
Returns true if this enum value equals LowerM
lower_n?
Returns true if this enum value equals LowerN
lower_o?
Returns true if this enum value equals LowerO
lower_p?
Returns true if this enum value equals LowerP
lower_q?
Returns true if this enum value equals LowerQ
lower_r?
Returns true if this enum value equals LowerR
lower_s?
Returns true if this enum value equals LowerS
lower_t?
Returns true if this enum value equals LowerT
lower_u?
Returns true if this enum value equals LowerU
lower_v?
Returns true if this enum value equals LowerV
lower_w?
Returns true if this enum value equals LowerW
lower_x?
Returns true if this enum value equals LowerX
lower_y?
Returns true if this enum value equals LowerY
lower_z?
Returns true if this enum value equals LowerZ
minus?
Returns true if this enum value equals Minus
navigation?
Returns true if this is a navigation key.
num0?
Returns true if this enum value equals Num0
num1?
Returns true if this enum value equals Num1
num2?
Returns true if this enum value equals Num2
num3?
Returns true if this enum value equals Num3
num4?
Returns true if this enum value equals Num4
num5?
Returns true if this enum value equals Num5
num6?
Returns true if this enum value equals Num6
num7?
Returns true if this enum value equals Num7
num8?
Returns true if this enum value equals Num8
num9?
Returns true if this enum value equals Num9
num_lock?
Returns true if this enum value equals NumLock
page_down?
Returns true if this enum value equals PageDown
page_up?
Returns true if this enum value equals PageUp
paste_end?
Returns true if this enum value equals PasteEnd
paste_start?
Returns true if this enum value equals PasteStart
pause?
Returns true if this enum value equals Pause
percent?
Returns true if this enum value equals Percent
period?
Returns true if this enum value equals Period
pipe?
Returns true if this enum value equals Pipe
plus?
Returns true if this enum value equals Plus
print_screen?
Returns true if this enum value equals PrintScreen
printable?
Returns true if this key produces a printable character.
question?
Returns true if this enum value equals Question
quote?
Returns true if this enum value equals Quote
right?
Returns true if this enum value equals Right
right_brace?
Returns true if this enum value equals RightBrace
right_bracket?
Returns true if this enum value equals RightBracket
right_paren?
Returns true if this enum value equals RightParen
semicolon?
Returns true if this enum value equals Semicolon
slash?
Returns true if this enum value equals Slash
space?
Returns true if this enum value equals Space
tab?
Returns true if this enum value equals Tab
tilde?
Returns true if this enum value equals Tilde
to_char
Returns the character representation of this key, if printable.
underscore?
Returns true if this enum value equals Underscore
unknown?
Returns true if this enum value equals Unknown
up?
Returns true if this enum value equals Up
upper_a?
Returns true if this enum value equals UpperA
upper_b?
Returns true if this enum value equals UpperB
upper_c?
Returns true if this enum value equals UpperC
upper_d?
Returns true if this enum value equals UpperD
upper_e?
Returns true if this enum value equals UpperE
upper_f?
Returns true if this enum value equals UpperF
upper_g?
Returns true if this enum value equals UpperG
upper_h?
Returns true if this enum value equals UpperH
upper_i?
Returns true if this enum value equals UpperI
upper_j?
Returns true if this enum value equals UpperJ
upper_k?
Returns true if this enum value equals UpperK
upper_l?
Returns true if this enum value equals UpperL
upper_m?
Returns true if this enum value equals UpperM
upper_n?
Returns true if this enum value equals UpperN
upper_o?
Returns true if this enum value equals UpperO
upper_p?
Returns true if this enum value equals UpperP
upper_q?
Returns true if this enum value equals UpperQ
upper_r?
Returns true if this enum value equals UpperR
upper_s?
Returns true if this enum value equals UpperS
upper_t?
Returns true if this enum value equals UpperT
upper_u?
Returns true if this enum value equals UpperU
upper_v?
Returns true if this enum value equals UpperV
upper_w?
Returns true if this enum value equals UpperW
upper_x?
Returns true if this enum value equals UpperX
upper_y?
Returns true if this enum value equals UpperY
upper_z?
Returns true if this enum value equals UpperZ