ncurses 5.7 - patch 20101204
[ncurses.git] / man / curs_overlay.3x
index 9c0b82c9af211012c4605d7a6cc546577b2f4cfd..cea734e4a97c1220040c5c43d664ebc778ae5845 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************
-.\" Copyright (c) 1998,2000 Free Software Foundation, Inc.                   *
+.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_overlay.3x,v 1.9 2000/07/01 20:05:31 tom Exp $
+.\" $Id: curs_overlay.3x,v 1.16 2010/12/04 18:40:45 tom Exp $
 .TH curs_overlay 3X ""
 .TH curs_overlay 3X ""
+.na
+.hy 0
 .SH NAME
 \fBoverlay\fR,
 \fBoverwrite\fR,
 .SH NAME
 \fBoverlay\fR,
 \fBoverwrite\fR,
-\fBcopywin\fR - overlay and manipulate overlapped \fBcurses\fR windows
+\fBcopywin\fR \- overlay and manipulate overlapped \fBcurses\fR windows
+.ad
+.hy
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
-
+.sp
 \fBint overlay(const WINDOW *srcwin, WINDOW *dstwin);\fR
 .br
 \fBint overwrite(const WINDOW *srcwin, WINDOW *dstwin);\fR
 .br
 \fBint overlay(const WINDOW *srcwin, WINDOW *dstwin);\fR
 .br
 \fBint overwrite(const WINDOW *srcwin, WINDOW *dstwin);\fR
 .br
-\fBint copywin(WINDOW *srcwin, WINDOW *dstwin, int sminrow,\fR
+\fBint copywin(const WINDOW *srcwin, WINDOW *dstwin, int sminrow,\fR
       \fBint smincol, int dminrow, int dmincol, int dmaxrow,\fR
       \fBint dmaxcol, int overlay);\fR
 .SH DESCRIPTION
       \fBint smincol, int dminrow, int dmincol, int dmaxrow,\fR
       \fBint dmaxcol, int overlay);\fR
 .SH DESCRIPTION
@@ -48,7 +52,7 @@ top of \fIdstwin\fR.  \fIscrwin\fR and \fIdstwin\fR are not required
 to be the same size; only text where the two windows overlap is
 copied.  The difference is that \fBoverlay\fR is non-destructive
 (blanks are not copied) whereas \fBoverwrite\fR is destructive.
 to be the same size; only text where the two windows overlap is
 copied.  The difference is that \fBoverlay\fR is non-destructive
 (blanks are not copied) whereas \fBoverwrite\fR is destructive.
-
+.PP
 The \fBcopywin\fR routine provides a finer granularity of control over the
 \fBoverlay\fR and \fBoverwrite\fR routines.  Like in the \fBprefresh\fR
 routine, a rectangle is specified in the destination window, (\fIdminrow\fR,
 The \fBcopywin\fR routine provides a finer granularity of control over the
 \fBoverlay\fR and \fBoverwrite\fR routines.  Like in the \fBprefresh\fR
 routine, a rectangle is specified in the destination window, (\fIdminrow\fR,
@@ -60,17 +64,18 @@ argument \fIoverlay\fR is \fBtrue\fR, then copying is non-destructive, as in
 Routines that return an integer return \fBERR\fR upon failure, and \fBOK\fR
 (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
 completion.
 Routines that return an integer return \fBERR\fR upon failure, and \fBOK\fR
 (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
 completion.
+.PP
+X/Open defines no error conditions.
+In this implementation,
+\fBcopywin\fP,
+\fBoverlay\fP and \fBoverwrite\fP return an error
+if either of the window pointers are null, or
+if some part of the window would be placed off-screen.
 .SH NOTES
 Note that \fBoverlay\fR and \fBoverwrite\fR may be macros.
 .SH PORTABILITY
 The XSI Curses standard, Issue 4 describes these functions (adding the const
 qualifiers).  It further specifies their behavior in the presence of characters
 .SH NOTES
 Note that \fBoverlay\fR and \fBoverwrite\fR may be macros.
 .SH PORTABILITY
 The XSI Curses standard, Issue 4 describes these functions (adding the const
 qualifiers).  It further specifies their behavior in the presence of characters
-with multi-byte renditions (not yet supported in this implementation).
+with multibyte renditions (not yet supported in this implementation).
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBcurs_pad\fR(3X), \fBcurs_refresh\fR(3X)
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBcurs_pad\fR(3X), \fBcurs_refresh\fR(3X)
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: