diff options
Diffstat (limited to 'man/curs_overlay.3x')
| -rw-r--r-- | man/curs_overlay.3x | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/man/curs_overlay.3x b/man/curs_overlay.3x index cea734e..972a957 100644 --- a/man/curs_overlay.3x +++ b/man/curs_overlay.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2010,2013 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_overlay.3x,v 1.16 2010/12/04 18:40:45 tom Exp $ +.\" $Id: curs_overlay.3x,v 1.17 2013/04/06 23:48:51 tom Exp $ .TH curs_overlay 3X "" .na .hy 0 @@ -48,18 +48,21 @@ \fBint dmaxcol, int overlay);\fR .SH DESCRIPTION The \fBoverlay\fR and \fBoverwrite\fR routines overlay \fIsrcwin\fR on -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 +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. .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, +\fBoverlay\fR and \fBoverwrite\fR routines. +As in the \fBprefresh\fR routine, +a rectangle is specified in the destination window, (\fIdminrow\fR, \fIdmincol\fR) and (\fIdmaxrow\fR, \fIdmaxcol\fR), and the upper-left-corner -coordinates of the source window, (\fIsminrow\fR, \fIsmincol\fR). If the -argument \fIoverlay\fR is \fBtrue\fR, then copying is non-destructive, as in -\fBoverlay\fR. +coordinates of the source window, (\fIsminrow\fR, \fIsmincol\fR). +If the argument \fIoverlay\fR is \fBtrue\fR, +then copying is non-destructive, +as in \fBoverlay\fR. .SH RETURN VALUE 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 @@ -75,7 +78,8 @@ if some part of the window would be placed off-screen. 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 +qualifiers). +It further specifies their behavior in the presence of characters with multibyte renditions (not yet supported in this implementation). .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_pad\fR(3X), \fBcurs_refresh\fR(3X) |