curs_border(3X) | curs_border(3X) |
NAME
border, wborder, box, hline, whline, vline, wvline, mvhline, mvwhline, mvvline, mvwvline - create curses borders, horizontal and vertical linesSYNOPSIS
#include <curses.h>chtype tl, chtype tr, chtype bl, chtype br);
chtype ts, chtype bs, chtype tl, chtype tr,
chtype bl, chtype br);
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:If any of these arguments is zero, then the corresponding default values (defined in curses.h) are used instead:
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.
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.