X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_border.3x.html;h=20013f61ab522521a84f703b499e45eacc4890ea;hp=49176f3aabf249559a34b20e515eb431357f6f68;hb=HEAD;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_border.3x.html b/doc/html/man/curs_border.3x.html index 49176f3a..8ca35f21 100644 --- a/doc/html/man/curs_border.3x.html +++ b/doc/html/man/curs_border.3x.html @@ -1,7 +1,7 @@ - - + -curs_border 3x - - + + +curs_border 3x 2024-04-20 ncurses 6.4 Library calls + + -

curs_border 3x

-
+

curs_border 3x 2024-04-20 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, mvh-
-       line, mvwhline, mvvline, mvwvline - create curses borders,
-       horizontal and vertical lines
+

NAME

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

SYNOPSIS

+

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);
 
+       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
+       attributes:
 
-
-

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,
@@ -84,8 +87,10 @@
               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:
+
+       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,
@@ -95,58 +100,59 @@
               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).
+       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 posi-
-       tion 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  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 posi-
-       tion 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.
+

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  Curses  does  not   specify   any   error   conditions.    This
+       implementation returns an error if the window pointer is null.
 
-
-

NOTES

-       The borders generated by these functions are  inside  bor-
-       ders (this is also true of SVr4 curses, though the fact is
-       not documented).
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.
+
+
+

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.
+

PORTABILITY

+       These functions are described in X/Open Curses, Issue 4.
 
 
-
-

SEE ALSO

-       curses(3x), curs_outopts(3x).
+

SEE ALSO

+       curses(3x), curs_outopts(3x)
 
 
 
-                                                  curs_border(3x)
+ncurses 6.4                       2024-04-20                   curs_border(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +