cursborderset(3X) cursborderset(3X)
NAME
borderset, wborderset, boxset, hlineset, whlineset, mvhlineset,
mvwhlineset, vlineset, wvlineset, mvvlineset, mvwvlineset - create
curses borders or lines using complex characters and renditions
SYNOPSIS
##include <>
int borderset(
const cchart **ls, const cchart **rs,
const cchart **ts, const cchart **bs,
const cchart **tl, const cchart **tr,
const cchart **bl, const cchart **br );;
int wborderset(
WINDOW **win,
const cchart **ls, const cchart **rs,
const cchart **ts, const cchart **bs,
const cchart **tl, const cchart **tr,
const cchart **bl, const cchart **br);;
int boxset(
WINDOW **win,
const cchart **verch,
const cchart **horch);;
int hlineset(
const cchart **wch, int n);;
int whlineset(
WINDOW **win,
const cchart **wch, int n);;
int mvhlineset(
int y, int x,
const cchart **wch, int n);;
int mvwhlineset(
WINDOW **win,
int y, int x,
const cchart **wch, int n);;
int vlineset(
const cchart **wch, int n);;
int wvlineset(
WINDOW **win,
const cchart **wch, int n);;
int mvvlineset(
int y, int x,
const cchart **wch, int n);;
int mvwvlineset(
WINDOW **win,
int y, int x,
const cchart **wch, int n);;
DESCRIPTION
The borderset and wborderset functions draw a border around the edges
of the current or specified window. These functions do not change the
cursor position, and do not wrap.
Other than the window, each argument is a complex character with
attributes:
ls - left side,
rs - right side,
ts - top side,
bs - bottom side,
tl - top left-hand corner,
tr - top right-hand corner,
bl - bottom left-hand corner, and
br - bottom right-hand corner.
If any of these arguments is zero, then the corresponding default val-
ues (defined in curses.h) are used instead:
WACSVLINE,
WACSVLINE,
WACSHLINE,
WACSHLINE,
WACSULCORNER,
WACSURCORNER,
WACSLCORNER, and
WACSLRCORNER.
boxset(win, verch,, horch);; is a shorthand for the following call:
wborderset(win,, verch,, verch,,
horch,, horch,, NUL,, NUL,, NUL,, NUL);;
The **lineset functions use wch to draw a line starting at the current
cursor position in the window. The line is at most n characters long
or as many as fit into the window. The current cursor position is not
changed.
The hlineset, mvhlineset, mvwhlineset, and whlineset functions draw
a line proceeding toward the last column of the same line.
The vlineset, mvvlineset, mvwvlineset, and wvlineset functions draw
a line proceeding toward the last line of the window.
NOTES
Note that borderset, hlineset, mvhlineset, mvvlineset, mvwh-
lineset, mvwvlineset, and vlineset may be macros.
RETURN VALUES
Upon successful completion, these functions return OK. Otherwise, they
return ER.
SEE ALSO
ncurses(3X), cursborder(3X), cursoutopts(3X)
cursborderset(3X)
|