2 ****************************************************************************
3 * Copyright 2020 Thomas E. Dickey *
4 * Copyright 1998-2013,2015 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: curs_overlay.3x,v 1.19 2020/02/02 23:34:34 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_overlay 3X</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">curs_overlay 3X</H1>
44 <B><A HREF="curs_overlay.3X.html">curs_overlay(3X)</A></B> <B><A HREF="curs_overlay.3X.html">curs_overlay(3X)</A></B>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <B>overlay</B>, <B>overwrite</B>, <B>copywin</B> - overlay and manipulate overlapped <B>curses</B>
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <B>#include</B> <B><curses.h></B>
57 <B>int</B> <B>overlay(const</B> <B>WINDOW</B> <B>*</B><I>srcwin</I><B>,</B> <B>WINDOW</B> <B>*</B><I>dstwin</I><B>);</B>
58 <B>int</B> <B>overwrite(const</B> <B>WINDOW</B> <B>*</B><I>srcwin</I><B>,</B> <B>WINDOW</B> <B>*</B><I>dstwin</I><B>);</B>
59 <B>int</B> <B>copywin(const</B> <B>WINDOW</B> <B>*</B><I>srcwin</I><B>,</B> <B>WINDOW</B> <B>*</B><I>dstwin</I><B>,</B> <B>int</B> <I>sminrow</I><B>,</B>
60 <B>int</B> <I>smincol</I><B>,</B> <B>int</B> <I>dminrow</I><B>,</B> <B>int</B> <I>dmincol</I><B>,</B> <B>int</B> <I>dmaxrow</I><B>,</B>
61 <B>int</B> <I>dmaxcol</I><B>,</B> <B>int</B> <I>overlay</I><B>);</B>
64 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
66 </PRE><H3><a name="h3-overlay_-overwrite">overlay, overwrite</a></H3><PRE>
67 The <B>overlay</B> and <B>overwrite</B> routines overlay <I>srcwin</I> on top of <I>dstwin</I>.
68 <I>scrwin</I> and <I>dstwin</I> are not required to be the same size; only text where
69 the two windows overlap is copied. The difference is that <B>overlay</B> is
70 non-destructive (blanks are not copied) whereas <B>overwrite</B> is destruc-
74 </PRE><H3><a name="h3-copywin">copywin</a></H3><PRE>
75 The <B>copywin</B> routine provides a finer granularity of control over the
76 <B>overlay</B> and <B>overwrite</B> routines. As in the <B>prefresh</B> routine, a rectan-
77 gle is specified in the destination window, (<I>dminrow</I>, <I>dmincol</I>) and
78 (<I>dmaxrow</I>, <I>dmaxcol</I>), and the upper-left-corner coordinates of the source
79 window, (<I>sminrow</I>, <I>smincol</I>). If the argument <I>overlay</I> is <B>true</B>, then
80 copying is non-destructive, as in <B>overlay</B>.
83 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
84 Routines that return an integer return <B>ERR</B> upon failure, and <B>OK</B> (SVr4
85 only specifies "an integer value other than <B>ERR</B>") upon successful com-
88 X/Open defines no error conditions. In this implementation, <B>copywin</B>,
89 <B>overlay</B> and <B>overwrite</B> return an error if either of the window pointers
90 are null, or if some part of the window would be placed off-screen.
93 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
94 Note that <B>overlay</B> and <B>overwrite</B> may be macros.
97 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
98 The XSI Curses standard, Issue 4 describes these functions (adding the
99 const qualifiers). It further specifies their behavior in the presence
100 of characters with multibyte renditions (not yet supported in this im-
104 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
105 <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_pad.3X.html">curs_pad(3X)</A></B>, <B><A HREF="curs_refresh.3X.html">curs_refresh(3X)</A></B>
109 <B><A HREF="curs_overlay.3X.html">curs_overlay(3X)</A></B>
113 <li><a href="#h2-NAME">NAME</a></li>
114 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
115 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
117 <li><a href="#h3-overlay_-overwrite">overlay, overwrite</a></li>
118 <li><a href="#h3-copywin">copywin</a></li>
121 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
122 <li><a href="#h2-NOTES">NOTES</a></li>
123 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
124 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>