doc/html/man/curs_border.3x.html

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