-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
-<!--
+<!--
****************************************************************************
- * Copyright (c) 1998,2000 Free Software Foundation, Inc. *
+ * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 1998-2007,2010 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_border.3x,v 1.15 2002/02/16 22:21:47 tom Exp @
+ * @Id: curs_border.3x,v 1.27 2020/10/18 00:33:06 tom Exp @
-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
-<TITLE>curs_border 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<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>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
-<H1>curs_border 3x</H1>
-<HR>
+<H1 class="no-header">curs_border 3X</H1>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
+<B><A HREF="curs_border.3X.html">curs_border(3X)</A></B> <B><A HREF="curs_border.3X.html">curs_border(3X)</A></B>
-</PRE>
-<H2>NAME</H2><PRE>
- <STRONG>border</STRONG>, <STRONG>wborder</STRONG>, <STRONG>box</STRONG>, <STRONG>hline</STRONG>, <STRONG>whline</STRONG>, <STRONG>vline</STRONG>, <STRONG>wvline</STRONG>, <STRONG>mvh-</STRONG>
- <STRONG>line</STRONG>, <STRONG>mvwhline</STRONG>, <STRONG>mvvline</STRONG>, <STRONG>mvwvline</STRONG> - create <STRONG>curses</STRONG> borders,
- horizontal and vertical lines
-
-
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
- <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
- <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>
- <STRONG>chtype</STRONG> <STRONG>tl,</STRONG> <STRONG>chtype</STRONG> <STRONG>tr,</STRONG> <STRONG>chtype</STRONG> <STRONG>bl,</STRONG> <STRONG>chtype</STRONG> <STRONG>br);</STRONG>
- <STRONG>int</STRONG> <STRONG>wborder(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ls,</STRONG> <STRONG>chtype</STRONG> <STRONG>rs,</STRONG>
- <STRONG>chtype</STRONG> <STRONG>ts,</STRONG> <STRONG>chtype</STRONG> <STRONG>bs,</STRONG> <STRONG>chtype</STRONG> <STRONG>tl,</STRONG> <STRONG>chtype</STRONG> <STRONG>tr,</STRONG>
- <STRONG>chtype</STRONG> <STRONG>bl,</STRONG> <STRONG>chtype</STRONG> <STRONG>br);</STRONG>
- <STRONG>int</STRONG> <STRONG>box(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>verch,</STRONG> <STRONG>chtype</STRONG> <STRONG>horch);</STRONG>
- <STRONG>int</STRONG> <STRONG>hline(chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
- <STRONG>int</STRONG> <STRONG>whline(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
- <STRONG>int</STRONG> <STRONG>vline(chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
- <STRONG>int</STRONG> <STRONG>wvline(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch,</STRONG> <STRONG>int</STRONG> <STRONG>n);</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>
- <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>
- <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>
- <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>
-
-
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
- 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 attributes:
- <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 values (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>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>
- <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 posi-
- tion in the window. The current cursor position is not
- changed. The line is at most <EM>n</EM> characters long, or as
- many as fit into the window.
- The <STRONG>vline</STRONG> and <STRONG>wvline</STRONG> functions draw a vertical (top to
- bottom) line using <EM>ch</EM> starting at the current cursor posi-
- tion in the window. The current 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>RETURN VALUE</H2><PRE>
- 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.
-
-
-</PRE>
-<H2>NOTES</H2><PRE>
- The borders generated by these functions are <EM>inside</EM> bor-
- ders (this is also true of SVr4 curses, though the fact is
- not documented).
-
- Note that <STRONG>border</STRONG> and <STRONG>box</STRONG> may be macros.
-</PRE>
-<H2>PORTABILITY</H2><PRE>
- These functions are described in the XSI Curses standard,
- Issue 4. The standard specifies that they return <STRONG>ERR</STRONG> on
- failure, but specifies no error conditions.
-
-
-</PRE>
-<H2>SEE ALSO</H2><PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(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
+ lines
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+ <B>#include</B> <B><curses.h></B>
+ <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>
+ <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>
+ <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>
+ <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>
+</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
+ 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.
+ 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-
+ 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
+ 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.
+ 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
+ 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
+ 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><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
+ 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>.
+ <B><A HREF="curs_border.3X.html">curs_border(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>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+</ul>
+</div>
</BODY>
</HTML>
projects / ncurses.git / blobdiff