enum Termisu::Input::Key

Overview

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

Defined in:

termisu/input/key.cr

Enum Members

UpperA = 0

Letters (uppercase A-Z)

UpperB = 1

UpperC = 2

UpperD = 3

UpperE = 4

UpperF = 5

UpperG = 6

UpperH = 7

UpperI = 8

UpperJ = 9

UpperK = 10

UpperL = 11

UpperM = 12

UpperN = 13

UpperO = 14

UpperP = 15

UpperQ = 16

UpperR = 17

UpperS = 18

UpperT = 19

UpperU = 20

UpperV = 21

UpperW = 22

UpperX = 23

UpperY = 24

UpperZ = 25

LowerA = 26

Letters (lowercase a-z)

LowerB = 27

LowerC = 28

LowerD = 29

LowerE = 30

LowerF = 31

LowerG = 32

LowerH = 33

LowerI = 34

LowerJ = 35

LowerK = 36

LowerL = 37

LowerM = 38

LowerN = 39

LowerO = 40

LowerP = 41

LowerQ = 42

LowerR = 43

LowerS = 44

LowerT = 45

LowerU = 46

LowerV = 47

LowerW = 48

LowerX = 49

LowerY = 50

LowerZ = 51

Num0 = 52

Numbers 0-9

Num1 = 53

Num2 = 54

Num3 = 55

Num4 = 56

Num5 = 57

Num6 = 58

Num7 = 59

Num8 = 60

Num9 = 61

Backtick = 62

Punctuation & Symbols (unshifted)

Minus = 63

Equals = 64

LeftBracket = 65

RightBracket = 66

Backslash = 67

Semicolon = 68

Quote = 69

Comma = 70

Period = 71

Slash = 72

Tilde = 73

Shifted symbols

Exclaim = 74

At = 75

Hash = 76

Dollar = 77

Percent = 78

Caret = 79

Ampersand = 80

Asterisk = 81

LeftParen = 82

RightParen = 83

Underscore = 84

Plus = 85

LeftBrace = 86

RightBrace = 87

Pipe = 88

Colon = 89

DoubleQuote = 90

LessThan = 91

GreaterThan = 92

Question = 93

Space = 94

Whitespace & Control

Tab = 95

Enter = 96

Backspace = 97

Escape = 98

Up = 99

Arrow keys

Down = 100

Left = 101

Right = 102

Home = 103

Navigation

End = 104

PageUp = 105

PageDown = 106

Insert = 107

Delete = 108

F1 = 109

Function keys (F1-F24)

F2 = 110

F3 = 111

F4 = 112

F5 = 113

F6 = 114

F7 = 115

F8 = 116

F9 = 117

F10 = 118

F11 = 119

F12 = 120

F13 = 121

F14 = 122

F15 = 123

F16 = 124

F17 = 125

F18 = 126

F19 = 127

F20 = 128

F21 = 129

F22 = 130

F23 = 131

F24 = 132

CapsLock = 133

Special / Modifier keys (only detectable with enhanced keyboard protocols)

ScrollLock = 134

NumLock = 135

PrintScreen = 136

Pause = 137

BackTab = 138

Unknown = 139

Constructors

• .from_char(c : Char) : Key

  Creates a Key from a printable character.

Instance Method Summary

• #a? : Bool
• #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

• #b? : Bool
• #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

• #c? : Bool
• #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

• #d? : Bool
• #delete?

  Returns true if this enum value equals Delete

• #digit? : Bool

  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

• #e? : Bool
• #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

• #f? : Bool
• #function_key? : Bool

  Returns true if this is a function key (F1-F24).

• #g? : Bool
• #greater_than?

  Returns true if this enum value equals GreaterThan

• #h? : Bool
• #hash?

  Returns true if this enum value equals Hash

• #home?

  Returns true if this enum value equals Home

• #i? : Bool
• #insert?

  Returns true if this enum value equals Insert

• #j? : Bool
• #k? : Bool
• #l? : Bool
• #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? : Bool

  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

• #m? : Bool
• #minus?

  Returns true if this enum value equals Minus

• #n? : Bool
• #navigation? : Bool

  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

• #o? : Bool
• #p? : Bool
• #page_down?

  Returns true if this enum value equals PageDown

• #page_up?

  Returns true if this enum value equals PageUp

• #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? : Bool

  Returns true if this key produces a printable character.

• #q? : Bool
• #question?

  Returns true if this enum value equals Question

• #quote?

  Returns true if this enum value equals Quote

• #r? : Bool
• #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

• #s? : Bool
• #scroll_lock?

  Returns true if this enum value equals ScrollLock

• #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

• #t? : Bool
• #tab?

  Returns true if this enum value equals Tab

• #tilde?

  Returns true if this enum value equals Tilde

• #to_char : Char | Nil

  Returns the character representation of this key, if printable.

• #u? : Bool
• #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

• #v? : Bool
• #w? : Bool
• #x? : Bool
• #y? : Bool
• #z? : Bool

Constructor Detail

Instance Method Detail