X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_overlay.3x.html;h=7c6064034054bf601cc2bfbe81a2aa486447769c;hp=64b4f71e61d656dc0807cb44ec044414bf46f8df;hb=db5f7f4f146a91ba8ec7f1df8e9d7f9d2d7c74fd;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/curs_overlay.3x.html b/doc/html/man/curs_overlay.3x.html index 64b4f71e..7c606403 100644 --- a/doc/html/man/curs_overlay.3x.html +++ b/doc/html/man/curs_overlay.3x.html @@ -1,7 +1,6 @@ - +
+ +- +curs_overlay(3x) curs_overlay(3x) + + +-
- overlay, overwrite, copywin - overlay and manipulate over- - lapped curses windows +NAME
+ overlay, overwrite, copywin - overlay and manipulate + overlapped curses windows-SYNOPSIS
+SYNOPSIS
#include <curses.h> int overlay(const WINDOW *srcwin, WINDOW *dstwin); @@ -60,36 +64,41 @@-DESCRIPTION
+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. + (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 + The copywin routine provides a finer granularity of con- + trol over the overlay and overwrite routines. As 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- + 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.-RETURN VALUE
- Routines that return an integer return ERR upon failure, - and OK (SVr4 only specifies "an integer value other than +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. + 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
+NOTES
Note that overlay and overwrite may be macros.-PORTABILITY
+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 multibyte ren- @@ -97,22 +106,23 @@-SEE ALSO
+SEE ALSO
curses(3x), curs_pad(3x), curs_refresh(3x) - - - - - - + curs_overlay(3x)-
- -Man(1) output converted with -man2html - +