1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> 2<!-- 3 **************************************************************************** 4 * Copyright (c) 1998-2005,2006 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.14 2006/02/25 21:49:19 tom Exp @ 31--> 32<HTML> 33<HEAD> 34<TITLE>curs_overlay 3x</TITLE> 35<link rev=made href="mailto:bug-ncurses@gnu.org"> 36<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> 37</HEAD> 38<BODY> 39<H1>curs_overlay 3x</H1> 40<HR> 41<PRE> 42<!-- Manpage converted by man2html 3.0.1 --> 43<STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> 44 45 46 47 48</PRE> 49<H2>NAME</H2><PRE> 50 <STRONG>overlay</STRONG>, <STRONG>overwrite</STRONG>, <STRONG>copywin</STRONG> - overlay and manipulate 51 overlapped <STRONG>curses</STRONG> windows 52 53 54</PRE> 55<H2>SYNOPSIS</H2><PRE> 56 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> 57 58 <STRONG>int</STRONG> <STRONG>overlay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin);</STRONG> 59 <STRONG>int</STRONG> <STRONG>overwrite(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin);</STRONG> 60 <STRONG>int</STRONG> <STRONG>copywin(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin,</STRONG> <STRONG>int</STRONG> 61 <STRONG>sminrow,</STRONG> 62 <STRONG>int</STRONG> <STRONG>smincol,</STRONG> <STRONG>int</STRONG> <STRONG>dminrow,</STRONG> <STRONG>int</STRONG> <STRONG>dmincol,</STRONG> <STRONG>int</STRONG> <STRONG>dmaxrow,</STRONG> 63 <STRONG>int</STRONG> <STRONG>dmaxcol,</STRONG> <STRONG>int</STRONG> <STRONG>overlay);</STRONG> 64 65 66</PRE> 67<H2>DESCRIPTION</H2><PRE> 68 The <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines overlay <EM>srcwin</EM> on top 69 of <EM>dstwin</EM>. <EM>scrwin</EM> and <EM>dstwin</EM> are not required to be the 70 same size; only text where the two windows overlap is 71 copied. The difference is that <STRONG>overlay</STRONG> is non-destructive 72 (blanks are not copied) whereas <STRONG>overwrite</STRONG> is destructive. 73 74 The <STRONG>copywin</STRONG> routine provides a finer granularity of con- 75 trol over the <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines. Like in the 76 <STRONG>prefresh</STRONG> routine, a rectangle is specified in the destina- 77 tion window, (<EM>dminrow</EM>, <EM>dmincol</EM>) and (<EM>dmaxrow</EM>, <EM>dmaxcol</EM>), 78 and the upper-left-corner coordinates of the source win- 79 dow, (<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> 84<H2>RETURN VALUE</H2><PRE> 85 Routines that return an integer return <STRONG>ERR</STRONG> upon failure, 86 and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than 87 <STRONG>ERR</STRONG>") upon successful completion. 88 89 X/Open defines no error conditions. In this implementa- 90 tion, <STRONG>copywin</STRONG>, <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> return an error if 91 either of the window pointers are null, or if some part of 92 the window would be placed off-screen. 93 94 95</PRE> 96<H2>NOTES</H2><PRE> 97 Note that <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> may be macros. 98 99 100</PRE> 101<H2>PORTABILITY</H2><PRE> 102 The XSI Curses standard, Issue 4 describes these functions 103 (adding the const qualifiers). It further specifies their 104 behavior in the presence of characters with multibyte ren- 105 ditions (not yet supported in this implementation). 106 107 108</PRE> 109<H2>SEE ALSO</H2><PRE> 110 <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> 111 112 113 114 <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> 115</PRE> 116<HR> 117<ADDRESS> 118Man(1) output converted with 119<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> 120</ADDRESS> 121</BODY> 122</HTML> 123