ncurses 5.1
[ncurses.git] / doc / html / man / curs_overlay.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5
6 </PRE>
7 <H2>NAME</H2><PRE>
8        <B>overlay</B>, <B>overwrite</B>, <B>copywin</B> - overlay and manipulate over-
9        lapped <B>curses</B> windows
10
11
12 </PRE>
13 <H2>SYNOPSIS</H2><PRE>
14        <B>#include</B> <B>&lt;curses.h&gt;</B>
15
16        <B>int</B> <B>overlay(const</B> <B>WINDOW</B> <B>*srcwin,</B> <B>WINDOW</B> <B>*dstwin);</B>
17        <B>int</B> <B>overwrite(const</B> <B>WINDOW</B> <B>*srcwin,</B> <B>WINDOW</B> <B>*dstwin);</B>
18        <B>int</B> <B>copywin(WINDOW</B> <B>*srcwin,</B> <B>WINDOW</B> <B>*dstwin,</B> <B>int</B> <B>sminrow,</B>
19              <B>int</B> <B>smincol,</B> <B>int</B> <B>dminrow,</B> <B>int</B> <B>dmincol,</B> <B>int</B> <B>dmaxrow,</B>
20              <B>int</B> <B>dmaxcol,</B> <B>int</B> <B>overlay);</B>
21
22
23 </PRE>
24 <H2>DESCRIPTION</H2><PRE>
25        The <B>overlay</B> and <B>overwrite</B> routines overlay <I>srcwin</I>  on  top
26        of  <I>dstwin</I>.   <I>scrwin</I> and <I>dstwin</I> are not required to be the
27        same size; only text where  the  two  windows  overlap  is
28        copied.  The difference is that <B>overlay</B> is non-destructive
29        (blanks are not copied) whereas <B>overwrite</B> is  destructive.
30
31        The  <B>copywin</B>  routine provides a finer granularity of con-
32        trol over the <B>overlay</B> and <B>overwrite</B> routines.  Like in the
33        <B>prefresh</B> routine, a rectangle is specified in the destina-
34        tion window, (<I>dminrow</I>, <I>dmincol</I>)  and  (<I>dmaxrow</I>,  <I>dmaxcol</I>),
35        and  the  upper-left-corner coordinates of the source win-
36        dow, (<I>sminrow</I>, <I>smincol</I>).  If the argument <I>overlay</I> is <B>true</B>,
37        then copying is non-destructive, as in <B>overlay</B>.
38
39
40 </PRE>
41 <H2>RETURN VALUE</H2><PRE>
42        Routines  that  return an integer return <B>ERR</B> upon failure,
43        and <B>OK</B> (SVr4 only specifies "an integer value  other  than
44        <B>ERR</B>") upon successful completion.
45
46
47 </PRE>
48 <H2>NOTES</H2><PRE>
49        Note that <B>overlay</B> and <B>overwrite</B> may be macros.
50
51
52 </PRE>
53 <H2>PORTABILITY</H2><PRE>
54        The XSI Curses standard, Issue 4 describes these functions
55        (adding the const qualifiers).  It further specifies their
56        behavior  in  the  presence  of characters with multi-byte
57        renditions (not yet supported in this implementation).
58
59
60 </PRE>
61 <H2>SEE ALSO</H2><PRE>
62        <B><A HREF="ncurses.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>
63
64
65
66
67
68
69
70
71
72
73 </PRE>
74 <HR>
75 <ADDRESS>
76 Man(1) output converted with
77 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
78 </ADDRESS>
79 </BODY>
80 </HTML>