-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
-<!--
+<!--
****************************************************************************
- * Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. *
+ * Copyright 2020 Thomas E. Dickey *
+ * Copyright 1998-2013,2015 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_overlay.3x,v 1.14 2006/02/25 21:49:19 tom Exp @
+ * @Id: curs_overlay.3x,v 1.19 2020/02/02 23:34:34 tom Exp @
-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
-<TITLE>curs_overlay 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>curs_overlay 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
-<H1>curs_overlay 3x</H1>
-<HR>
+<H1 class="no-header">curs_overlay 3X</H1>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
-<STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG>
+<B><A HREF="curs_overlay.3X.html">curs_overlay(3X)</A></B> <B><A HREF="curs_overlay.3X.html">curs_overlay(3X)</A></B>
-</PRE>
-<H2>NAME</H2><PRE>
- <STRONG>overlay</STRONG>, <STRONG>overwrite</STRONG>, <STRONG>copywin</STRONG> - overlay and manipulate
- overlapped <STRONG>curses</STRONG> windows
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+ <B>overlay</B>, <B>overwrite</B>, <B>copywin</B> - overlay and manipulate overlapped <B>curses</B>
+ windows
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
- <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+ <B>#include</B> <B><curses.h></B>
- <STRONG>int</STRONG> <STRONG>overlay(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin);</STRONG>
- <STRONG>int</STRONG> <STRONG>overwrite(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin);</STRONG>
- <STRONG>int</STRONG> <STRONG>copywin(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*srcwin,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*dstwin,</STRONG> <STRONG>int</STRONG>
- <STRONG>sminrow,</STRONG>
- <STRONG>int</STRONG> <STRONG>smincol,</STRONG> <STRONG>int</STRONG> <STRONG>dminrow,</STRONG> <STRONG>int</STRONG> <STRONG>dmincol,</STRONG> <STRONG>int</STRONG> <STRONG>dmaxrow,</STRONG>
- <STRONG>int</STRONG> <STRONG>dmaxcol,</STRONG> <STRONG>int</STRONG> <STRONG>overlay);</STRONG>
+ <B>int</B> <B>overlay(const</B> <B>WINDOW</B> <B>*</B><I>srcwin</I><B>,</B> <B>WINDOW</B> <B>*</B><I>dstwin</I><B>);</B>
+ <B>int</B> <B>overwrite(const</B> <B>WINDOW</B> <B>*</B><I>srcwin</I><B>,</B> <B>WINDOW</B> <B>*</B><I>dstwin</I><B>);</B>
+ <B>int</B> <B>copywin(const</B> <B>WINDOW</B> <B>*</B><I>srcwin</I><B>,</B> <B>WINDOW</B> <B>*</B><I>dstwin</I><B>,</B> <B>int</B> <I>sminrow</I><B>,</B>
+ <B>int</B> <I>smincol</I><B>,</B> <B>int</B> <I>dminrow</I><B>,</B> <B>int</B> <I>dmincol</I><B>,</B> <B>int</B> <I>dmaxrow</I><B>,</B>
+ <B>int</B> <I>dmaxcol</I><B>,</B> <B>int</B> <I>overlay</I><B>);</B>
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
- 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
- (blanks are not copied) whereas <STRONG>overwrite</STRONG> is destructive.
-
- The <STRONG>copywin</STRONG> routine provides a finer granularity of con-
- trol over the <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines. Like in the
- <STRONG>prefresh</STRONG> routine, a rectangle is specified in the destina-
- 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-
- 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>.
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+</PRE><H3><a name="h3-overlay_-overwrite">overlay, overwrite</a></H3><PRE>
+ The <B>overlay</B> and <B>overwrite</B> routines overlay <I>srcwin</I> on top of <I>dstwin</I>.
+ <I>scrwin</I> and <I>dstwin</I> are not required to be the same size; only text where
+ the two windows overlap is copied. The difference is that <B>overlay</B> is
+ non-destructive (blanks are not copied) whereas <B>overwrite</B> is destruc-
+ tive.
-</PRE>
-<H2>RETURN VALUE</H2><PRE>
- Routines that return an integer return <STRONG>ERR</STRONG> upon failure,
- and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
- <STRONG>ERR</STRONG>") upon successful completion.
- X/Open defines no error conditions. In this implementa-
- tion, <STRONG>copywin</STRONG>, <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> return an error if
- either of the window pointers are null, or if some part of
- the window would be placed off-screen.
+</PRE><H3><a name="h3-copywin">copywin</a></H3><PRE>
+ The <B>copywin</B> routine provides a finer granularity of control over the
+ <B>overlay</B> and <B>overwrite</B> routines. As in the <B>prefresh</B> routine, a rectan-
+ gle is specified in the destination window, (<I>dminrow</I>, <I>dmincol</I>) and
+ (<I>dmaxrow</I>, <I>dmaxcol</I>), and the upper-left-corner coordinates of the source
+ window, (<I>sminrow</I>, <I>smincol</I>). If the argument <I>overlay</I> is <B>true</B>, then
+ copying is non-destructive, as in <B>overlay</B>.
-</PRE>
-<H2>NOTES</H2><PRE>
- Note that <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> may be macros.
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ Routines that return an integer return <B>ERR</B> upon failure, and <B>OK</B> (SVr4
+ only specifies "an integer value other than <B>ERR</B>") upon successful com-
+ pletion.
+ X/Open defines no error conditions. In this implementation, <B>copywin</B>,
+ <B>overlay</B> and <B>overwrite</B> return an error if either of the window pointers
+ are null, or if some part of the window would be placed off-screen.
-</PRE>
-<H2>PORTABILITY</H2><PRE>
- The XSI Curses standard, Issue 4 describes these functions
- (adding the const qualifiers). It further specifies their
- behavior in the presence of characters with multibyte ren-
- ditions (not yet supported in this implementation).
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+ Note that <B>overlay</B> and <B>overwrite</B> may be macros.
-</PRE>
-<H2>SEE ALSO</H2><PRE>
- <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>
+
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ The XSI Curses standard, Issue 4 describes these functions (adding the
+ const qualifiers). It further specifies their behavior in the presence
+ of characters with multibyte renditions (not yet supported in this im-
+ plementation).
+
+
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <B><A HREF="curses.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>
- <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG>
+ <B><A HREF="curs_overlay.3X.html">curs_overlay(3X)</A></B>
</PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<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>
+<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>
</BODY>
</HTML>
projects / ncurses.git / blobdiff