box(3ncurses)


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);
   int mvhline(int y, int x, chtype ch, int n);
   int 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
   attributes:

          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
   values (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:
   wborder(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
   characters long, or as many as fit into the window.

   The vline and wvline functions draw a vertical  (top  to  bottom)  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
   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 integer if immedok is set", but this appears to be an error.

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

   Functions  with  a  "mv"  prefix  first perform a cursor movement using
   wmove, and return an error if the position is outside the window, or 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

   ncurses(3NCURSES), outopts(3NCURSES).

                                                          border(3NCURSES)


More Linux Commands

manpages/fconfigure.n.html
fconfigure(n) - Set and get options on a channel (Man Page)
The fconfigure command sets and retrieves options for channels. ChannelId identifies the channel for which to set or query an option and must refer to an open c

manpages/XUnionRegion.3.html
XUnionRegion(3) - region arithmetic - Linux manual page.....
The XIntersectRegion function computes the intersection of two regions. The XUnionRegion function computes the union of two regions. The XUnionRectWithRegion fu

manpages/exit.2.html
exit(2) - terminate the calling process - Linux manual page
The function _exit() terminates the calling process immediately. Any open file descriptors belonging to the process are closed; any children of the process are

manpages/pam_timestamp_check.8.html
pam_timestamp_check(8) - Check to see if the default timesta
With no arguments pam_timestamp_check will check to see if the default timestamp is valid, or optionally remove it. OPTIONS -k Instead of checking the validity

manpages/va_arg.3.html
va_arg(3) - variable argument lists - Linux manual page.....
A function may be called with a varying number of arguments of varying types. The include file &lt;stdarg.h&gt; declares a type va_list and defines three macros for s

manpages/gnutls_dh_get_pubkey.3.html
gnutls_dh_get_pubkey(3) - API function - Linux manual page
This function will return the peers public key used in the last Diffie-Hellman key exchange. This function should be used for both anonymous and ephemeral Diffi

manpages/filter.3x.lc.html
filter.3x(lc) miscellaneous curses utility routines.........
The unctrl routine returns a character string which is a printable representation of the character c, ignoring attributes. Control characters are displayed in t

manpages/gnutls_deinit.3.html
gnutls_deinit(3) - API function (Library - Linux man page)
This function clears all buffers associated with the session. This function will also remove session data from the session database if the session was terminate

manpages/pcre16_get_stringtable_entries.3.html
pcre16_get_stringtable_entries(3) Perl-compatible regular ex
This convenience function finds, for a compiled pattern, the first and last entries for a given name in the table that translates capturing parenthesis names in

manpages/curl_share_strerror.3.html
curl_share_strerror(3) - return string describing error code
The curl_share_strerror() function returns a string describing the CURLSHcode error code passed in the argument errornum. AVAILABILITY This function was added i

manpages/sendinpaths.8.html
sendinpaths(8) - Send Usenet Path: statistics via e-mail....
sendinpaths checks pathlog/path for ninpaths dump files, finds dump files generated in the past 30 days, makes sure they are valid by running ninpaths on each o

manpages/makedbz.8.html
makedbz(8) - Rebuild dbz files (Admin - Linux man page).....
makedbz rebuilds dbz(3) database. The default name of the text file is pathdb/history; to specify a different name, use the -f flag. OPTIONS -f filename If the





We can't live, work or learn in freedom unless the software we use is free.