summary refs log tree commit diff
path: root/Doc/Zsh/mod_curses.yo
blob: 8243c1ee2287dc64ac06b77667a0e61632ec863e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
COMMENT(!MOD!zsh/curses
curses windowing commands
!MOD!)
The tt(zsh/curses) module makes available one builtin command:

startitem()
findex(zcurses)
cindex(windows, curses)
xitem(tt(zcurses) tt(-i))
xitem(tt(zcurses) tt(-e))
xitem(tt(zcurses) tt(-a) var(targetwin) var(nlines) var(ncols) var(begin_y) var(begin_x) )
xitem(tt(zcurses) tt(-d) var(targetwin) )
xitem(tt(zcurses) tt(-r) [ var(targetwin) ] )
xitem(tt(zcurses) tt(-m) var(targetwin) var(new_y) var(new_x) )
xitem(tt(zcurses) tt(-c) var(targetwin) var(character) )
xitem(tt(zcurses) tt(-s) var(targetwin) var(string) )
xitem(tt(zcurses) tt(-b) var(targetwin) var(border) )(
item(tt(zcurses) tt(-A) var(targetwin) var({+/-}attribute) [var({+/-}attribute)] [...])(
Manipulate curses windows.  All uses of this command should be
bracketed by `tt(zcurses -i)' to initialise use of curses, and
`tt(zcurses -e)' to end it; omitting `tt(zcurses -e)' can cause
the terminal to be in an unwanted state.

With tt(-a), create a window with var(nlines) lines and var(ncols) columns.
Its upper left corner will be placed at row var(begin_y) and column
var(begin_x) of the screen.  var(targetwin) is a string and refers
to the name of a window that is not currently assigned.

Use tt(-d) to delete a window created with tt(-a).

The tt(-r) command will refresh window var(targetwin); this is necessary to
make any pending changes (such as characters you have prepared for output
with tt(-c)) visible on the screen.  If no argument is given,
all windows are refreshed; this is necessary after deleting a window.

tt(-m) moves the cursor position in var(targetwin) to new coordinates
var(new_y) and var(new_x).

Outputting characters and strings are achieved by tt(-c) and tt(-s)
respectively.

To draw a border around window var(targetwin), use tt(-b).

tt(-A) will set var(targetwin)'s attributes for any successive character
output.  Each var(attribute) given on the line should be prepended by a
tt(+) to set or a tt(-) to unset that attribute.  The attributes supported
are tt(blink), tt(bold), tt(dim), tt(reverse), tt(standout), and
tt(underline).
)
enditem()