1curs_overlay(3X)                                              curs_overlay(3X)
2
3
4

NAME

6       overlay, overwrite, copywin - overlay and manipulate overlapped curses
7       windows
8

SYNOPSIS

10       #include <curses.h>
11
12       int overlay(const WINDOW *srcwin, WINDOW *dstwin);
13       int overwrite(const WINDOW *srcwin, WINDOW *dstwin);
14       int copywin(const WINDOW *srcwin, WINDOW *dstwin, int sminrow,
15             int smincol, int dminrow, int dmincol, int dmaxrow,
16             int dmaxcol, int overlay);
17

DESCRIPTION

19       The overlay and overwrite routines overlay srcwin  on  top  of  dstwin.
20       scrwin and dstwin are not required to be the same size; only text where
21       the two windows overlap is copied.  The difference is that  overlay  is
22       non-destructive  (blanks  are not copied) whereas overwrite is destruc‐
23       tive.
24
25       The copywin routine provides a finer granularity of  control  over  the
26       overlay  and  overwrite routines.  Like in the prefresh routine, a rec‐
27       tangle is specified in the destination window, (dminrow,  dmincol)  and
28       (dmaxrow, dmaxcol), and the upper-left-corner coordinates of the source
29       window, (sminrow, smincol).  If the  argument  overlay  is  true,  then
30       copying is non-destructive, as in overlay.
31

RETURN VALUE

33       Routines  that  return an integer return ERR upon failure, and OK (SVr4
34       only specifies "an integer value other than ERR") upon successful  com‐
35       pletion.
36
37       X/Open  defines  no error conditions.  In this implementation, copywin,
38       overlay and overwrite return an error if either of the window  pointers
39       are null, or if some part of the window would be placed off-screen.
40

NOTES

42       Note that overlay and overwrite may be macros.
43

PORTABILITY

45       The  XSI Curses standard, Issue 4 describes these functions (adding the
46       const qualifiers).  It further specifies their behavior in the presence
47       of  characters with multibyte renditions (not yet supported in this im‐
48       plementation).
49

SEE ALSO

51       curses(3X), curs_pad(3X), curs_refresh(3X)
52
53
54
55                                                              curs_overlay(3X)
Impressum