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

   1 <!--
   2   ****************************************************************************
   3   * Copyright (c) 1998-2013,2015 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.18 2015/07/21 00:51:31 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 https://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 class="no-header">curs_overlay 3x</H1>
  42 <PRE>
  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><H2><a name="h2-NAME">NAME</a></H2><PRE>
  49        <STRONG>overlay</STRONG>, <STRONG>overwrite</STRONG>, <STRONG>copywin</STRONG> - overlay and manipulate overlapped <STRONG>curses</STRONG>
  50        windows
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  55
  56        <STRONG>int</STRONG> <STRONG>overlay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>srcwin</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>dstwin</EM><STRONG>);</STRONG>
  57        <STRONG>int</STRONG> <STRONG>overwrite(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>srcwin</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>dstwin</EM><STRONG>);</STRONG>
  58        <STRONG>int</STRONG> <STRONG>copywin(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>srcwin</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>dstwin</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>sminrow</EM><STRONG>,</STRONG>
  59              <STRONG>int</STRONG> <EM>smincol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>dminrow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>dmincol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>dmaxrow</EM><STRONG>,</STRONG>
  60              <STRONG>int</STRONG> <EM>dmaxcol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>overlay</EM><STRONG>);</STRONG>
  61
  62
  63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  64
  65 </PRE><H3><a name="h3-overlay_-overwrite">overlay, overwrite</a></H3><PRE>
  66        The <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines overlay <EM>srcwin</EM>  on  top  of  <EM>dstwin</EM>.
  67        <EM>scrwin</EM> and <EM>dstwin</EM> are not required to be the same size; only text where
  68        the two windows overlap is copied.  The difference is that  <STRONG>overlay</STRONG>  is
  69        non-destructive  (blanks  are not copied) whereas <STRONG>overwrite</STRONG> is destruc-
  70        tive.
  71
  72
  73 </PRE><H3><a name="h3-copywin">copywin</a></H3><PRE>
  74        The <STRONG>copywin</STRONG> routine provides a finer granularity of  control  over  the
  75        <STRONG>overlay</STRONG>  and <STRONG>overwrite</STRONG> routines.  As in the <STRONG>prefresh</STRONG> routine, a rectan-
  76        gle is specified in the  destination  window,  (<EM>dminrow</EM>,  <EM>dmincol</EM>)  and
  77        (<EM>dmaxrow</EM>, <EM>dmaxcol</EM>), and the upper-left-corner coordinates of the source
  78        window, (<EM>sminrow</EM>, <EM>smincol</EM>).  If the  argument  <EM>overlay</EM>  is  <STRONG>true</STRONG>,  then
  79        copying is non-destructive, as in <STRONG>overlay</STRONG>.
  80
  81
  82 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  83        Routines  that  return an integer return <STRONG>ERR</STRONG> upon failure, and <STRONG>OK</STRONG> (SVr4
  84        only specifies "an integer value other than <STRONG>ERR</STRONG>") upon successful  com-
  85        pletion.
  86
  87        X/Open  defines  no error conditions.  In this implementation, <STRONG>copywin</STRONG>,
  88        <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> return an error if either of the window  pointers
  89        are null, or if some part of the window would be placed off-screen.
  90
  91
  92 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  93        Note that <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> may be macros.
  94
  95
  96 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  97        The  XSI Curses standard, Issue 4 describes these functions (adding the
  98        const qualifiers).  It further specifies their behavior in the presence
  99        of  characters with multibyte renditions (not yet supported in this im-
 100        plementation).
 101
 102
 103 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 104        <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>
 105
 106
 107
 108                                                               <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG>
 109 </PRE>
 110 <div class="nav">
 111 <ul>
 112 <li><a href="#h2-NAME">NAME</a></li>
 113 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 114 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
 115 <ul>
 116 <li><a href="#h3-overlay_-overwrite">overlay, overwrite</a></li>
 117 <li><a href="#h3-copywin">copywin</a></li>
 118 </ul>
 119 </li>
 120 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 121 <li><a href="#h2-NOTES">NOTES</a></li>
 122 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 123 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 124 </ul>
 125 </div>
 126 </BODY>
 127 </HTML>