copywin(3xcurses)

1copywin(3XCURSES)       X/Open Curses Library Functions      copywin(3XCURSES)
2
3
4

NAME

6       copywin - overlay or overwrite any portion of window
7

SYNOPSIS

9       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
10        -R  /usr/xpg4/lib  -lcurses  [ library... ]
11
12       c89 [ flag... ] file... -lcurses [ library... ]
13
14       #include <curses.h>
15
16       int copywin(const WINDOW *srcwin, WINDOW *dstwin, int sminrow, int smincol,
17            int dminrow, int dmincol, int dmaxrow, int dmaxcol, int overlay);
18
19

PARAMETERS

21       srcwin     Is a pointer to the source window to be copied.
22
23
24       dstwin     Is  a  pointer  to the destination window to be overlayed or
25                  overwritten.
26
27
28       sminrow    Is the row coordinate of the upper left corner of  the  rec‐
29                  tangular area  on the source window to be copied.
30
31
32       smincol    Is  the  column  coordinate  of the upper left corner of the
33                  rectangular area  on the source window to be copied.
34
35
36       dminrow    Is the row coordinate of the upper left corner of  the  rec‐
37                  tangular  area  on the destination window to be overlayed or
38                  overwritten.
39
40
41       dmincol    Is the column coordinate of the upper  left  corner  of  the
42                  rectangular  area   on destination window to be overlayed or
43                  overwritten.
44
45
46       dmaxrow    Is the row coordinate of the lower right corner of the  rec‐
47                  tangular  area  on the destination window to be overlayed or
48                  overwritten.
49
50
51       dmaxcol    Is the column coordinate of the lower right  corner  of  the
52                  rectangular  area  on the destination window to be overlayed
53                  or overwritten.
54
55
56       overlay    Is a TRUE or FALSE value that determines whether the  desti‐
57                  nation  window is overlayed or overwritten.
58
59

DESCRIPTION

61       The copywin() function provides a finer granularity of control over the
62       overlay(3XCURSES) and overwrite(3XCURSES) functions.  As  in  the  pre‐
63       fresh()  function  (see  newpad(3XCURSES)), a rectangle is specified in
64       the destination window, (dminrow, dmincol) and (dmaxrow, dmaxcol),  and
65       the upper-left-corner coordinates of the source window, (smincol, smin‐
66       row). If overlay is TRUE, then copying is non-destructive, as in  over‐
67       lay().  If  overlay  is FALSE, then copying is destructive, as in over‐
68       write().
69

RETURN VALUES

71       Upon successful completion, the copywin() function returns  OK.  Other‐
72       wise, it returns ERR.
73

ERRORS

75       No errors are defined.
76

ATTRIBUTES

78       See attributes(5) for descriptions of the following attributes:
79
80
81
82
83       ┌─────────────────────────────┬─────────────────────────────┐
84       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
85       ├─────────────────────────────┼─────────────────────────────┤
86       │Interface Stability          │Standard                     │
87       ├─────────────────────────────┼─────────────────────────────┤
88       │MT-Level                     │Unsafe                       │
89       └─────────────────────────────┴─────────────────────────────┘
90