Ada95/html/curs_overlay.3x.html

   1 <HTML>
   2 <BODY BGCOLOR="#99ccbb" TEXT="#000000" LINK="#4060b0" VLINK="#000080" ALINK="#ff4040">
   3 <PRE>
   4        <STRONG>overlay</STRONG>, <STRONG>overwrite</STRONG>, <STRONG>copywin</STRONG> - overlay and manipulate over-
   5        lapped <STRONG>curses</STRONG> windows
   6
   7
   8 </PRE>
   9 <H2>SYNOPSIS</H2><PRE>
  10        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  11
  12        <STRONG>int</STRONG> <STRONG>overlay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin);</STRONG>
  13        <STRONG>int</STRONG> <STRONG>overwrite(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin);</STRONG>
  14        <STRONG>int</STRONG> <STRONG>copywin(WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin,</STRONG> <STRONG>int</STRONG> <STRONG>sminrow,</STRONG>
  15              <STRONG>int</STRONG> <STRONG>smincol,</STRONG> <STRONG>int</STRONG> <STRONG>dminrow,</STRONG> <STRONG>int</STRONG> <STRONG>dmincol,</STRONG> <STRONG>int</STRONG> <STRONG>dmaxrow,</STRONG>
  16              <STRONG>int</STRONG> <STRONG>dmaxcol,</STRONG> <STRONG>int</STRONG> <STRONG>overlay);</STRONG>
  17
  18
  19 </PRE>
  20 <H2>DESCRIPTION</H2><PRE>
  21        The <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines overlay <EM>srcwin</EM>  on  top
  22        of  <EM>dstwin</EM>.   <EM>scrwin</EM> and <EM>dstwin</EM> are not required to be the
  23        same size; only text where  the  two  windows  overlap  is
  24        copied.  The difference is that <STRONG>overlay</STRONG> is non-destructive
  25        (blanks are not copied) whereas <STRONG>overwrite</STRONG> is  destructive.
  26
  27        The  <STRONG>copywin</STRONG>  routine provides a finer granularity of con-
  28        trol over the <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines.  Like in the
  29        <STRONG>prefresh</STRONG> routine, a rectangle is specified in the destina-
  30        tion window, (<EM>dminrow</EM>, <EM>dmincol</EM>)  and  (<EM>dmaxrow</EM>,  <EM>dmaxcol</EM>),
  31        and  the  upper-left-corner coordinates of the source win-
  32        dow, (<EM>sminrow</EM>, <EM>smincol</EM>).  If the argument <EM>overlay</EM> is <STRONG>true</STRONG>,
  33        then copying is non-destructive, as in <STRONG>overlay</STRONG>.
  34
  35
  36 </PRE>
  37 <H2>RETURN VALUE</H2><PRE>
  38        Routines  that  return an integer return <STRONG>ERR</STRONG> upon failure,
  39        and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value  other  than
  40        <STRONG>ERR</STRONG>") upon successful completion.
  41
  42
  43 </PRE>
  44 <H2>NOTES</H2><PRE>
  45        Note that <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> may be macros.
  46
  47
  48 </PRE>
  49 <H2>PORTABILITY</H2><PRE>
  50        The XSI Curses standard, Issue 4 describes these functions
  51        (adding the const qualifiers).  It further specifies their
  52        behavior  in  the  presence  of characters with multi-byte
  53        renditions (not yet supported in this implementation).
  54
  55
  56 </PRE>
  57 <H2>SEE ALSO</H2><PRE>
  58        <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>
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68 </PRE>
  69 </BODY>
  70 </HTML>