border_set(3xcurses)

1border_set(3XCURSES)    X/Open Curses Library Functions   border_set(3XCURSES)
2
3
4

NAME

6       border_set,  box_set,  wborder_set - use complex characters (and rendi‐
7       tions) to draw borders
8

SYNOPSIS

10       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
11        -R  /usr/xpg4/lib  -lcurses  [ library... ]
12
13       c89 [ flag... ] file... -lcurses [ library... ]
14
15       #include <curses.h>
16
17       int border_set(const cchar_t *ls, const cchar_t *rs, const cchar_t *ts,
18            const cchar_t *bs, const cchar_t *tl, const cchar_t *tr,
19            const cchar_t *bl,const cchar_t *br);
20
21
22       int wborder_set(WINDOW *win, const cchar_t *ls, const cchar_t *rs,
23            const cchar_t *ts,const cchar_t *bs, const cchar_t *tl,
24            const cchar_t *tr, const cchar_t *bl,const cchar_t *br);
25
26
27       int box_set(WINDOW *win, const cchar_t *verch, const cchar_t *horch);
28
29

DESCRIPTION

31       The border_set() and wborder_set() functions draw a border  around  the
32       specified  window.   All  parameters must be spacing complex characters
33       with renditions. A parameter which is a null pointer is replaced by the
34       default character.
35
36
37       Constant Values for Borders
38
39
40
41
42       ┌───────────────────────────────────────────────────────────────────────┐
43       │Constant Values for Borders                                            │
44       ├───────────────────────────────────────────────────────────────────────┤
45       │         Parameter             Default Constant     Default Character  │
46       ├───────────────────────────────────────────────────────────────────────┤
47       │          verch                   WACS_VLINE                |          │
48       │          horch                   WACS_HLINE                -          │
49       │            ls                    WACS_VLINE                |          │
50       │            rs                    WACS_VLINE                |          │
51       │            ts                    WACS_HLINE                -          │
52       │            bs                    WACS_HLINE                -          │
53       │            bl                  WACS_BLCORNER               +          │
54       │            br                  WACS_BRCORNER               +          │
55       │            tl                  WACS_ULCORNER               +          │
56       │            tr                  WACS_URCORNER               +          │
57       └───────────────────────────────────────────────────────────────────────┘
58
59
60       The call
61
62         box_set(win,
63         verch, horch)
64
65
66
67       is a short form for
68
69         wborder(win,
70         verch, verch,
71         horch, horch, NULL,
72         NULL, NULL, NULL)
73
74
75
76       When  the  window  is boxed, the bottom and top rows and right and left
77       columns  are unavailable for text.
78

PARAMETERS

80       ls       Is the character and rendition used for the left side  of  the
81                border.
82
83
84       rs       Is  the character and rendition used for the right side of the
85                border.
86
87
88       ts       Is the character and rendition used for the top of the border.
89
90
91       bs       Is the character and rendition used for the bottom of the bor‐
92                der.
93
94
95       tl       Is the character and rendition used for the top-left corner of
96                the border.
97
98
99       tr       Is the character and rendition used for the  top-right  corner
100                of the border.
101
102
103       bl       Is the character and rendition used for the bottom-left corner
104                of the border.
105
106
107       br       Is the character and rendition used for the bottom-right  cor‐
108                ner of the border.
109
110
111       win      Is  the pointer to the window in which the border or box is to
112                be drawn.
113
114
115       verch    Is the character and rendition used for  the  left  and  right
116                columns of the box.
117
118
119       horch    Is  the  character  and  rendition used for the top and bottom
120                rows of the box.
121
122

RETURN VALUES

124       On success, these functions return OK. Otherwise, they return ERR.
125

ERRORS

127       None.
128

ATTRIBUTES

130       See attributes(5) for descriptions of the following attributes:
131
132
133
134
135       ┌─────────────────────────────┬─────────────────────────────┐
136       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
137       ├─────────────────────────────┼─────────────────────────────┤
138       │Interface Stability          │Standard                     │
139       ├─────────────────────────────┼─────────────────────────────┤
140       │MT-Level                     │Unsafe                       │
141       └─────────────────────────────┴─────────────────────────────┘
142