1curs_border_set(3X)                                        curs_border_set(3X)
2
3
4

NAME

6       border_set, wborder_set, box_set, hline_set, whline_set, mvhline_set,
7       mvwhline_set, vline_set, wvline_set, mvvline_set, mvwvline_set - create
8       curses borders or lines using complex characters and renditions
9

SYNOPSIS

11       #include <curses.h>
12
13       int border_set(
14          const cchar_t *ls, const cchar_t *rs,
15          const cchar_t *ts, const cchar_t *bs,
16          const cchar_t *tl, const cchar_t *tr,
17          const cchar_t *bl, const cchar_t *br );
18       int wborder_set(
19          WINDOW *win,
20          const cchar_t *ls, const cchar_t *rs,
21          const cchar_t *ts, const cchar_t *bs,
22          const cchar_t *tl, const cchar_t *tr,
23          const cchar_t *bl, const cchar_t *br);
24       int box_set(
25          WINDOW *win,
26          const cchar_t *verch,
27          const cchar_t *horch);
28       int hline_set(
29          const cchar_t *wch, int n);
30       int whline_set(
31          WINDOW *win,
32          const cchar_t *wch, int n);
33       int mvhline_set(
34          int y, int x,
35          const cchar_t *wch, int n);
36       int mvwhline_set(
37          WINDOW *win,
38          int y, int x,
39          const cchar_t *wch, int n);
40       int vline_set(
41          const cchar_t *wch, int n);
42       int wvline_set(
43          WINDOW *win,
44          const cchar_t *wch, int n);
45       int mvvline_set(
46          int y, int x,
47          const cchar_t *wch, int n);
48       int mvwvline_set(
49          WINDOW *win,
50          int y, int x,
51          const cchar_t *wch, int n);
52

DESCRIPTION

54       The border_set and wborder_set functions draw a border around the edges
55       of the current or specified window.  These functions do not change  the
56       cursor position, and do not wrap.
57
58       Other  than  the  window, each argument is a complex character with at‐
59       tributes:
60              ls - left side,
61              rs - right side,
62              ts - top side,
63              bs - bottom side,
64              tl - top left-hand corner,
65              tr - top right-hand corner,
66              bl - bottom left-hand corner, and
67              br - bottom right-hand corner.
68
69       If any of these arguments is zero, then the corresponding default  val‐
70       ues (defined in curses.h) are used instead:
71              WACS_VLINE,
72              WACS_VLINE,
73              WACS_HLINE,
74              WACS_HLINE,
75              WACS_ULCORNER,
76              WACS_URCORNER,
77              WACS_LLCORNER, and
78              WACS_LRCORNER.
79
80       box_set(win, verch, horch); is a shorthand for the following call:
81
82       wborder_set(win, verch, verch,
83           horch, horch, NULL, NULL, NULL, NULL);
84
85       The  *line_set functions use wch to draw a line starting at the current
86       cursor position in the window.  The line is at most n  characters  long
87       or  as many as fit into the window.  The current cursor position is not
88       changed.
89
90       The hline_set, mvhline_set, mvwhline_set, and whline_set functions draw
91       a line proceeding toward the last column of the same line.
92
93       The vline_set, mvvline_set, mvwvline_set, and wvline_set functions draw
94       a line proceeding toward the last line of the window.
95

NOTES

97       Note  that  border_set,  hline_set,  mvhline_set,  mvvline_set,   mvwh‐
98       line_set, mvwvline_set, and vline_set may be macros.
99

RETURN VALUE

101       Upon successful completion, these functions return OK.  Otherwise, they
102       return ERR.
103
104       Functions using a window parameter return an error if it is null.
105
106       Functions with a "mv" prefix first  perform  a  cursor  movement  using
107       wmove, and return an error if the position is outside the window, or if
108       the window pointer is null.
109

SEE ALSO

111       ncurses(3X), curs_add_wch(3X), curs_border(3X), curs_outopts(3X)
112
113
114
115                                                           curs_border_set(3X)
Impressum