1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
<HTML>
<BODY>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
</PRE>
<H2>NAME</H2><PRE>
<B>border</B>, <B>wborder</B>, <B>box</B>, <B>hline</B>, <B>whline</B>, <B>vline</B>, <B>wvline</B>, <B>mvh-</B>
<B>line</B>, <B>mvwhline</B>, <B>mvvline</B>, <B>mvwvline</B> - create <B>curses</B> borders,
horizontal and vertical lines
</PRE>
<H2>SYNOPSIS</H2><PRE>
<B>#include</B> <B><curses.h></B>
<B>int</B> <B>border(chtype</B> <B>ls,</B> <B>chtype</B> <B>rs,</B> <B>chtype</B> <B>ts,</B> <B>chtype</B> <B>bs,</B>
<B>chtype</B> <B>tl,</B> <B>chtype</B> <B>tr,</B> <B>chtype</B> <B>bl,</B> <B>chtype</B> <B>br);</B>
<B>int</B> <B>wborder(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>ls,</B> <B>chtype</B> <B>rs,</B>
<B>chtype</B> <B>ts,</B> <B>chtype</B> <B>bs,</B> <B>chtype</B> <B>tl,</B> <B>chtype</B> <B>tr,</B>
<B>chtype</B> <B>bl,</B> <B>chtype</B> <B>br);</B>
<B>int</B> <B>box(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>verch,</B> <B>chtype</B> <B>horch);</B>
<B>int</B> <B>hline(chtype</B> <B>ch,</B> <B>int</B> <B>n);</B>
<B>int</B> <B>whline(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>ch,</B> <B>int</B> <B>n);</B>
<B>int</B> <B>vline(chtype</B> <B>ch,</B> <B>int</B> <B>n);</B>
<B>int</B> <B>wvline(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>ch,</B> <B>int</B> <B>n);</B>
<B>mvhline(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>ch,</B> <B>int</B> <B>n);</B>
<B>mvwhline(WINDOW</B> <B>*,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>ch,</B> <B>int</B> <B>n);</B>
<B>int</B> <B>mvvline(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>ch,</B> <B>int</B> <B>n);</B>
<B>int</B> <B>mvwvline(WINDOW</B> <B>*,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>ch,</B> <B>int</B> <B>n);</B>
</PRE>
<H2>DESCRIPTION</H2><PRE>
The <B>border</B>, <B>wborder</B> and <B>box</B> routines draw a box around the
edges of a window. The argument <I>ls</I> is a character and
attributes used for the left side of the border, <I>rs</I> -
right side, <I>ts</I> - top side, <I>bs</I> - bottom side, <I>tl</I> - top
left-hand corner, <I>tr</I> - top right-hand corner, <I>bl</I> - bottom
left-hand corner, and <I>br</I> - bottom right-hand corner. If
any of these arguments is zero, then the following default
values (defined in <B>curses.h</B>) are used instead: <B>ACS_VLINE</B>,
<B>ACS_VLINE</B>, <B>ACS_HLINE</B>, <B>ACS_HLINE</B>, <B>ACS_ULCORNER</B>,
<B>ACS_URCORNER</B>, <B>ACS_LLCORNER</B>, <B>ACS_LRCORNER</B>.
<B>box(</B><I>win</I><B>,</B> <I>verch</I><B>,</B> <I>horch</I><B>)</B> is a shorthand for the following
call: <B>wborder(</B><I>win</I><B>,</B> <I>verch</I><B>,</B> <I>verch</I><B>,</B> <I>horch</I><B>,</B> <I>horch</I><B>,</B> <B>0,</B> <B>0,</B> <B>0,</B>
<B>0)</B>.
The <B>hline</B> and <B>whline</B> functions draw a horizontal (left to
right) line using <I>ch</I> starting at the current cursor posi-
tion in the window. The current cursor position is not
changed. The line is at most <I>n</I> characters long, or as
many as fit into the window.
The <B>vline</B> and <B>wvline</B> functions draw a vertical (top to
bottom) line using <I>ch</I> starting at the current cursor posi-
tion in the window. The current cursor position is not
changed. The line is at most <I>n</I> characters long, or as
many as fit into the window.
</PRE>
<H2>RETURN VALUE</H2><PRE>
All routines return the integer <B>OK</B>. The SVr4.0 manual
says "or a non-negative integer if <B>immedok</B> is set", but
this appears to be an error.
</PRE>
<H2>NOTES</H2><PRE>
The borders generated by these functions are <I>inside</I> bor-
ders (this is also true of SVr4 curses, though the fact is
not documented).
Note that <B>border</B> and <B>box</B> may be macros.
</PRE>
<H2>PORTABILITY</H2><PRE>
These functions are described in the XSI Curses standard,
Issue 4. Additional functions <B>mvhline</B>, <B>mvvline</B>, <B>mvwhline</B>,
and <B>mvwvline</B> are described there which this implementation
does not yet support. The standard specifies that they
return <B>ERR</B> on failure, but specifies no error conditions.
</PRE>
<H2>SEE ALSO</H2><PRE>
<B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B>.
</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>
|
