Modern Tui TuiMouse

Home › Terminal TUI Library › Events › TuiMouse

TuiMouse

Holds a mouse event: press, release, move or wheel, the button, and the cell.

Syntax

type TuiMouse
    as uint8 kind, button, mods
    as int32 x, y       '' ZERO-BASED
end type

Description

A mouse event. The coordinates are 0-based cell positions in the same space as every rect, so Contains is the hit test. The wire form is 1-based and is converted in the parser and nowhere else.

Example

#import "std/numeric"
#import "std/tui"
using tui, numeric

dim as TuiEvent e
e.kind = TUIEVENT_MOUSE
e.mouse.kind = TUIMOUSE_PRESS
e.mouse.button = TUIBTN_LEFT
e.mouse.x = 12 : e.mouse.y = 4

dim as TuiRect panel = TuiRectOf( 10, 2, 20, 8 )
print panel.Contains( e.mouse.x, e.mouse.y )       '' true

'' the kinds: TUIMOUSE_PRESS RELEASE MOVE WHEELUP WHEELDOWN
'' the buttons: TUIBTN_NONE LEFT MIDDLE RIGHT

See also

TuiEvent	TuiKey.IsChar	TuiKeyName	TuiInput.Feed	TuiInput.PushEvent	TuiInput.Buffered
TuiKey	TuiKey.HasMod	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