ncurses 5.9 - patch 20150214
[ncurses.git] / doc / html / man / curs_border.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_border.3x,v 1.22 2010/12/04 18:36:44 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_border 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1>curs_border 3x</H1>
42 <HR>
43 <PRE>
44 <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>                                         <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>border</STRONG>, <STRONG>wborder</STRONG>, <STRONG>box</STRONG>, <STRONG>hline</STRONG>, <STRONG>whline</STRONG>, <STRONG>vline</STRONG>, <STRONG>wvline</STRONG>,
52        <STRONG>mvhline</STRONG>, <STRONG>mvwhline</STRONG>, <STRONG>mvvline</STRONG>, <STRONG>mvwvline</STRONG> - create <STRONG>curses</STRONG>
53        borders, horizontal and vertical lines
54
55
56 </PRE>
57 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
58        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
59        <STRONG>int</STRONG> <STRONG>border(chtype</STRONG> <STRONG>ls,</STRONG> <STRONG>chtype</STRONG> <STRONG>rs,</STRONG> <STRONG>chtype</STRONG> <STRONG>ts,</STRONG> <STRONG>chtype</STRONG> <STRONG>bs,</STRONG>
60           <STRONG>chtype</STRONG> <STRONG>tl,</STRONG> <STRONG>chtype</STRONG> <STRONG>tr,</STRONG> <STRONG>chtype</STRONG> <STRONG>bl,</STRONG> <STRONG>chtype</STRONG> <STRONG>br);</STRONG>
61        <STRONG>int</STRONG> <STRONG>wborder(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ls,</STRONG> <STRONG>chtype</STRONG> <STRONG>rs,</STRONG>
62           <STRONG>chtype</STRONG> <STRONG>ts,</STRONG> <STRONG>chtype</STRONG> <STRONG>bs,</STRONG> <STRONG>chtype</STRONG> <STRONG>tl,</STRONG> <STRONG>chtype</STRONG> <STRONG>tr,</STRONG>
63           <STRONG>chtype</STRONG> <STRONG>bl,</STRONG> <STRONG>chtype</STRONG> <STRONG>br);</STRONG>
64        <STRONG>int</STRONG> <STRONG>box(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>verch,</STRONG> <STRONG>chtype</STRONG> <STRONG>horch);</STRONG>
65        <STRONG>int</STRONG> <STRONG>hline(chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
66        <STRONG>int</STRONG> <STRONG>whline(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
67        <STRONG>int</STRONG> <STRONG>vline(chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
68        <STRONG>int</STRONG> <STRONG>wvline(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
69        <STRONG>int</STRONG> <STRONG>mvhline(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
70        <STRONG>int</STRONG> <STRONG>mvwhline(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
71        <STRONG>int</STRONG> <STRONG>mvvline(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
72        <STRONG>int</STRONG> <STRONG>mvwvline(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
73
74
75 </PRE>
76 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
77        The <STRONG>border</STRONG>, <STRONG>wborder</STRONG> and <STRONG>box</STRONG> routines draw a box around the
78        edges of a window.  Other than the window,  each  argument
79        is a character with attributes:
80
81               <EM>ls</EM> - left side,
82               <EM>rs</EM> - right side,
83               <EM>ts</EM> - top side,
84               <EM>bs</EM> - bottom side,
85               <EM>tl</EM> - top left-hand corner,
86               <EM>tr</EM> - top right-hand corner,
87               <EM>bl</EM> - bottom left-hand corner, and
88               <EM>br</EM> - bottom right-hand corner.
89
90        If  any of these arguments is zero, then the corresponding
91        default values (defined in <STRONG>curses.h</STRONG>) are used instead:
92
93               <STRONG>ACS_VLINE</STRONG>,
94               <STRONG>ACS_VLINE</STRONG>,
95               <STRONG>ACS_HLINE</STRONG>,
96               <STRONG>ACS_HLINE</STRONG>,
97               <STRONG>ACS_ULCORNER</STRONG>,
98               <STRONG>ACS_URCORNER</STRONG>,
99               <STRONG>ACS_LLCORNER</STRONG>,
100               <STRONG>ACS_LRCORNER</STRONG>.
101
102        <STRONG>box(</STRONG><EM>win</EM><STRONG>,</STRONG> <EM>verch</EM><STRONG>,</STRONG> <EM>horch</EM><STRONG>)</STRONG> is a shorthand  for  the  following
103        call:  <STRONG>wborder(</STRONG><EM>win</EM><STRONG>,</STRONG>  <EM>verch</EM><STRONG>,</STRONG>  <EM>verch</EM><STRONG>,</STRONG> <EM>horch</EM><STRONG>,</STRONG> <EM>horch</EM><STRONG>,</STRONG> <STRONG>0,</STRONG> <STRONG>0,</STRONG> <STRONG>0,</STRONG>
104        <STRONG>0)</STRONG>.
105
106        The <STRONG>hline</STRONG> and <STRONG>whline</STRONG> functions draw a horizontal (left  to
107        right)  line using <EM>ch</EM> starting at the current cursor posi-
108        tion in the window.  The current cursor  position  is  not
109        changed.   The  line  is  at most <EM>n</EM> characters long, or as
110        many as fit into the window.
111
112        The <STRONG>vline</STRONG> and <STRONG>wvline</STRONG> functions draw  a  vertical  (top  to
113        bottom) line using <EM>ch</EM> starting at the current cursor posi-
114        tion in the window.  The current cursor  position  is  not
115        changed.   The  line  is  at most <EM>n</EM> characters long, or as
116        many as fit into the window.
117
118
119 </PRE>
120 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
121        All routines return the integer  <STRONG>OK</STRONG>.   The  SVr4.0  manual
122        says  "or  a  non-negative integer if <STRONG>immedok</STRONG> is set", but
123        this appears to be an error.
124
125        X/Open does not define any error conditions.  This  imple-
126        mentation returns an error if the window pointer is null.
127
128        Functions  with a "mv" prefix first perform a cursor move-
129        ment using <STRONG>wmove</STRONG>, and return an error if the  position  is
130        outside the window, or if the window pointer is null.
131
132
133 </PRE>
134 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
135        The  borders  generated by these functions are <EM>inside</EM> bor-
136        ders (this is also true of SVr4 curses, though the fact is
137        not documented).
138
139        Note that <STRONG>border</STRONG> and <STRONG>box</STRONG> may be macros.
140
141
142 </PRE>
143 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
144        These  functions are described in the XSI Curses standard,
145        Issue 4.  The standard specifies that they return  <STRONG>ERR</STRONG>  on
146        failure, but specifies no error conditions.
147
148
149 </PRE>
150 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
151        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>.
152
153
154
155                                                         <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
156 </PRE>
157 <div class="nav">
158 <ul>
159 <li><a href="#h2-NAME">NAME</a></li>
160 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
161 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
162 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
163 <li><a href="#h2-NOTES">NOTES</a></li>
164 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
165 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
166 </ul>
167 </div>
168 </BODY>
169 </HTML>