1border(3XCURSES) X/Open Curses Library Functions border(3XCURSES)
2
3
4
6 border, box, wborder - add a single-byte border to a window
7
9 cc [ flag... ] file... -I /usr/xpg4/include -L /usr/xpg4/lib \
10 -R /usr/xpg4/lib -lcurses [ library... ]
11
12 c89 [ flag... ] file... -lcurses [ library... ]
13
14 #include <curses.h>
15
16 int border(chtype ls, chtype rs, chtype ts, chtype bs, chtype tl,
17 chtype tr, chtype bl, chtype br);
18
19
20 int wborder(WINDOW *win, chtype ls, chtype rs, chtype ts, chtype bs,
21 chtype tl,chtype tr, chtype bl, chtype br);
22
23
24 int box(WINDOW *win, chtype verch, chtype horch);
25
26
28 The border() and wborder() functions draw a border around the specified
29 window. All parameters must be single-byte characters whose rendition
30 can be expressed using only constants beginning with ACS_. A parameter
31 with the value of 0 is replaced by the default value.
32
33
34
35
36 ┌───────────────────────────────────────────────────────────────────────┐
37 │Constant Values for Borders │
38 ├───────────────────────────────────────────────────────────────────────┤
39 │ Parameter Default Constant Default Character │
40 ├───────────────────────────────────────────────────────────────────────┤
41 │ verch ACS_VLINE | │
42 │ horch ACS_HLINE - │
43 │ ls ACS_VLINE | │
44 │ rs ACS_VLINE | │
45 │ ts ACS_HLINE - │
46 │ bs ACS_HLINE - │
47 │ bl ACS_BLCORNER + │
48 │ br ACS_BRCORNER + │
49 │ tl ACS_ULCORNER + │
50 │ tr ACS_URCORNER + │
51 └───────────────────────────────────────────────────────────────────────┘
52
53
54 The call
55
56 box(win,
57 verch, horch)
58
59
60
61 is a short form for
62
63 wborder(win,
64 verch, verch,
65 horch, horch, 0, 0, 0,
66 0)
67
68
69
70 When the window is boxed, the bottom and top rows and right and left
71 columns overwrite existing text.
72
74 ls Is the character and rendition used for the left side of the
75 border.
76
77
78 rs Is the character and rendition used for the right side of the
79 border.
80
81
82 ts Is the character and rendition used for the top of the border.
83
84
85 bs Is the character and rendition used for the bottom of the bor‐
86 der.
87
88
89 tl Is the character and rendition used for the top-left corner of
90 the border.
91
92
93 tr Is the character and rendition used for the top-right corner
94 of the border.
95
96
97 bl Is the character and rendition used for the bottom-left corner
98 of the border.
99
100
101 br Is the character and rendition used for the bottom-right cor‐
102 ner of the border.
103
104
105 win Is the pointer to the window in which the border or box is to
106 be drawn.
107
108
109 verch Is the character and rendition used for the left and right
110 columns of the box.
111
112
113 horch Is the character and rendition used for the top and bottom
114 rows of the box.
115
116
118 On success, these functions return OK. Otherwise, they return ERR.
119
121 None.
122
124 See attributes(5) for descriptions of the following attributes:
125
126
127
128
129 ┌─────────────────────────────┬─────────────────────────────┐
130 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
131 ├─────────────────────────────┼─────────────────────────────┤
132 │Interface Stability │Standard │
133 ├─────────────────────────────┼─────────────────────────────┤
134 │MT-Level │Unsafe │
135 └─────────────────────────────┴─────────────────────────────┘
136
138 add_wch(3XCURSES), addch(3XCURSES), attr_get(3XCURSES),
139 attroff(3XCURSES), border_set(3XCURSES), libcurses(3XCURSES),
140 attributes(5), standards(5)
141
142
143
144SunOS 5.11 5 Jun 2002 border(3XCURSES)