X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_overlay.3x.html;h=868c4224f4305e07b09d50ae6a858d4733ebd22e;hb=67327e4e3b2121f8273fb73ec14ef234ed01231e;hp=d2af67a8f566b851bfdefd9cefec1e9f3a2e49d8;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34;p=ncurses.git diff --git a/doc/html/man/curs_overlay.3x.html b/doc/html/man/curs_overlay.3x.html index d2af67a8..868c4224 100644 --- a/doc/html/man/curs_overlay.3x.html +++ b/doc/html/man/curs_overlay.3x.html @@ -1,80 +1,128 @@ + + + + + +curs_overlay 3x 2023-12-16 ncurses 6.4 Library calls + + + +

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

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

NAME

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

SYNOPSIS

-       #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);
+

NAME

+       overlay,  overwrite,  copywin  -  overlay curses windows and manipulate
+       them
 
 
-
-

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

SYNOPSIS

+       #include <curses.h>
 
+       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);
 
-
-

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

DESCRIPTION

 
-
-

NOTES

-       Note that overlay and overwrite may be macros.
+

overlay, overwrite

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

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

copywin

+       The copywin routine provides a finer granularity of  control  over  the
+       overlay  and  overwrite  routines.   As  in  the  prefresh  routine,  a
+       rectangle is specified in the destination  window,  (dminrow,  dmincol)
+       and  (dmaxrow,  dmaxcol),  and the upper-left-corner coordinates of the
+       source window, (sminrow, smincol).  If the argument  overlay  is  true,
+       then copying is non-destructive, as in overlay.
 
 
-
-

SEE ALSO

-       curses(3x), curs_pad(3x), curs_refresh(3x)
+

RETURN VALUE

+       These  routines  return  the  integer  ERR upon failure and an OK (SVr4
+       specifies only "an integer  value  other  than  ERR")  upon  successful
+       completion.
 
+       X/Open  defines  no error conditions.  In this implementation, 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.
 
 
+

PORTABILITY

+       These  functions  are  described  in  the XSI Curses standard, Issue 4,
+       which adds const qualifiers to the  arguments.   It  further  specifies
+       their  behavior in the presence of characters with multibyte renditions
+       (not yet supported in this implementation).
 
 
+

SEE ALSO

+       curses(3x), curs_pad(3x), curs_refresh(3x)
 
 
 
+ncurses 6.4                       2023-12-16                  curs_overlay(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +