doc/html/man/curs_overlay.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright (c) 1998-2010,2013 Free Software Foundation, Inc.              *
   4   *                                                                          *
   5   * Permission is hereby granted, free of charge, to any person obtaining a  *
   6   * copy of this software and associated documentation files (the            *
   7   * "Software"), to deal in the Software without restriction, including      *
   8   * without limitation the rights to use, copy, modify, merge, publish,      *
   9   * distribute, distribute with modifications, sublicense, and/or sell       *
  10   * copies of the Software, and to permit persons to whom the Software is    *
  11   * furnished to do so, subject to the following conditions:                 *
  12   *                                                                          *
  13   * The above copyright notice and this permission notice shall be included  *
  14   * in all copies or substantial portions of the Software.                   *
  15   *                                                                          *
  16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23   *                                                                          *
  24   * Except as contained in this notice, the name(s) of the above copyright   *
  25   * holders shall not be used in advertising or otherwise to promote the     *
  26   * sale, use or other dealings in this Software without prior written       *
  27   * authorization.                                                           *
  28   ****************************************************************************
  29   * @Id: curs_overlay.3x,v 1.17 2013/04/06 23:48:51 tom Exp @
  30 -->
  31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  32 <HTML>
  33 <HEAD>
  34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
  36 <TITLE>curs_overlay 3x</TITLE>
  37 <link rev=made href="mailto:bug-ncurses@gnu.org">
  38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  39 </HEAD>
  40 <BODY>
  41 <H1>curs_overlay 3x</H1>
  42 <HR>
  43 <PRE>
  44 <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG>                                       <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE>
  50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>overlay</STRONG>, <STRONG>overwrite</STRONG>, <STRONG>copywin</STRONG> - overlay and manipulate
  52        overlapped <STRONG>curses</STRONG> windows
  53
  54
  55 </PRE>
  56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  57        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  58
  59        <STRONG>int</STRONG> <STRONG>overlay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>overwrite(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin);</STRONG>
  61        <STRONG>int</STRONG> <STRONG>copywin(const</STRONG>  <STRONG>WINDOW</STRONG>  <STRONG>*srcwin,</STRONG>  <STRONG>WINDOW</STRONG>  <STRONG>*dstwin,</STRONG>  <STRONG>int</STRONG>
  62        <STRONG>sminrow,</STRONG>
  63              <STRONG>int</STRONG> <STRONG>smincol,</STRONG> <STRONG>int</STRONG> <STRONG>dminrow,</STRONG> <STRONG>int</STRONG> <STRONG>dmincol,</STRONG> <STRONG>int</STRONG> <STRONG>dmaxrow,</STRONG>
  64              <STRONG>int</STRONG> <STRONG>dmaxcol,</STRONG> <STRONG>int</STRONG> <STRONG>overlay);</STRONG>
  65
  66
  67 </PRE>
  68 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  69        The  <STRONG>overlay</STRONG>  and <STRONG>overwrite</STRONG> routines overlay <EM>srcwin</EM> on top
  70        of <EM>dstwin</EM>.  <EM>scrwin</EM> and <EM>dstwin</EM> are not required to  be  the
  71        same  size;  only  text  where  the two windows overlap is
  72        copied.  The difference is that <STRONG>overlay</STRONG> is non-destructive
  73        (blanks are not copied) whereas <STRONG>overwrite</STRONG> is destructive.
  74
  75        The  <STRONG>copywin</STRONG>  routine provides a finer granularity of con-
  76        trol over the <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines.  As  in  the
  77        <STRONG>prefresh</STRONG> routine, a rectangle is specified in the destina-
  78        tion window, (<EM>dminrow</EM>, <EM>dmincol</EM>)  and  (<EM>dmaxrow</EM>,  <EM>dmaxcol</EM>),
  79        and  the  upper-left-corner coordinates of the source win-
  80        dow, (<EM>sminrow</EM>, <EM>smincol</EM>).  If the argument <EM>overlay</EM> is <STRONG>true</STRONG>,
  81        then copying is non-destructive, as in <STRONG>overlay</STRONG>.
  82
  83
  84 </PRE>
  85 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  86        Routines  that  return an integer return <STRONG>ERR</STRONG> upon failure,
  87        and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value  other  than
  88        <STRONG>ERR</STRONG>") upon successful completion.
  89
  90        X/Open  defines  no error conditions.  In this implementa-
  91        tion, <STRONG>copywin</STRONG>, <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> return  an  error  if
  92        either of the window pointers are null, or if some part of
  93        the window would be placed off-screen.
  94
  95
  96 </PRE>
  97 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  98        Note that <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> may be macros.
  99
 100
 101 </PRE>
 102 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 103        The XSI Curses standard, Issue 4 describes these functions
 104        (adding the const qualifiers).  It further specifies their
 105        behavior in the presence of characters with multibyte ren-
 106        ditions (not yet supported in this implementation).
 107
 108
 109 </PRE>
 110 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 111        <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>
 112
 113
 114
 115                                                        <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG>
 116 </PRE>
 117 <div class="nav">
 118 <ul>
 119 <li><a href="#h2-NAME">NAME</a></li>
 120 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 121 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 122 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 123 <li><a href="#h2-NOTES">NOTES</a></li>
 124 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 125 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 126 </ul>
 127 </div>
 128 </BODY>
 129 </HTML>