iOS Manual Pages

This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

curs_border(3X)                                                curs_border(3X)



NAME
       border, wborder, box, hline, whline, vline, wvline, mvhline, mvwhline,
       mvvline, mvwvline - create curses borders, horizontal and vertical
       lines

SYNOPSIS
       #include <curses.h>
       int border(chtype ls, chtype rs, chtype ts, chtype bs,
          chtype tl, chtype tr, chtype bl, chtype br);
       int wborder(WINDOW *win, chtype ls, chtype rs,
          chtype ts, chtype bs, chtype tl, chtype tr,
          chtype bl, chtype br);
       int box(WINDOW *win, chtype verch, chtype horch);
       int hline(chtype ch, int n);
       int whline(WINDOW *win, chtype ch, int n);
       int vline(chtype ch, int n);
       int wvline(WINDOW *win, chtype ch, int n);
       mvhline(int y, int x, chtype ch, int n);
       mvwhline(WINDOW *, int y, int x, chtype ch, int n);
       int mvvline(int y, int x, chtype ch, int n);
       int mvwvline(WINDOW *, int y, int x, chtype ch, int n);

DESCRIPTION
       The  border,  wborder and box routines draw a box around the edges of a
       window.  Other than the window, each argument is a character  with  at-tributes: attributes:
       tributes:
              ls - left side,
              rs - right side,
              ts - top side,
              bs - bottom side,
              tl - top left-hand corner,
              tr - top right-hand corner,
              bl - bottom left-hand corner, and
              br - bottom right-hand corner.
       If  any of these arguments is zero, then the corresponding default val-ues values
       ues (defined in curses.h) are used instead:
              ACS_VLINE,
              ACS_VLINE,
              ACS_HLINE,
              ACS_HLINE,
              ACS_ULCORNER,
              ACS_URCORNER,
              ACS_LLCORNER,
              ACS_LRCORNER.

       box(win, verch, horch) is a shorthand for  the  following  call:  wbor-der(win, wborder(win,
       der(win, verch, verch, horch, horch, 0, 0, 0, 0).

       The  hline  and whline functions draw a horizontal (left to right) line
       using ch starting at the current cursor position in  the  window.   The
       current  cursor position is not changed.  The line is at most n charac-ters characters
       ters long, or as many as fit into the window.

       The vline and wvline functions draw a vertical (top to bottom) line us-ing using
       ing ch starting at the current cursor position in the window.  The cur-rent current
       rent cursor position is not changed.  The line is at most n  characters
       long, or as many as fit into the window.

RETURN VALUE
       All  routines return the integer OK.  The SVr4.0 manual says "or a non-negative nonnegative
       negative integer if immedok is set", but this appears to be an error.

       X/Open does not define any error conditions.  This  implementation  re-turns returns
       turns an error if the window pointer is null.

NOTES
       The  borders  generated  by these functions are inside borders (this is
       also true of SVr4 curses, though the fact is not documented).

       Note that border and box may be macros.

PORTABILITY
       These functions are described in the XSI Curses standard, Issue 4.  The
       standard  specifies  that  they return ERR on failure, but specifies no
       error conditions.

SEE ALSO
       curses(3X), curs_outopts(3X).



                                                               curs_border(3X)