***************************************************************************
Copyright 2020-2023,2024 Thomas E. Dickey *
Copyright 1998-2013,2015 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************
$Id: curs_overlay.3x,v 1.43 2024/04/20 21:20:07 tom Exp $
Copyright 2020-2023,2024 Thomas E. Dickey *
Copyright 1998-2013,2015 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************
$Id: curs_overlay.3x,v 1.43 2024/04/20 21:20:07 tom Exp $
curs_overlay 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
.\}
.\}
.
NAME
\%overlay,
\%overwrite,
\%copywin -
overlay curses windows and manipulate them
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);
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.
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.
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 X/Open Curses, 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)