1<!-- 2 **************************************************************************** 3 * Copyright 2020-2023,2024 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.43 2024/04/20 21:20:07 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 2024-04-20 ncurses 6.5 Library calls</TITLE> 38<link rel="author" href="mailto:bug-ncurses@gnu.org"> 39 40</HEAD> 41<BODY> 42<H1 class="no-header">curs_overlay 3x 2024-04-20 ncurses 6.5 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 48 49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> 50 <STRONG>overlay</STRONG>, <STRONG>overwrite</STRONG>, <STRONG>copywin</STRONG> - overlay <EM>curses</EM> windows and manipulate 51 them 52 53 54</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> 55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> 56 57 <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> 58 <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> 59 <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> 60 <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> 61 <STRONG>int</STRONG> <EM>dmaxcol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>overlay</EM><STRONG>);</STRONG> 62 63 64</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> 65 66</PRE><H3><a name="h3-overlay_overwrite">overlay, overwrite</a></H3><PRE> 67 The <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines overlay <EM>srcwin</EM> on top of <EM>dstwin</EM>. 68 <EM>scrwin</EM> and <EM>dstwin</EM> are not required to be the same size; only text where 69 the two windows overlap is copied. The difference is that <STRONG>overlay</STRONG> is 70 non-destructive (blanks are not copied) whereas <STRONG>overwrite</STRONG> is 71 destructive. 72 73 74</PRE><H3><a name="h3-copywin">copywin</a></H3><PRE> 75 The <STRONG>copywin</STRONG> routine provides a finer granularity of control over the 76 <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines. As in the <STRONG>prefresh</STRONG> routine, a 77 rectangle is specified in the destination window, (<EM>dminrow</EM>, <EM>dmincol</EM>) 78 and (<EM>dmaxrow</EM>, <EM>dmaxcol</EM>), and the upper-left-corner coordinates of the 79 source window, (<EM>sminrow</EM>, <EM>smincol</EM>). If the argument <EM>overlay</EM> is <STRONG>true</STRONG>, 80 then copying is non-destructive, as in <STRONG>overlay</STRONG>. 81 82 83</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 84 These routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG> (SVr4 85 specifies only "an integer value other than <STRONG>ERR</STRONG>") upon successful 86 completion. 87 88 X/Open defines no error conditions. In this implementation, <STRONG>copywin</STRONG>, 89 <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> return an error if either of the window pointers 90 are null, or if some part of the window would be placed off-screen. 91 92 93</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> 94 Note that <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> may be macros. 95 96 97</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 98 These functions are described in X/Open Curses, Issue 4, which adds 99 <EM>const</EM> qualifiers to the arguments. It further specifies their behavior 100 in the presence of characters with multibyte renditions (not yet 101 supported in this implementation). 102 103 104</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 105 <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> 106 107 108 109ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> 110</PRE> 111<div class="nav"> 112<ul> 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> 116<ul> 117<li><a href="#h3-overlay_overwrite">overlay, overwrite</a></li> 118<li><a href="#h3-copywin">copywin</a></li> 119</ul> 120</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> 125</ul> 126</div> 127</BODY> 128</HTML> 129