Modern Tui TuiTermOptionsDefault

Home › Terminal TUI Library › Terminal › TuiTermOptionsDefault

TuiTermOptionsDefault

Returns the usual terminal settings, with the mouse and focus events left off.

Syntax

TuiTermOptionsDefault( ) as TuiTermOptions

Description

Alternate screen, raw mode, hidden cursor and bracketed paste. MOUSE AND FOCUS EVENTS ARE OFF -- both are opt-in, because a program that does not use them should not make the terminal send them. examples/dashboard.tiko turns the mouse on explicitly, and a program that forgets to will never see a mouse event however much else is right.

Example

#import "std/tui"
using tui

dim as TuiTermOptions o = TuiTermOptionsDefault( )
print o.altScreen, o.rawMode, o.hideCursor      '' true true true
print o.bracketedPaste                          '' true
print o.mouse, o.focusEvents                    '' false false -- OPT-IN

'' asking for the mouse, the way examples/dashboard.tiko does
o.mouse = TRUE
print o.mouse                                   '' true

See also

TuiTerminal	TuiTerminal.IsActive	TuiTerminal.DetectCaps	TuiTerminal.Flush
TuiTerminal.Enter	TuiTerminal.Size	TuiTerminal.Write	TuiTerminal.Discard
TuiTerminal.Leave	TuiTerminal.Caps	TuiTerminal.WriteText	TuiTerminal.Pending

---

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

---

Home · Keyword Index