struct

Tea::Key

Inherits Tea::Msg < Struct < Value < Object

Key represents a keyboard key

Constructors

new(text : String = "", mod : KeyMod = 0, code : Int32 = 0, shifted_code : Int32 = 0, base_code : Int32 = 0, is_repeat : Bool = false)

Instance methods

alt?

base_code

BaseCode is the key pressed according to the standard PC-101 key layout.

base_code=(base_code : Int32)

BaseCode is the key pressed according to the standard PC-101 key layout.

code

Code represents the key pressed. This is usually a special key like KeyTab, KeyEnter, KeyF1, or a printable character like 'a'.

code=(code : Int32)

Code represents the key pressed. This is usually a special key like KeyTab, KeyEnter, KeyF1, or a printable character like 'a'.

ctrl?

is_repeat=(is_repeat : Bool)

IsRepeat indicates whether the key is being held down and sending events repeatedly.

is_repeat?

IsRepeat indicates whether the key is being held down and sending events repeatedly.

keystroke

Go parity helper for Key.Keystroke().

meta?

mod

Mod represents modifier keys, like ModCtrl, ModAlt, and so on.

mod=(mod : KeyMod)

Mod represents modifier keys, like ModCtrl, ModAlt, and so on.

printable?

Check if this is a printable character

rune

Go parity helper for Key.Rune().

shift?

shifted_code

ShiftedCode is the actual, shifted key pressed by the user.

shifted_code=(shifted_code : Int32)

ShiftedCode is the actual, shifted key pressed by the user.

string

Go parity helper for Key.String().

text

Text contains the actual characters received. This usually the same as Code. When Text is non-empty, it indicates that the key pressed represents printable character(s).

text=(text : String)

Text contains the actual characters received. This usually the same as Code. When Text is non-empty, it indicates that the key pressed represents printable character(s).

to_s

Get the string representation