X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_overlay.3x;h=e3ed63f89f264b5ee9acc7de69b71cf6f8e0027d;hp=066c3a4a50f67e4fe53559509ef339da2c5e4140;hb=51a395aaa20e4aa687310bb8cb1616ccf8e8fd0d;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/man/curs_overlay.3x b/man/curs_overlay.3x index 066c3a4a..e3ed63f8 100644 --- a/man/curs_overlay.3x +++ b/man/curs_overlay.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2013,2015 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,40 +26,45 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_overlay.3x,v 1.14 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_overlay.3x,v 1.18 2015/07/21 00:51:31 tom Exp $ .TH curs_overlay 3X "" .na .hy 0 .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 \fR .sp -\fBint overlay(const WINDOW *srcwin, WINDOW *dstwin);\fR +\fBint overlay(const WINDOW *\fP\fIsrcwin\fP\fB, WINDOW *\fP\fIdstwin\fP\fB);\fR .br -\fBint overwrite(const WINDOW *srcwin, WINDOW *dstwin);\fR +\fBint overwrite(const WINDOW *\fP\fIsrcwin\fP\fB, WINDOW *\fP\fIdstwin\fP\fB);\fR .br -\fBint copywin(const WINDOW *srcwin, WINDOW *dstwin, int sminrow,\fR - \fBint smincol, int dminrow, int dmincol, int dmaxrow,\fR - \fBint dmaxcol, int overlay);\fR +\fBint copywin(const WINDOW *\fP\fIsrcwin\fP\fB, WINDOW *\fP\fIdstwin\fP\fB, int \fP\fIsminrow\fP\fB,\fR + \fBint \fP\fIsmincol\fP\fB, int \fP\fIdminrow\fP\fB, int \fP\fIdmincol\fP\fB, int \fP\fIdmaxrow\fP\fB,\fR + \fBint \fP\fIdmaxcol\fP\fB, int \fP\fIoverlay\fP\fB);\fR .SH DESCRIPTION +.SS overlay, overwrite 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. +.SS copywin .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,13 +80,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) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: