X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_overlay.3x.html;h=69ed0fcaafa1c88945fef844a2d1974875ff1abb;hp=d2af67a8f566b851bfdefd9cefec1e9f3a2e49d8;hb=3a935d9991cdf43ebfa952073c9b555f73a3e011;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_overlay.3x.html b/doc/html/man/curs_overlay.3x.html index d2af67a8..69ed0fca 100644 --- a/doc/html/man/curs_overlay.3x.html +++ b/doc/html/man/curs_overlay.3x.html @@ -1,75 +1,117 @@ + + + +curs_overlay 3x + + + +

curs_overlay 3x

 
+curs_overlay(3x)                                       curs_overlay(3x)
+
+
+

NAME

-       overlay, overwrite, copywin - overlay and manipulate over-
-       lapped curses windows
+       overlay, overwrite, copywin - overlay and manipulate
+       overlapped curses windows

SYNOPSIS

-       #include <curses.h>
+       #include <curses.h>
 
-       int overlay(const WINDOW *srcwin, WINDOW *dstwin);
-       int overwrite(const WINDOW *srcwin, WINDOW *dstwin);
-       int copywin(WINDOW *srcwin, WINDOW *dstwin, int sminrow,
-             int smincol, int dminrow, int dmincol, int dmaxrow,
-             int dmaxcol, int overlay);
+       int overlay(const WINDOW *srcwin, WINDOW *dstwin);
+       int overwrite(const WINDOW *srcwin, WINDOW *dstwin);
+       int copywin(const  WINDOW  *srcwin,  WINDOW  *dstwin,  int
+       sminrow,
+             int smincol, int dminrow, int dmincol, int dmaxrow,
+             int dmaxcol, int overlay);

DESCRIPTION

-       The overlay and overwrite routines overlay srcwin  on  top
-       of  dstwin.   scrwin and dstwin are not required to be the
-       same size; only text where  the  two  windows  overlap  is
-       copied.  The difference is that overlay is non-destructive
-       (blanks are not copied) whereas overwrite is  destructive.
-
-       The  copywin  routine provides a finer granularity of con-
-       trol over the overlay and overwrite routines.  Like in the
-       prefresh routine, a rectangle is specified in the destina-
-       tion window, (dminrow, dmincol)  and  (dmaxrow,  dmaxcol),
+       The  overlay  and overwrite routines overlay srcwin on top
+       of dstwin.  scrwin and dstwin are not required to  be  the
+       same  size;  only  text  where  the two windows overlap is
+       copied.  The difference is that overlay is non-destructive
+       (blanks are not copied) whereas overwrite is destructive.
+
+       The  copywin  routine provides a finer granularity of con-
+       trol over the overlay and overwrite routines.  Like in the
+       prefresh routine, a rectangle is specified in the destina-
+       tion window, (dminrow, dmincol)  and  (dmaxrow,  dmaxcol),
        and  the  upper-left-corner coordinates of the source win-
-       dow, (sminrow, smincol).  If the argument overlay is true,
-       then copying is non-destructive, as in overlay.
+       dow, (sminrow, smincol).  If the argument overlay is true,
+       then copying is non-destructive, as in overlay.

RETURN VALUE

-       Routines  that  return an integer return ERR upon failure,
-       and OK (SVr4 only specifies "an integer value  other  than
-       ERR") upon successful completion.
+       Routines  that  return an integer return ERR upon failure,
+       and OK (SVr4 only specifies "an integer value  other  than
+       ERR") upon successful completion.
+
+       X/Open  defines  no error conditions.  In this implementa-
+       tion, copywin, overlay and overwrite return  an  error  if
+       either of the window pointers are null, or if some part of
+       the window would be placed off-screen.

NOTES

-       Note that overlay and overwrite may be macros.
+       Note that overlay and overwrite may be macros.

PORTABILITY

        The XSI Curses standard, Issue 4 describes these functions
        (adding the const qualifiers).  It further specifies their
-       behavior  in  the  presence  of characters with multi-byte
-       renditions (not yet supported in this implementation).
+       behavior in the presence of characters with multibyte ren-
+       ditions (not yet supported in this implementation).