Debian Codegraph @

doc/html/man/curs_overlay.3x.html

raw
1 <!--
2 ****************************************************************************
3 * Copyright 2020-2024,2025 Thomas E. Dickey *
4 * Copyright 1998-2013,2015 Free Software Foundation, Inc. *
5 * *
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: *
13 * *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
16 * *
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. *
24 * *
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 *
28 * authorization. *
29 ****************************************************************************
30 * @Id: curs_overlay.3x,v 1.55 2025/01/19 00:51:10 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
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 2025-01-18 ncurses 6.6 Library calls</TITLE>
38 <link rel="author" href="mailto:[email protected]">
39
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_overlay 3x 2025-01-18 ncurses 6.6 Library calls</H1>
43 <PRE>
44 <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG>
45
46
47 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
48 <STRONG>overlay</STRONG>, <STRONG>overwrite</STRONG>, <STRONG>copywin</STRONG> - overlay <EM>curses</EM> windows and manipulate
49 them
50
51
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
54
55 <STRONG>int</STRONG> <STRONG>overlay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>srcwin</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>dstwin</EM><STRONG>);</STRONG>
56 <STRONG>int</STRONG> <STRONG>overwrite(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>srcwin</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>dstwin</EM><STRONG>);</STRONG>
57 <STRONG>int</STRONG> <STRONG>copywin(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>srcwin</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>dstwin</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>sminrow</EM><STRONG>,</STRONG>
58 <STRONG>int</STRONG> <EM>smincol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>dminrow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>dmincol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>dmaxrow</EM><STRONG>,</STRONG>
59 <STRONG>int</STRONG> <EM>dmaxcol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>overlay</EM><STRONG>);</STRONG>
60
61
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63
64 </PRE><H3><a name="h3-overlay_overwrite">overlay, overwrite</a></H3><PRE>
65 The <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines overlay <EM>srcwin</EM> on top of <EM>dstwin</EM>.
66 <EM>scrwin</EM> and <EM>dstwin</EM> are not required to be the same size; only text where
67 the two windows overlap is copied. The difference is that <STRONG>overlay</STRONG> is
68 non-destructive (blanks are not copied) whereas <STRONG>overwrite</STRONG> is
69 destructive.
70
71
72 </PRE><H3><a name="h3-copywin">copywin</a></H3><PRE>
73 The <STRONG>copywin</STRONG> routine provides a finer granularity of control over the
74 <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines. As in the <STRONG>prefresh</STRONG> routine, a
75 rectangle is specified in the destination window, (<EM>dminrow</EM>, <EM>dmincol</EM>)
76 and (<EM>dmaxrow</EM>, <EM>dmaxcol</EM>), and the upper-left-corner coordinates of the
77 source window, (<EM>sminrow</EM>, <EM>smincol</EM>). If the argument <EM>overlay</EM> is <STRONG>true</STRONG>,
78 then copying is non-destructive, as in <STRONG>overlay</STRONG>.
79
80
81 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
82 These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure.
83
84 In <EM>ncurses</EM>, they return <STRONG>ERR</STRONG> if
85
86 <STRONG>o</STRONG> either of the window pointers are null, or
87
88 <STRONG>o</STRONG> any part of the window would be placed off-screen.
89
90
91 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
92 <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> may be implemented as macros.
93
94
95 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
96 X/Open Curses Issue 4 describes these functions. It specifies no error
97 conditions for them. It adds <EM>const</EM> qualifiers to the arguments. It
98 further specifies their behavior in the presence of characters with
99 multibyte renditions (not yet supported in this implementation).
100
101 SVr4 describes a successful return value only as "an integer value
102 other than <EM>ERR</EM>".
103
104
105 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
106 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
107
108 ncurses 6.6 2025-01-18 <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG>
109 </PRE>
110 <div class="nav">
111 <ul>
112 <li><a href="#h2-NAME">NAME</a></li>
113 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
114 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
115 <ul>
116 <li><a href="#h3-overlay_overwrite">overlay, overwrite</a></li>
117 <li><a href="#h3-copywin">copywin</a></li>
118 </ul>
119 </li>
120 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
121 <li><a href="#h2-NOTES">NOTES</a></li>
122 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
123 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
124 </ul>
125 </div>
126 </BODY>
127 </HTML>