usr/src/man/man3xcurses/copywin.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH COPYWIN 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 copywin \- overlay or overwrite any portion of window
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBcopywin\fR(\fBconst WINDOW *\fR\fIsrcwin\fR, \fBWINDOW *\fR\fIdstwin\fR, \fBint\fR \fIsminrow\fR, \fBint\fR \fIsmincol\fR,
  20      \fBint\fR \fIdminrow\fR, \fBint\fR \fIdmincol\fR, \fBint\fR \fIdmaxrow\fR, \fBint\fR \fIdmaxcol\fR, \fBint\fR \fIoverlay\fR);
  21 .fi
  22
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIsrcwin\fR\fR
  28 .ad
  29 .RS 11n
  30 Is a pointer to the source window to be copied.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIdstwin\fR\fR
  37 .ad
  38 .RS 11n
  39 Is a pointer to the destination window to be overlayed or overwritten.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fIsminrow\fR\fR
  46 .ad
  47 .RS 11n
  48 Is the row coordinate of the upper left corner of the rectangular area  on the
  49 source window to be copied.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIsmincol\fR\fR
  56 .ad
  57 .RS 11n
  58 Is the column coordinate of the upper left corner of the rectangular area  on
  59 the source window to be copied.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fIdminrow\fR\fR
  66 .ad
  67 .RS 11n
  68 Is the row coordinate of the upper left corner of the rectangular area  on the
  69 destination window to be overlayed or overwritten.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fIdmincol\fR\fR
  76 .ad
  77 .RS 11n
  78 Is the column coordinate of the upper left corner of the rectangular area  on
  79 destination window to be overlayed or overwritten.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fIdmaxrow\fR\fR
  86 .ad
  87 .RS 11n
  88 Is the row coordinate of the lower right corner of the rectangular area  on the
  89 destination window to be overlayed or overwritten.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fIdmaxcol\fR\fR
  96 .ad
  97 .RS 11n
  98 Is the column coordinate of the lower right corner of the rectangular area  on
  99 the destination window to be overlayed or overwritten.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fIoverlay\fR\fR
 106 .ad
 107 .RS 11n
 108 Is a \fBTRUE\fR or \fBFALSE\fR value that determines whether the destination
 109 window is overlayed or overwritten.
 110 .RE
 111
 112 .SH DESCRIPTION
 113 .sp
 114 .LP
 115 The \fBcopywin()\fR function provides a finer granularity of control over the
 116 \fBoverlay\fR(3XCURSES) and \fBoverwrite\fR(3XCURSES) functions. As in the
 117 \fBprefresh()\fR function (see \fBnewpad\fR(3XCURSES)), a rectangle is
 118 specified in the destination window, (\fIdminrow\fR, \fIdmincol\fR) and
 119 (\fIdmaxrow\fR, \fIdmaxcol\fR), and the upper-left-corner coordinates of the
 120 source window, (\fIsmincol\fR, \fIsminrow\fR). If \fIoverlay\fR is \fBTRUE\fR,
 121 then copying is non-destructive, as in \fBoverlay()\fR. If \fIoverlay\fR is
 122 \fBFALSE\fR, then copying is destructive, as in \fBoverwrite()\fR.
 123 .SH RETURN VALUES
 124 .sp
 125 .LP
 126 Upon successful completion, the \fBcopywin()\fR function returns \fBOK\fR.
 127 Otherwise, it returns \fBERR\fR.
 128 .SH ERRORS
 129 .sp
 130 .LP
 131 No errors are defined.
 132 .SH ATTRIBUTES
 133 .sp
 134 .LP
 135 See \fBattributes\fR(5) for descriptions of the following attributes:
 136 .sp
 137
 138 .sp
 139 .TS
 140 box;
 141 c | c
 142 l | l .
 143 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 144 _
 145 Interface Stability     Standard
 146 _
 147 MT-Level        Unsafe
 148 .TE
 149
 150 .SH SEE ALSO
 151 .sp
 152 .LP
 153 \fBcurses\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnewpad\fR(3XCURSES),
 154 \fBoverlay\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)