X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_overlay.3x.html;h=f87fc8848530664ac081c0b62032d14df4f792a5;hb=b3719ca8b52aa07d0d85f7c1ce645a471397ccfe;hp=64b4f71e61d656dc0807cb44ec044414bf46f8df;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01;p=ncurses.git diff --git a/doc/html/man/curs_overlay.3x.html b/doc/html/man/curs_overlay.3x.html index 64b4f71e..f87fc884 100644 --- a/doc/html/man/curs_overlay.3x.html +++ b/doc/html/man/curs_overlay.3x.html @@ -1,7 +1,7 @@ - - +
+ +- +curs_overlay(3x) curs_overlay(3x) --
- overlay, overwrite, copywin - overlay and manipulate over- - lapped curses windows --
- #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); +
+ overlay, overwrite, copywin - overlay and manipulate overlapped curses + windows --
- 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. +
+ #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); --
- Routines that return an integer return ERR upon failure, - and OK (SVr4 only specifies "an integer value other than - ERR") upon successful completion. +
--
- Note that overlay and overwrite may be macros. +
+ 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 destruc- + tive. --
- 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- - ditions (not yet supported in this implementation). +
+ The copywin routine provides a finer granularity of control over the + overlay and overwrite routines. As in the prefresh routine, a rectan- + gle 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. --
- curses(3x), curs_pad(3x), curs_refresh(3x) +
+ Routines that return an integer return ERR upon failure, and OK (SVr4 + only specifies "an integer value other than ERR") upon successful com- + pletion. + 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. +
+ Note that overlay and overwrite may be macros. + +
+ 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 renditions (not yet supported in this im- + plementation). +
+ curses(3x), curs_pad(3x), curs_refresh(3x) + curs_overlay(3x)-