cursborder(3X) cursborder(3X)

NAME
       bboorrddeerr, wwbboorrddeerr, bbooxx, hhlliinnee, wwhhlliinnee, vvlliinnee, wwvvlliinnee, mmvvhhlliinnee, mmvvwwhhlliinnee,
       mmvvvvlliinnee, mmvvwwvvlliinnee - create ccuurrsseess borders, horizontal and vertical
       lines

SYNOPSIS
       ##iinncclluuddee <>
       iinntt bboorrddeerr((cchhttyyppee llss,, cchhttyyppee rrss,, cchhttyyppee ttss,, cchhttyyppee bbss,,
          cchhttyyppee ttll,, cchhttyyppee ttrr,, cchhttyyppee bbll,, cchhttyyppee bbrr));;
       iinntt wwbboorrddeerr((WWIINNDDOOWW **wwiinn,, cchhttyyppee llss,, cchhttyyppee rrss,,
          cchhttyyppee ttss,, cchhttyyppee bbss,, cchhttyyppee ttll,, cchhttyyppee ttrr,,
          cchhttyyppee bbll,, cchhttyyppee bbrr));;
       iinntt bbooxx((WWIINNDDOOWW **wwiinn,, cchhttyyppee vveerrcchh,, cchhttyyppee hhoorrcchh));;
       iinntt hhlliinnee((cchhttyyppee cchh,, iinntt nn));;
       iinntt wwhhlliinnee((WWIINNDDOOWW **wwiinn,, cchhttyyppee cchh,, iinntt nn));;
       iinntt vvlliinnee((cchhttyyppee cchh,, iinntt nn));;
       iinntt wwvvlliinnee((WWIINNDDOOWW **wwiinn,, cchhttyyppee cchh,, iinntt nn));;
       mmvvhhlliinnee((iinntt yy,, iinntt xx,, cchhttyyppee cchh,, iinntt nn));;
       mmvvwwhhlliinnee((WWIINNDDOOWW **,, iinntt yy,, iinntt xx,, cchhttyyppee cchh,, iinntt nn));;
       iinntt mmvvvvlliinnee((iinntt yy,, iinntt xx,, cchhttyyppee cchh,, iinntt nn));;
       iinntt mmvvwwvvlliinnee((WWIINNDDOOWW **,, iinntt yy,, iinntt xx,, cchhttyyppee cchh,, iinntt nn));;

DESCRIPTION
       The  bboorrddeerr,  wwbboorrddeerr and bbooxx routines draw a box around the edges of a
       window.  Other than the window, each argument is a character  with  at-
       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 (defined in ccuurrsseess..hh) are used instead:
              AACCSSVVLLIINNEE,
              AACCSSVVLLIINNEE,
              AACCSSHHLLIINNEE,
              AACCSSHHLLIINNEE,
              AACCSSUULLCCOORRNNEERR,
              AACCSSUURRCCOORRNNEERR,
              AACCSSLLLLCCOORRNNEERR,
              AACCSSLLRRCCOORRNNEERR.

       bbooxx((win,, verch,, horch)) is a shorthand for  the  following  call:  wwbboorr-
       ddeerr((win,, verch,, verch,, horch,, horch,, 00,, 00,, 00,, 00)).

       The  hhlliinnee  and wwhhlliinnee 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 long, or as many as fit into the window.

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

RREETTUURRNN VVAALLUUEE
       All  routines return the integer OOKK.  The SVr4.0 manual says "or a non-
       negative integer if iimmmmeeddookk 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.

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

       Note that bboorrddeerr and bbooxx may be macros.

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

SEE ALSO
       ccuurrsseess(3X), ccuurrssoouuttooppttss(3X).



                                                               cursborder(3X)