man/curs_overlay.3x

   1 .TH curs_overlay 3X ""
   2 .SH NAME
   3 \fBoverlay\fR, \fBoverwrite\fR, \fBcopywin\fR - overlay and
   4 manipulate overlapped \fBcurses\fR windows
   5 .SH SYNOPSIS
   6 \fB#include <curses.h>\fR
   7
   8 \fBint overlay(const WINDOW *srcwin, WINDOW *dstwin);\fR
   9 .br
  10 \fBint overwrite(const WINDOW *srcwin, WINDOW *dstwin);\fR
  11 .br
  12 \fBint copywin(WINDOW *srcwin, WINDOW *dstwin, int sminrow,
  13       int smincol, int dminrow, int dmincol, int dmaxrow,
  14       int dmaxcol, int overlay);\fR
  15 .SH DESCRIPTION
  16 The \fBoverlay\fR and \fBoverwrite\fR routines overlay \fIsrcwin\fR on
  17 top of \fIdstwin\fR.  \fIscrwin\fR and \fIdstwin\fR are not required
  18 to be the same size; only text where the two windows overlap is
  19 copied.  The difference is that \fBoverlay\fR is non-destructive
  20 (blanks are not copied) whereas \fBoverwrite\fR is destructive.
  21
  22 The \fBcopywin\fR routine provides a finer granularity of control over the
  23 \fBoverlay\fR and \fBoverwrite\fR routines.  Like in the \fBprefresh\fR
  24 routine, a rectangle is specified in the destination window, (\fIdminrow\fR,
  25 \fIdmincol\fR) and (\fIdmaxrow\fR, \fIdmaxcol\fR), and the upper-left-corner
  26 coordinates of the source window, (\fIsminrow\fR, \fIsmincol\fR).  If the
  27 argument \fIoverlay\fR is \fBtrue\fR, then copying is non-destructive, as in
  28 \fBoverlay\fR.
  29 .SH RETURN VALUE
  30 Routines that return an integer return \fBERR\fR upon failure, and \fBOK\fR
  31 (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
  32 completion.
  33 .SH NOTES
  34 Note that \fBoverlay\fR and \fBoverwrite\fR may be macros.
  35 .SH PORTABILITY
  36 The XSI Curses standard, Issue 4 describes these functions (adding the const
  37 qualifiers).  It further specifies their behavior in the presence of characters
  38 with multi-byte renditions (not yet supported in this implementation).
  39 .SH SEE ALSO
  40 \fBcurses\fR(3X), \fBcurs_pad\fR(3X), \fBcurs_refresh\fR(3X)
  41 .\"#
  42 .\"# The following sets edit modes for GNU EMACS
  43 .\"# Local Variables:
  44 .\"# mode:nroff
  45 .\"# fill-column:79
  46 .\"# End: