NAME

ncurses – a module for Tensile (see sl(1))

OVERVIEW

This module provides interface to *nix (n)curses library. It does not do direct binding, but rather uses Tensile streams interface

FUNCTIONS

sysvar ncurses module adds the following system variables (read-only):

term:columns – the width of the screen
term:rows – the height of the screen

feature

ncurses adds the following features:

::term:colors true if the terminal supports coloring
::term:mouse true if the terminal has mouse and the underlying library supports it
::term:key:keyname true if the terminal has the named keyname

curses.mousemask([mask])

if mask is present, sets the current terminal mouse event mask to mask

The mask has the following form:

+\|-\|	(modifier \| event-type button-no)* or all or *

where modifier is one of

p: – a button is pressed
r: – a button is released
c: – a button is clicked
d: – a button is double clicked
t: – a button is triple clicked

and the modifier is one of:

C: – a Control key is pressed
S: – a Shift key is pressed
A: – an Alt key is pressed
m: – report mouse motions, not just button state change

There are at most four buttons recognized.

all and * are equivalent to p1p2p3p4r1r2r3r4c1c2c3c4d1d2d3d4t1t3t4CSA

If a mask starts with , a new mask is a logical OR of the old mask and mask; if mask starts with a , a new mask is logical AND of the old mask and mask complement; otherwise, the mask is set to mask.

RETURNS:	the old mask
NOTE:	this function is always present, even if the library doesn't support mice

WINDOW STREAM

Reading

ASCII characters read from the terminal are returned as is. Special keys are read as KEY tag which has two attributes: NAME holding the name of the key or UNKNOWN if the key is not recognized; and CODE holding the internal key of the code.

Key names are those defined by curses(3) without the leading KEY_ (but functional key names are just Fnumber without parentheses

If the mouse is present, supported and enabled, mouse events are read as MOUSE tag which has the following attributes:

STATE: state of buttons in the same form as mousemask
SCREENX: horizontal position of the mouse pointer relative to screen
SCREENY: vertical position -"-
X: horizontal position of the mouse pointer relative to the window; not present if the pointer is outside the window
Y: vertical position -"-
Z: a Z coordinate of the pointer (currently always 0)