DragonFly On-Line Manual Pages
curs_border(3X) curs_border(3X)
NAME
border, wborder, box, hline, whline, vline, wvline, mvhline, mvwhline,
mvvline, mvwvline - create curses borders, horizontal and vertical
lines
SYNOPSIS
#include <ncurses/curses.h>
int border(chtype ls, chtype rs, chtype ts, chtype bs,
chtype tl, chtype tr, chtype bl, chtype br);
int wborder(WINDOW *win, chtype ls, chtype rs,
chtype ts, chtype bs, chtype tl, chtype tr,
chtype bl, chtype br);
int box(WINDOW *win, chtype verch, chtype horch);
int hline(chtype ch, int n);
int whline(WINDOW *win, chtype ch, int n);
int vline(chtype ch, int n);
int wvline(WINDOW *win, chtype ch, int n);
int mvhline(int y, int x, chtype ch, int n);
int mvwhline(WINDOW *win, int y, int x, chtype ch, int n);
int mvvline(int y, int x, chtype ch, int n);
int mvwvline(WINDOW *win, int y, int x, chtype ch, int n);
DESCRIPTION
The border, wborder and box routines draw a box around the edges of a
window. Other than the window, each argument is a 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
values (defined in curses.h) are used instead:
ACS_VLINE,
ACS_VLINE,
ACS_HLINE,
ACS_HLINE,
ACS_ULCORNER,
ACS_URCORNER,
ACS_LLCORNER,
ACS_LRCORNER.
box(win, verch, horch) is a shorthand for the following call:
wborder(win, verch, verch, horch, horch, 0, 0, 0, 0).
The hline and whline functions draw a horizontal (left to right) line
using ch starting at the current cursor position in the window. The
current cursor position is not changed. The line is at most n
characters long, or as many as fit into the window.
The vline and wvline functions draw a vertical (top to bottom) line
using ch starting at the current cursor position in the window. The
current cursor position is not changed. The line is at most n
characters long, or as many as fit into the window.
RETURN VALUE
All routines return the integer OK. The SVr4.0 manual says "or a non-
negative integer if immedok is set", but this appears to be an error.
X/Open does not define any error conditions. This implementation
returns an error if the window pointer is null.
Functions with a "mv" prefix first perform a cursor movement using
wmove, and return an error if the position is outside the window, or if
the window pointer is null.
NOTES
The borders generated by these functions are inside borders (this is
also true of SVr4 curses, though the fact is not documented).
Note that border and box may be macros.
PORTABILITY
These functions are described in the XSI Curses standard, Issue 4. The
standard specifies that they return ERR on failure, but specifies no
error conditions.
SEE ALSO
curses(3X), curs_outopts(3X).
curs_border(3X)
curs_border_set(3X) curs_border_set(3X)
NAME
border_set, wborder_set, box_set, hline_set, whline_set, mvhline_set,
mvwhline_set, vline_set, wvline_set, mvvline_set, mvwvline_set - create
curses borders or lines using complex characters and renditions
SYNOPSIS
#include <ncurses/curses.h>
int border_set(
const cchar_t *ls, const cchar_t *rs,
const cchar_t *ts, const cchar_t *bs,
const cchar_t *tl, const cchar_t *tr,
const cchar_t *bl, const cchar_t *br );
int wborder_set(
WINDOW *win,
const cchar_t *ls, const cchar_t *rs,
const cchar_t *ts, const cchar_t *bs,
const cchar_t *tl, const cchar_t *tr,
const cchar_t *bl, const cchar_t *br);
int box_set(
WINDOW *win,
const cchar_t *verch,
const cchar_t *horch);
int hline_set(
const cchar_t *wch, int n);
int whline_set(
WINDOW *win,
const cchar_t *wch, int n);
int mvhline_set(
int y, int x,
const cchar_t *wch, int n);
int mvwhline_set(
WINDOW *win,
int y, int x,
const cchar_t *wch, int n);
int vline_set(
const cchar_t *wch, int n);
int wvline_set(
WINDOW *win,
const cchar_t *wch, int n);
int mvvline_set(
int y, int x,
const cchar_t *wch, int n);
int mvwvline_set(
WINDOW *win,
int y, int x,
const cchar_t *wch, int n);
DESCRIPTION
The border_set and wborder_set 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
values (defined in curses.h) are used instead:
WACS_VLINE,
WACS_VLINE,
WACS_HLINE,
WACS_HLINE,
WACS_ULCORNER,
WACS_URCORNER,
WACS_LLCORNER, and
WACS_LRCORNER.
box_set(win, verch, horch); is a shorthand for the following call:
wborder_set(win, verch, verch,
horch, horch, NULL, NULL, NULL, NULL);
The *line_set 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 hline_set, mvhline_set, mvwhline_set, and whline_set functions draw
a line proceeding toward the last column of the same line.
The vline_set, mvvline_set, mvwvline_set, and wvline_set functions draw
a line proceeding toward the last line of the window.
NOTES
Note that border_set, hline_set, mvhline_set, mvvline_set,
mvwhline_set, mvwvline_set, and vline_set may be macros.
RETURN VALUE
Upon successful completion, these functions return OK. Otherwise, they
return ERR.
Functions using a window parameter return an error if it is null.
Functions with a "mv" prefix first perform a cursor movement using
wmove, and return an error if the position is outside the window, or if
the window pointer is null.
SEE ALSO
ncurses(3X), curs_add_wch(3X), curs_border(3X), curs_outopts(3X)
curs_border_set(3X)