Modern Tui TuiKey

Home › Terminal TUI Library › Events › TuiKey

TuiKey

Holds a key press: a character or a named key, plus Shift, Ctrl and Alt.

Syntax

type TuiKey
    as uint16 code     '' TuiKeyCode
    as uint8 mods      '' TuiMod bits
    as uint32 ch        '' the codepoint, when code = TUIKEY_CHAR
end type

Description

A key press. code is either TUIKEY_CHAR -- in which case ch holds the codepoint -- or a named key. The named keys are ENTER, TAB, BACKSPACE, ESCAPE, the four arrows, HOME, END_, PAGEUP, PAGEDOWN, INSERT, DELETE and F1 to F12. END_ carries the underscore because END is a statement.

Example

#import "std/tui"
using tui

dim as TuiKey k
k.code = TUIKEY_CHAR
k.ch = asc( "s" )
k.mods = TUIMOD_CTRL
print k.IsChar( )                 '' true
print k.HasMod( TUIMOD_CTRL )     '' true
print TuiKeyName( k )             '' Ctrl+s

dim as TuiKey f5
f5.code = TUIKEY_F5
print f5.IsChar( )                '' false
print TuiKeyName( f5 )            '' F5

See also

TuiEvent	TuiKey.HasMod	TuiKeyName	TuiInput.Feed	TuiInput.PushEvent	TuiInput.Buffered
TuiKey.IsChar	TuiMouse	TuiInput	TuiInput.NextEvent	TuiInput.Reset	TuiInput.Queued

---

Library: Terminal TUI Library
Category: Terminal TUI Library
Documented under: Events
Working examples: hello.tiko · form.tiko · dashboard.tiko

---

Home · Keyword Index