border_set, wborder_set, box_set, hline_set, whline_set, mvhline_set, mvwhline_set, vline_set,
Contents
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.
History
X/Open Curses Issue 4 (1995) initially specified these functions.
Name
border_set, wborder_set, box_set, hline_set, whline_set, mvhline_set, mvwhline_set, vline_set,
wvline_set, mvvline_set, mvwvline_set - draw borders and lines in a curses window of wide characters
Notes
border_set, hline_set, mvhline_set, mvvline_set, mvwhline_set, mvwvline_set, and vline_set may be
implemented as macros.
Portability
X/Open Curses Issue 4 describes these functions. It specifies no error conditions for them.
Return Value
Upon successful completion, these functions return OK. Otherwise, they return ERR.
Functions using a window parameter return ERR if it is null.
Functions prefixed with âmvâ first perform cursor movement and fail if the position (y, x) is outside the
window boundaries.
See Also
ncurses(3NCURSES), add_wch(3NCURSES), border(3NCURSES), outopts(3NCURSES) ncurses 6.5 2025-02-01 border_set(3NCURSES)
Synopsis
#include<curses.h>intborder_set(constcchar_t*ls,constcchar_t*rs,constcchar_t*ts,constcchar_t*bs,constcchar_t*tl,constcchar_t*tr,constcchar_t*bl,constcchar_t*br);intwborder_set(WINDOW*win,constcchar_t*ls,constcchar_t*rs,constcchar_t*ts,constcchar_t*bs,constcchar_t*tl,constcchar_t*tr,constcchar_t*bl,constcchar_t*br);intbox_set(WINDOW*win,constcchar_t*verch,constcchar_t*horch);inthline_set(constcchar_t*wch,intn);intwhline_set(WINDOW*win,constcchar_t*wch,intn);intmvhline_set(inty,intx,constcchar_t*wch,intn);intmvwhline_set(WINDOW*win,inty,intx,constcchar_t*wch,intn);intvline_set(constcchar_t*wch,intn);intwvline_set(WINDOW*win,constcchar_t*wch,intn);intmvvline_set(inty,intx,constcchar_t*wch,intn);intmvwvline_set(WINDOW*win,inty,intx,constcchar_t*wch,intn);
