X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_overlay.3x;h=b352192b753cd5350c6b6e34e1d6cbe605eaefbb;hb=f79c210479470378389aab5b8d4d42d4a7f3d9a4;hp=e3ed63f89f264b5ee9acc7de69b71cf6f8e0027d;hpb=6a530b46563470c2ca73579d1994a0c8e275dd98;p=ncurses.git diff --git a/man/curs_overlay.3x b/man/curs_overlay.3x index e3ed63f8..b352192b 100644 --- a/man/curs_overlay.3x +++ b/man/curs_overlay.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2013,2015 Free Software Foundation, Inc. * +.\" Copyright 2020-2021,2022 Thomas E. Dickey * +.\" Copyright 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,48 +27,48 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_overlay.3x,v 1.18 2015/07/21 00:51:31 tom Exp $ -.TH curs_overlay 3X "" +.\" $Id: curs_overlay.3x,v 1.23 2022/02/12 20:05:11 tom Exp $ +.TH curs_overlay 3X 2022-02-12 "ncurses 6.4" "Library calls" .na .hy 0 .SH NAME -\fBoverlay\fR, -\fBoverwrite\fR, -\fBcopywin\fR \- overlay and manipulate overlapped \fBcurses\fR windows +\fBoverlay\fP, +\fBoverwrite\fP, +\fBcopywin\fP \- overlay and manipulate overlapped \fBcurses\fP windows .ad .hy .SH SYNOPSIS -\fB#include \fR +\fB#include \fP .sp -\fBint overlay(const WINDOW *\fP\fIsrcwin\fP\fB, WINDOW *\fP\fIdstwin\fP\fB);\fR +\fBint overlay(const WINDOW *\fIsrcwin\fB, WINDOW *\fIdstwin\fB);\fR .br -\fBint overwrite(const WINDOW *\fP\fIsrcwin\fP\fB, WINDOW *\fP\fIdstwin\fP\fB);\fR +\fBint overwrite(const WINDOW *\fIsrcwin\fB, WINDOW *\fIdstwin\fB);\fR .br -\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 +\fBint copywin(const WINDOW *\fIsrcwin\fB, WINDOW *\fIdstwin\fB, int \fIsminrow\fB,\fR + \fBint \fIsmincol\fB, int \fIdminrow\fB, int \fIdmincol\fB, int \fIdmaxrow\fB,\fR + \fBint \fIdmaxcol\fB, int \fIoverlay\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 +The \fBoverlay\fP and \fBoverwrite\fP routines overlay \fIsrcwin\fP on +top of \fIdstwin\fP. +\fIscrwin\fP and \fIdstwin\fP 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. +The difference is that \fBoverlay\fP is non-destructive +(blanks are not copied) whereas \fBoverwrite\fP is destructive. .SS copywin .PP -The \fBcopywin\fR routine provides a finer granularity of control over the -\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, +The \fBcopywin\fP routine provides a finer granularity of control over the +\fBoverlay\fP and \fBoverwrite\fP routines. +As in the \fBprefresh\fP routine, +a rectangle is specified in the destination window, (\fIdminrow\fP, +\fIdmincol\fP) and (\fIdmaxrow\fP, \fIdmaxcol\fP), and the upper-left-corner +coordinates of the source window, (\fIsminrow\fP, \fIsmincol\fP). +If the argument \fIoverlay\fP is \fBtrue\fP, then copying is non-destructive, -as in \fBoverlay\fR. +as in \fBoverlay\fP. .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 +Routines that return an integer return \fBERR\fP upon failure, and \fBOK\fP +(SVr4 only specifies "an integer value other than \fBERR\fP") upon successful completion. .PP X/Open defines no error conditions. @@ -77,11 +78,11 @@ In this implementation, 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. +Note that \fBoverlay\fP and \fBoverwrite\fP 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 multibyte renditions (not yet supported in this implementation). .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_pad\fR(3X), \fBcurs_refresh\fR(3X) +\fBcurses\fP(3X), \fBcurs_pad\fP(3X), \fBcurs_refresh\fP(3X)