<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_border 3X</TITLE>
+<TITLE>curs_border 3x</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
-<H1 class="no-header">curs_border 3X</H1>
+<H1 class="no-header">curs_border 3x</H1>
<PRE>
-<B><A HREF="curs_border.3X.html">curs_border(3X)</A></B> <B><A HREF="curs_border.3X.html">curs_border(3X)</A></B>
+<STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG> <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <B>border</B>, <B>wborder</B>, <B>box</B>, <B>hline</B>, <B>whline</B>, <B>vline</B>, <B>wvline</B>, <B>mvhline</B>, <B>mvwhline</B>,
- <B>mvvline</B>, <B>mvwvline</B> - create <B>curses</B> borders, horizontal and vertical
+ <STRONG>border</STRONG>, <STRONG>wborder</STRONG>, <STRONG>box</STRONG>, <STRONG>hline</STRONG>, <STRONG>whline</STRONG>, <STRONG>vline</STRONG>, <STRONG>wvline</STRONG>, <STRONG>mvhline</STRONG>, <STRONG>mvwhline</STRONG>,
+ <STRONG>mvvline</STRONG>, <STRONG>mvwvline</STRONG> - create <STRONG>curses</STRONG> borders, horizontal and vertical
lines
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <B>#include</B> <B><curses.h></B>
+ <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
- <B>int</B> <B>border(chtype</B> <I>ls</I><B>,</B> <B>chtype</B> <I>rs</I><B>,</B> <B>chtype</B> <I>ts</I><B>,</B> <B>chtype</B> <I>bs</I><B>,</B>
- <B>chtype</B> <I>tl</I><B>,</B> <B>chtype</B> <I>tr</I><B>,</B> <B>chtype</B> <I>bl</I><B>,</B> <B>chtype</B> <I>br</I><B>);</B>
- <B>int</B> <B>wborder(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>chtype</B> <I>ls</I><B>,</B> <B>chtype</B> <I>rs</I><B>,</B>
- <B>chtype</B> <I>ts</I><B>,</B> <B>chtype</B> <I>bs</I><B>,</B> <B>chtype</B> <I>tl</I><B>,</B> <B>chtype</B> <I>tr</I><B>,</B>
- <B>chtype</B> <I>bl</I><B>,</B> <B>chtype</B> <I>br</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>border(chtype</STRONG> <EM>ls</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>rs</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ts</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>bs</EM><STRONG>,</STRONG>
+ <STRONG>chtype</STRONG> <EM>tl</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>tr</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>bl</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>br</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>wborder(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ls</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>rs</EM><STRONG>,</STRONG>
+ <STRONG>chtype</STRONG> <EM>ts</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>bs</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>tl</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>tr</EM><STRONG>,</STRONG>
+ <STRONG>chtype</STRONG> <EM>bl</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>br</EM><STRONG>);</STRONG>
- <B>int</B> <B>box(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>chtype</B> <I>verch</I><B>,</B> <B>chtype</B> <I>horch</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>box(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>verch</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>horch</EM><STRONG>);</STRONG>
- <B>int</B> <B>hline(chtype</B> <I>ch</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
- <B>int</B> <B>whline(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>chtype</B> <I>ch</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
- <B>int</B> <B>vline(chtype</B> <I>ch</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
- <B>int</B> <B>wvline(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>chtype</B> <I>ch</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>hline(chtype</STRONG> <EM>ch</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>whline(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>vline(chtype</STRONG> <EM>ch</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>wvline(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
- <B>int</B> <B>mvhline(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>chtype</B> <I>ch</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
- <B>int</B> <B>mvwhline(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>chtype</B> <I>ch</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
- <B>int</B> <B>mvvline(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>chtype</B> <I>ch</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
- <B>int</B> <B>mvwvline(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>chtype</B> <I>ch</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>mvhline(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>mvwhline(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>mvvline(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>mvwvline(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- The <B>border</B>, <B>wborder</B> and <B>box</B> routines draw a box around the edges of a
+ The <STRONG>border</STRONG>, <STRONG>wborder</STRONG> and <STRONG>box</STRONG> routines draw a box around the edges of a
window. Other than the window, each argument is a character with at-
tributes:
- <I>ls</I> - left side,
- <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.
+ <EM>ls</EM> - left side,
+ <EM>rs</EM> - right side,
+ <EM>ts</EM> - top side,
+ <EM>bs</EM> - bottom side,
+ <EM>tl</EM> - top left-hand corner,
+ <EM>tr</EM> - top right-hand corner,
+ <EM>bl</EM> - bottom left-hand corner, and
+ <EM>br</EM> - bottom right-hand corner.
If any of these arguments is zero, then the corresponding default val-
- ues (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>wbor-</B>
- <B>der(</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 position in the window. The
- current cursor position is not changed. The line is at most <I>n</I> charac-
+ ues (defined in <STRONG>curses.h</STRONG>) are used instead:
+
+ <STRONG>ACS_VLINE</STRONG>,
+ <STRONG>ACS_VLINE</STRONG>,
+ <STRONG>ACS_HLINE</STRONG>,
+ <STRONG>ACS_HLINE</STRONG>,
+ <STRONG>ACS_ULCORNER</STRONG>,
+ <STRONG>ACS_URCORNER</STRONG>,
+ <STRONG>ACS_LLCORNER</STRONG>,
+ <STRONG>ACS_LRCORNER</STRONG>.
+
+ <STRONG>box(</STRONG><EM>win</EM><STRONG>,</STRONG> <EM>verch</EM><STRONG>,</STRONG> <EM>horch</EM><STRONG>)</STRONG> is a shorthand for the following call: <STRONG>wbor-</STRONG>
+ <STRONG>der(</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> <STRONG>0)</STRONG>.
+
+ The <STRONG>hline</STRONG> and <STRONG>whline</STRONG> functions draw a horizontal (left to right) line
+ using <EM>ch</EM> starting at the current cursor position in the window. The
+ current cursor position is not changed. The line is at most <EM>n</EM> charac-
ters 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 us-
- ing <I>ch</I> starting at the current cursor position in the window. The cur-
- rent cursor position is not changed. The line is at most <I>n</I> characters
+ The <STRONG>vline</STRONG> and <STRONG>wvline</STRONG> functions draw a vertical (top to bottom) line us-
+ ing <EM>ch</EM> starting at the current cursor position in the window. The cur-
+ rent cursor position is not changed. The line is at most <EM>n</EM> characters
long, or as many as fit into the window.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></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.
+ All routines return the integer <STRONG>OK</STRONG>. The SVr4.0 manual says "or a non-
+ negative integer if <STRONG>immedok</STRONG> is set", but this appears to be an error.
X/Open does not define any error conditions. This implementation re-
turns an error if the window pointer is null.
Functions with a "mv" prefix first perform a cursor movement using
- <B>wmove</B>, and return an error if the position is outside the window, or if
+ <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
the window pointer is null.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
- The borders generated by these functions are <I>inside</I> borders (this is
+ The borders generated by these functions are <EM>inside</EM> borders (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.
+ Note that <STRONG>border</STRONG> and <STRONG>box</STRONG> may be macros.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
These functions are described in the XSI Curses standard, Issue 4. The
- standard specifies that they return <B>ERR</B> on failure, but specifies no
+ standard specifies that they return <STRONG>ERR</STRONG> on failure, but specifies no
error conditions.
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_outopts.3X.html">curs_outopts(3X)</A></B>.
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>.
- <B><A HREF="curs_border.3X.html">curs_border(3X)</A></B>
+ <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>