2002-10-13 11:35:53 +08:00
|
|
|
<!--
|
|
|
|
|
****************************************************************************
|
ncurses 6.0 - patch 20150725
+ updated llib-* files.
+ build-fixes for ncurses library "test_progs" rule.
+ use alternate workaround for gcc 5.x feature (adapted from patch by
Mikhail Peselnik).
+ add status line to tmux via xterm+sl (patch by Nicholas Marriott).
+ fixes for st 0.5 from testing with tack -TD
+ review/improve several manual pages to break up wall-of-text:
curs_add_wch.3x, curs_attr.3x, curs_bkgd.3x, curs_bkgrnd.3x,
curs_getcchar.3x, curs_getch.3x, curs_kernel.3x, curs_mouse.3x,
curs_outopts.3x, curs_overlay.3x, curs_pad.3x, curs_termattrs.3x
curs_trace.3x, and curs_window.3x
2015-07-26 08:58:34 +08:00
|
|
|
* Copyright (c) 1998-2013,2015 Free Software Foundation, Inc. *
|
2002-10-13 11:35:53 +08:00
|
|
|
* *
|
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a *
|
|
|
|
|
* copy of this software and associated documentation files (the *
|
|
|
|
|
* "Software"), to deal in the Software without restriction, including *
|
|
|
|
|
* without limitation the rights to use, copy, modify, merge, publish, *
|
|
|
|
|
* distribute, distribute with modifications, sublicense, and/or sell *
|
|
|
|
|
* copies of the Software, and to permit persons to whom the Software is *
|
|
|
|
|
* furnished to do so, subject to the following conditions: *
|
|
|
|
|
* *
|
|
|
|
|
* The above copyright notice and this permission notice shall be included *
|
|
|
|
|
* in all copies or substantial portions of the Software. *
|
|
|
|
|
* *
|
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
|
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
|
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
|
|
|
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
|
|
|
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
|
|
|
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
|
|
|
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
|
|
|
* *
|
|
|
|
|
* Except as contained in this notice, the name(s) of the above copyright *
|
|
|
|
|
* holders shall not be used in advertising or otherwise to promote the *
|
|
|
|
|
* sale, use or other dealings in this Software without prior written *
|
|
|
|
|
* authorization. *
|
|
|
|
|
****************************************************************************
|
ncurses 6.0 - patch 20150725
+ updated llib-* files.
+ build-fixes for ncurses library "test_progs" rule.
+ use alternate workaround for gcc 5.x feature (adapted from patch by
Mikhail Peselnik).
+ add status line to tmux via xterm+sl (patch by Nicholas Marriott).
+ fixes for st 0.5 from testing with tack -TD
+ review/improve several manual pages to break up wall-of-text:
curs_add_wch.3x, curs_attr.3x, curs_bkgd.3x, curs_bkgrnd.3x,
curs_getcchar.3x, curs_getch.3x, curs_kernel.3x, curs_mouse.3x,
curs_outopts.3x, curs_overlay.3x, curs_pad.3x, curs_termattrs.3x
curs_trace.3x, and curs_window.3x
2015-07-26 08:58:34 +08:00
|
|
|
* @Id: curs_overlay.3x,v 1.18 2015/07/21 00:51:31 tom Exp @
|
2002-10-13 11:35:53 +08:00
|
|
|
-->
|
2015-02-15 09:42:27 +08:00
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
|
2000-07-09 10:46:08 +08:00
|
|
|
<HTML>
|
2002-10-13 11:35:53 +08:00
|
|
|
<HEAD>
|
2015-02-15 09:42:27 +08:00
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
|
|
|
|
|
<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
|
2002-10-13 11:35:53 +08:00
|
|
|
<TITLE>curs_overlay 3x</TITLE>
|
|
|
|
|
<link rev=made href="mailto:bug-ncurses@gnu.org">
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
|
|
|
</HEAD>
|
2000-07-09 10:46:08 +08:00
|
|
|
<BODY>
|
2015-05-17 05:01:22 +08:00
|
|
|
<H1 class="no-header">curs_overlay 3x</H1>
|
2000-07-09 10:46:08 +08:00
|
|
|
<PRE>
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG>
|
2004-02-09 10:15:26 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG>overlay</STRONG>, <STRONG>overwrite</STRONG>, <STRONG>copywin</STRONG> - overlay and manipulate
|
|
|
|
|
overlapped <STRONG>curses</STRONG> windows
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
ncurses 6.0 - patch 20150725
+ updated llib-* files.
+ build-fixes for ncurses library "test_progs" rule.
+ use alternate workaround for gcc 5.x feature (adapted from patch by
Mikhail Peselnik).
+ add status line to tmux via xterm+sl (patch by Nicholas Marriott).
+ fixes for st 0.5 from testing with tack -TD
+ review/improve several manual pages to break up wall-of-text:
curs_add_wch.3x, curs_attr.3x, curs_bkgd.3x, curs_bkgrnd.3x,
curs_getcchar.3x, curs_getch.3x, curs_kernel.3x, curs_mouse.3x,
curs_outopts.3x, curs_overlay.3x, curs_pad.3x, curs_termattrs.3x
curs_trace.3x, and curs_window.3x
2015-07-26 08:58:34 +08:00
|
|
|
<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>
|
|
|
|
|
<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>
|
|
|
|
|
<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>
|
|
|
|
|
<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>
|
|
|
|
|
<STRONG>int</STRONG> <EM>dmaxcol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>overlay</EM><STRONG>);</STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
ncurses 6.0 - patch 20150725
+ updated llib-* files.
+ build-fixes for ncurses library "test_progs" rule.
+ use alternate workaround for gcc 5.x feature (adapted from patch by
Mikhail Peselnik).
+ add status line to tmux via xterm+sl (patch by Nicholas Marriott).
+ fixes for st 0.5 from testing with tack -TD
+ review/improve several manual pages to break up wall-of-text:
curs_add_wch.3x, curs_attr.3x, curs_bkgd.3x, curs_bkgrnd.3x,
curs_getcchar.3x, curs_getch.3x, curs_kernel.3x, curs_mouse.3x,
curs_outopts.3x, curs_overlay.3x, curs_pad.3x, curs_termattrs.3x
curs_trace.3x, and curs_window.3x
2015-07-26 08:58:34 +08:00
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H3><a name="h3-overlay_-overwrite">overlay, overwrite</a></H3><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
The <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines overlay <EM>srcwin</EM> on top
|
|
|
|
|
of <EM>dstwin</EM>. <EM>scrwin</EM> and <EM>dstwin</EM> are not required to be the
|
|
|
|
|
same size; only text where the two windows overlap is
|
|
|
|
|
copied. The difference is that <STRONG>overlay</STRONG> is non-destructive
|
2010-08-01 08:45:28 +08:00
|
|
|
(blanks are not copied) whereas <STRONG>overwrite</STRONG> is destructive.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
ncurses 6.0 - patch 20150725
+ updated llib-* files.
+ build-fixes for ncurses library "test_progs" rule.
+ use alternate workaround for gcc 5.x feature (adapted from patch by
Mikhail Peselnik).
+ add status line to tmux via xterm+sl (patch by Nicholas Marriott).
+ fixes for st 0.5 from testing with tack -TD
+ review/improve several manual pages to break up wall-of-text:
curs_add_wch.3x, curs_attr.3x, curs_bkgd.3x, curs_bkgrnd.3x,
curs_getcchar.3x, curs_getch.3x, curs_kernel.3x, curs_mouse.3x,
curs_outopts.3x, curs_overlay.3x, curs_pad.3x, curs_termattrs.3x
curs_trace.3x, and curs_window.3x
2015-07-26 08:58:34 +08:00
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H3><a name="h3-copywin">copywin</a></H3><PRE>
|
2010-08-01 08:45:28 +08:00
|
|
|
The <STRONG>copywin</STRONG> routine provides a finer granularity of con-
|
2013-05-19 08:22:02 +08:00
|
|
|
trol over the <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines. As in the
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>prefresh</STRONG> routine, a rectangle is specified in the destina-
|
2010-08-01 08:45:28 +08:00
|
|
|
tion window, (<EM>dminrow</EM>, <EM>dmincol</EM>) and (<EM>dmaxrow</EM>, <EM>dmaxcol</EM>),
|
|
|
|
|
and the upper-left-corner coordinates of the source win-
|
2002-10-13 11:35:53 +08:00
|
|
|
dow, (<EM>sminrow</EM>, <EM>smincol</EM>). If the argument <EM>overlay</EM> is <STRONG>true</STRONG>,
|
|
|
|
|
then copying is non-destructive, as in <STRONG>overlay</STRONG>.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
2010-08-01 08:45:28 +08:00
|
|
|
Routines that return an integer return <STRONG>ERR</STRONG> upon failure,
|
|
|
|
|
and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>ERR</STRONG>") upon successful completion.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2010-08-01 08:45:28 +08:00
|
|
|
X/Open defines no error conditions. In this implementa-
|
|
|
|
|
tion, <STRONG>copywin</STRONG>, <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> return an error if
|
2005-10-10 02:41:57 +08:00
|
|
|
either of the window pointers are null, or if some part of
|
|
|
|
|
the window would be placed off-screen.
|
|
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
Note that <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> may be macros.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
2000-07-09 10:46:08 +08:00
|
|
|
The XSI Curses standard, Issue 4 describes these functions
|
|
|
|
|
(adding the const qualifiers). It further specifies their
|
2002-10-13 11:35:53 +08:00
|
|
|
behavior in the presence of characters with multibyte ren-
|
|
|
|
|
ditions (not yet supported in this implementation).
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<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>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<div class="nav">
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="#h2-NAME">NAME</a></li>
|
|
|
|
|
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
|
ncurses 6.0 - patch 20150725
+ updated llib-* files.
+ build-fixes for ncurses library "test_progs" rule.
+ use alternate workaround for gcc 5.x feature (adapted from patch by
Mikhail Peselnik).
+ add status line to tmux via xterm+sl (patch by Nicholas Marriott).
+ fixes for st 0.5 from testing with tack -TD
+ review/improve several manual pages to break up wall-of-text:
curs_add_wch.3x, curs_attr.3x, curs_bkgd.3x, curs_bkgrnd.3x,
curs_getcchar.3x, curs_getch.3x, curs_kernel.3x, curs_mouse.3x,
curs_outopts.3x, curs_overlay.3x, curs_pad.3x, curs_termattrs.3x
curs_trace.3x, and curs_window.3x
2015-07-26 08:58:34 +08:00
|
|
|
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="#h3-overlay_-overwrite">overlay, overwrite</a></li>
|
|
|
|
|
<li><a href="#h3-copywin">copywin</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2015-02-15 09:42:27 +08:00
|
|
|
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
|
|
|
|
|
<li><a href="#h2-NOTES">NOTES</a></li>
|
|
|
|
|
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
|
|
|
|
|
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
2000-07-09 10:46:08 +08:00
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
