X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_border.3x.html;h=e03b5f10efff41359bd1eac773c9f636468cb397;hb=67327e4e3b2121f8273fb73ec14ef234ed01231e;hp=abc282c6f2362d68abdc663b7cddc5112e7bfd00;hpb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72;p=ncurses.git diff --git a/doc/html/man/curs_border.3x.html b/doc/html/man/curs_border.3x.html index abc282c6..e03b5f10 100644 --- a/doc/html/man/curs_border.3x.html +++ b/doc/html/man/curs_border.3x.html @@ -1,6 +1,7 @@ - -curs_border 3x - - +curs_border 3x 2023-12-16 ncurses 6.4 Library calls + + -

curs_border 3x

curs_border 3x 2023-12-16 ncurses 6.4 Library calls

-curs_border(3x)                                                curs_border(3x)
+curs_border(3x)                  Library calls                 curs_border(3x)

NAME

-       border, wborder, box, hline, whline, vline, wvline, mvhline, mvwhline,
-       mvvline, mvwvline - create curses borders, horizontal and vertical
-       lines
+       border,  wborder, box, hline, whline, vline, wvline, mvhline, mvwhline,
+       mvvline, mvwvline - draw borders  and  lines  in  a  curses  window  of
+       characters

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);
+
+       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 *win, int y, int x, chtype ch, int n);
+       int mvvline(int y, int x, chtype ch, int n);
+       int mvwvline(WINDOW *win, 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:
+       window.  Other than the window,  each  argument  is  a  character  with
+       attributes:
 
               ls - left side,
               rs - right side,
@@ -83,8 +88,8 @@
               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 curses.h) are used instead:
+       If  any  of  these  arguments  is  zero, then the corresponding default
+       values (defined in curses.h) are used instead:
 
               ACS_VLINE,
               ACS_VLINE,
@@ -95,26 +100,26 @@
               ACS_LLCORNER,
               ACS_LRCORNER.
 
-       box(win, verch, horch) is a shorthand for  the  following  call:  wbor-
-       der(win, verch, verch, horch, horch, 0, 0, 0, 0).
+       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 charac-
-       ters long, or as many as fit into the window.
+       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 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.
+       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  re-
-       turns an error if the window pointer is null.
+       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
@@ -129,17 +134,15 @@

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.
+       These functions are described in the XSI Curses standard, Issue 4.