X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_overlay.3x.html;h=c10da1aa41664cab09be9348422f00181dbd19db;hb=a0b91dc27f0c411e343161b0a4b5459d15a43f85;hp=f6f6b8f5bc261b3266c530e547b28d8f29b58bc4;hpb=a8987e73ec254703634802b4f7ee30d3a485524d;p=ncurses.git diff --git a/doc/html/man/curs_overlay.3x.html b/doc/html/man/curs_overlay.3x.html index f6f6b8f5..c10da1aa 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) +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); - 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); + 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
+DESCRIPTION
+ ++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. + (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 ++copywin
+ 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- @@ -101,17 +112,28 @@-SEE ALSO
+SEE ALSO
curses(3x), curs_pad(3x), curs_refresh(3x) - curs_overlay(3x) + curs_overlay(3x)-
- -Man(1) output converted with -man2html - +