COPYWIN(3XCURSES) X/Open Curses Library Functions COPYWIN(3XCURSES)
NAME
copywin - overlay or overwrite any portion of window
SYNOPSIS
cc [
flag... ]
file...
-I /usr/xpg4/include
-L /usr/xpg4/lib \
-R /usr/xpg4/lib
-lcurses [
library... ]
c89 [
flag... ]
file...
-lcurses [
library... ]
#include <curses.h>
int copywin(
const WINDOW *srcwin,
WINDOW *dstwin,
int sminrow,
int smincol,
int dminrow,
int dmincol,
int dmaxrow,
int dmaxcol,
int overlay);
PARAMETERS
srcwin Is a pointer to the source window to be copied.
dstwin Is a pointer to the destination window to be overlayed or
overwritten.
sminrow Is the row coordinate of the upper left corner of the
rectangular area on the source window to be copied.
smincol Is the column coordinate of the upper left corner of the
rectangular area on the source window to be copied.
dminrow Is the row coordinate of the upper left corner of the
rectangular area on the destination window to be
overlayed or overwritten.
dmincol Is the column coordinate of the upper left corner of the
rectangular area on destination window to be overlayed or
overwritten.
dmaxrow Is the row coordinate of the lower right corner of the
rectangular area on the destination window to be
overlayed or overwritten.
dmaxcol Is the column coordinate of the lower right corner of the
rectangular area on the destination window to be
overlayed or overwritten.
overlay Is a
TRUE or
FALSE value that determines whether the
destination window is overlayed or overwritten.
DESCRIPTION
The
copywin() function provides a finer granularity of control over
the
overlay(3XCURSES) and
overwrite(3XCURSES) functions. As in the
prefresh() function (see
newpad(3XCURSES)), a rectangle is specified
in the destination window, (
dminrow,
dmincol) and (
dmaxrow,
dmaxcol),
and the upper-left-corner coordinates of the source window, (
smincol,
sminrow). If
overlay is
TRUE, then copying is non-destructive, as in
overlay(). If
overlay is
FALSE, then copying is destructive, as in
overwrite().
RETURN VALUES
Upon successful completion, the
copywin() function returns
OK.
Otherwise, it returns
ERR.
ERRORS
No errors are defined.
ATTRIBUTES
See
attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Standard |
+--------------------+-----------------+
|MT-Level | Unsafe |
+--------------------+-----------------+
SEE ALSO
curses(3XCURSES),
libcurses(3XCURSES),
newpad(3XCURSES),
overlay(3XCURSES),
attributes(7),
standards(7) June 5, 2002 COPYWIN(3XCURSES)