diff options
Diffstat (limited to 'doc/html/man/curs_overlay.3x.html')
| -rw-r--r-- | doc/html/man/curs_overlay.3x.html | 51 |
1 files changed, 25 insertions, 26 deletions
diff --git a/doc/html/man/curs_overlay.3x.html b/doc/html/man/curs_overlay.3x.html index 61c4c1999fd1..5b431a4c69c5 100644 --- a/doc/html/man/curs_overlay.3x.html +++ b/doc/html/man/curs_overlay.3x.html @@ -1,6 +1,6 @@ <!-- **************************************************************************** - * Copyright 2020-2023,2024 Thomas E. Dickey * + * Copyright 2020-2024,2025 Thomas E. Dickey * * Copyright 1998-2013,2015 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,25 +27,23 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_overlay.3x,v 1.43 2024/04/20 21:20:07 tom Exp @ + * @Id: curs_overlay.3x,v 1.55 2025/01/19 00:51:10 tom Exp @ --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> <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 2024-04-20 ncurses 6.5 Library calls</TITLE> +<TITLE>curs_overlay 3x 2025-01-18 ncurses 6.6 Library calls</TITLE> <link rel="author" href="mailto:bug-ncurses@gnu.org"> </HEAD> <BODY> -<H1 class="no-header">curs_overlay 3x 2024-04-20 ncurses 6.5 Library calls</H1> +<H1 class="no-header">curs_overlay 3x 2025-01-18 ncurses 6.6 Library calls</H1> <PRE> <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> - - </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> <STRONG>overlay</STRONG>, <STRONG>overwrite</STRONG>, <STRONG>copywin</STRONG> - overlay <EM>curses</EM> windows and manipulate them @@ -66,47 +64,48 @@ </PRE><H3><a name="h3-overlay_overwrite">overlay, overwrite</a></H3><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 + 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. </PRE><H3><a name="h3-copywin">copywin</a></H3><PRE> - The <STRONG>copywin</STRONG> routine provides a finer granularity of control over the + The <STRONG>copywin</STRONG> routine provides a finer granularity of control over the <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> routines. As in the <STRONG>prefresh</STRONG> routine, a - rectangle is specified in the destination window, (<EM>dminrow</EM>, <EM>dmincol</EM>) - and (<EM>dmaxrow</EM>, <EM>dmaxcol</EM>), and the upper-left-corner coordinates of the - source window, (<EM>sminrow</EM>, <EM>smincol</EM>). If the argument <EM>overlay</EM> is <STRONG>true</STRONG>, + rectangle is specified in the destination window, (<EM>dminrow</EM>, <EM>dmincol</EM>) + and (<EM>dmaxrow</EM>, <EM>dmaxcol</EM>), and the upper-left-corner coordinates of the + source window, (<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-RETURN-VALUE">RETURN VALUE</a></H2><PRE> - These routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG> (SVr4 - specifies only "an integer value other than <STRONG>ERR</STRONG>") upon successful - completion. + These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure. + + In <EM>ncurses</EM>, they return <STRONG>ERR</STRONG> if + + <STRONG>o</STRONG> either of the window pointers are null, or - X/Open defines no error conditions. In this implementation, <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. + <STRONG>o</STRONG> any part of the window would be placed off-screen. </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> - Note that <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> may be macros. + <STRONG>overlay</STRONG> and <STRONG>overwrite</STRONG> may be implemented as macros. </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> - These functions are described in X/Open Curses, Issue 4, which adds - <EM>const</EM> qualifiers to the arguments. It further specifies their behavior - in the presence of characters with multibyte renditions (not yet - supported in this implementation). + X/Open Curses Issue 4 describes these functions. It specifies no error + conditions for them. It adds <EM>const</EM> qualifiers to the arguments. It + further specifies their behavior in the presence of characters with + multibyte renditions (not yet supported in this implementation). + + SVr4 describes a successful return value only as "an integer value + other than <EM>ERR</EM>". </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></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> - - -ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> +ncurses 6.6 2025-01-18 <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG> </PRE> <div class="nav"> <ul> |