curs_border_set 3x

curs_border_set(3x)                                 curs_border_set(3x)

NAME

       border_set, wborder_set, box_set, hline_set, whline_set,
       mvhline_set, mvwhline_set, vline_set, wvline_set,
       mvvline_set, mvwvline_set - create curses borders or lines
       using complex characters and renditions

SYNOPSIS

       #include <curses.h>

       int border_set(
          const cchar_t *ls, const cchar_t *rs,
          const cchar_t *ts, const cchar_t *bs,
          const cchar_t *tl, const cchar_t *tr,
          const cchar_t *bl, const cchar_t *br );
       int wborder_set(
          WINDOW *win,
          const cchar_t *ls, const cchar_t *rs,
          const cchar_t *ts, const cchar_t *bs,
          const cchar_t *tl, const cchar_t *tr,
          const cchar_t *bl, const cchar_t *br);
       int box_set(
          WINDOW *win,
          const cchar_t *verch,
          const cchar_t *horch);
       int hline_set(
          const cchar_t *wch, int n);
       int whline_set(
          WINDOW *win,
          const cchar_t *wch, int n);
       int mvhline_set(
          int y, int x,
          const cchar_t *wch, int n);
       int mvwhline_set(
          WINDOW *win,
          int y, int x,
          const cchar_t *wch, int n);
       int vline_set(
          const cchar_t *wch, int n);
       int wvline_set(
          WINDOW *win,
          const cchar_t *wch, int n);
       int mvvline_set(
          int y, int x,
          const cchar_t *wch, int n);
       int mvwvline_set(
          WINDOW *win,
          int y, int x,
          const cchar_t *wch, int n);

DESCRIPTION

       The border_set and wborder_set  functions  draw  a  border
       around  the  edges  of  the  current  or specified window.
       These functions do not change the cursor position, and  do
       not wrap.

       Other  than the window, each argument is a complex charac-
       ter 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:
              WACS4nsiders using the hardware insert/delete char-
       acter feature of terminals so equipped.  Use of  character
       insert/delete  is  enabled by default.  Calling idcok with
       TRUE as second argument re-enables use of character inser-
       tion and deletion.

       If  immedok is called with TRUE as argument, any change in
       the window image, such as the ones caused by waddch, wclr-
       tobot,  wscrl,  etc.,  automatically  cause a call to wre-
       fresh.  However, it may degrade performance  considerably,
       due  to repeated calls to wrefresh.  It is disabled by de-
       fault.

       Normally, the hardware cursor is left at the  location  of
       the window cursor being refreshed.  The leaveok option al-
       lows the cursor to be left wherever the update happens  to
       leave  it.  It is useful for applications where the cursor
       is not used, since it reduces the need for cursor motions.

       The  setscrreg  and wsetscrreg routines allow the applica-
       tion programmer to set a software scrolling  region  in  a
       window.   top  and bot are the line numbers of the top and
       bottom margin of the scrolling region.  (Line 0 is the top
       line  of the window.)  If this option and scrollok are en-
       abled, an attempt to move off the bottom margin line caus-
       es all lines in the scrolling region to scroll one line in
       the direction of the first line.  Only  the  text  of  the
       window  is  scrolled.   (Note  that this has nothing to do
       with the use of a physical scrolling region capability  in
       the terminal, like that in the VT100.  If idlok is enabled
       and the terminal has either  a  scrolling  region  or  in-
       sert/delete line capability, they will probably be used by
       the output routines.)

       The scrollok option controls what happens when the  cursor
       of  a  window  is  moved  off  the  edge  of the window or
       scrolling region, either as a result of a  newline  action
       on  the  bottom  line, or typing the last character of the
       last line.  If disabled, (bf is FALSE), the cursor is left
       on  the bottom line.  If enabled, (<