64b4f71e61d656dc0807cb44ec044414bf46f8df
[ncurses.git] / doc / html / man / curs_overlay.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998,2000,2001 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.11 2002/07/20 14:53:00 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
44 </PRE>
45 <H2>NAME</H2><PRE>
46        <STRONG>overlay</STRONG>, <STRONG>overwrite</STRONG>, <STRONG>copywin</STRONG> - overlay and manipulate over-
47        lapped <STRONG>curses</STRONG> windows
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
53
54        <STRONG>int</STRONG> <STRONG>overlay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin);</STRONG>
55        <STRONG>int</STRONG> <STRONG>overwrite(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin);</STRONG>
56        <STRONG>int</STRONG> <STRONG>copywin(const</STRONG>  <STRONG>WINDOW</STRONG>  <STRONG>*srcwin,</STRONG>  <STRONG>WINDOW</STRONG>  <STRONG>*dstwin,</STRONG>  <STRONG>int</STRONG>
57        <STRONG>sminrow,</STRONG>
58              <STRONG>int</STRONG> <STRONG>smincol,</STRONG> <STRONG>int</STRONG> <STRONG>dminrow,</STRONG> <STRONG>int</STRONG> <STRONG>dmincol,</STRONG> <STRONG>int</STRONG> <STRONG>dmaxrow,</STRONG>
59              <STRONG>int</STRONG> <STRONG>dmaxcol,</STRONG> <STRONG>int</STRONG> <STRONG>overlay);</STRONG>
60
61
62 </PRE>
63 <H2>DESCRIPTION</H2><PRE>
64        The  <STRONG>overlay</STRONG>  and <STRONG>overwrite</STRONG> routines overlay <EM>srcwin</EM> on top
65        of <EM>dstwin</EM>.  <EM>scrwin</EM> and <EM>dstwin</EM> are not required to  be  the
66        same  size;  only  text  where  the two windows overlap is
67        copied.  The difference is that <STRONG>overlay</STRONG> is non-destructive
68        (blanks  are not copied) whereas <STRONG>overwrite</STRONG> is destructive.
69
70        The <STRONG>copywin</STRONG> routine provides a finer granularity  of  con-
71        trol over the <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines.  Like in the
72        <STRONG>prefresh</STRONG> routine, a rectangle is specified in the destina-
73        tion  window,  (<EM>dminrow</EM>,  <EM>dmincol</EM>) and (<EM>dmaxrow</EM>, <EM>dmaxcol</EM>),
74        and the upper-left-corner coordinates of the  source  win-
75        dow, (<EM>sminrow</EM>, <EM>smincol</EM>).  If the argument <EM>overlay</EM> is <STRONG>true</STRONG>,
76        then copying is non-destructive, as in <STRONG>overlay</STRONG>.
77
78
79 </PRE>
80 <H2>RETURN VALUE</H2><PRE>
81        Routines that return an integer return <STRONG>ERR</STRONG>  upon  failure,
82        and  <STRONG>OK</STRONG>  (SVr4 only specifies "an integer value other than
83        <STRONG>ERR</STRONG>") upon successful completion.
84
85
86 </PRE>
87 <H2>NOTES</H2><PRE>
88        Note that <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> may be macros.
89
90
91 </PRE>
92 <H2>PORTABILITY</H2><PRE>
93        The XSI Curses standard, Issue 4 describes these functions
94        (adding the const qualifiers).  It further specifies their
95        behavior in the presence of characters with multibyte ren-
96        ditions (not yet supported in this implementation).
97
98
99 </PRE>
100 <H2>SEE ALSO</H2><PRE>
101        <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>
102
103
104
105
106
107
108
109
110
111 </PRE>
112 <HR>
113 <ADDRESS>
114 Man(1) output converted with
115 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
116 </ADDRESS>
117 </BODY>
118 </HTML>