X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_overlay.3x;h=4846fe12d6a9ff864e2b52b7ceb6d2653433aff2;hp=c582152cf710d55601eb48cd273927ac81f83f2a;hb=HEAD;hpb=7e062bb2764a87d98073a90ee65a234a2679f9c1 diff --git a/man/curs_overlay.3x b/man/curs_overlay.3x index c582152c..c4400637 100644 --- a/man/curs_overlay.3x +++ b/man/curs_overlay.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2020-2022,2023 Thomas E. Dickey * +.\" Copyright 2020-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2013,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,25 +27,36 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_overlay.3x,v 1.32 2023/09/30 21:38:11 tom Exp $ -.TH curs_overlay 3X 2023-09-30 "ncurses 6.4" "Library calls" +.\" $Id: curs_overlay.3x,v 1.45 2024/05/25 20:10:58 tom Exp $ +.TH curs_overlay 3X 2024-05-25 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .SH NAME \fB\%overlay\fP, \fB\%overwrite\fP, \fB\%copywin\fP \- overlay \fIcurses\fR windows and manipulate them .SH SYNOPSIS -\fB#include \fP -.sp -\fBint overlay(const WINDOW *\fIsrcwin\fB, WINDOW *\fIdstwin\fB);\fR -.br -\fBint overwrite(const WINDOW *\fIsrcwin\fB, WINDOW *\fIdstwin\fB);\fR -.br -\fBint copywin(const WINDOW *\fIsrcwin\fB, WINDOW *\fIdstwin\fB, int \fIsminrow\fB,\fR +.nf +\fB#include +.PP +\fBint overlay(const WINDOW *\fIsrcwin\fP, WINDOW *\fIdstwin\fP); +\fBint overwrite(const WINDOW *\fIsrcwin\fP, WINDOW *\fIdstwin\fP); +\fBint copywin(const WINDOW *\fIsrcwin\fP, WINDOW *\fIdstwin\fP, int \fIsminrow\fP, \fBint \fIsmincol\fB, int \fIdminrow\fB, int \fIdmincol\fB, int \fIdmaxrow\fB,\fR \fBint \fIdmaxcol\fB, int \fIoverlay\fB);\fR +.fi .SH DESCRIPTION -.SS overlay, overwrite +.SS "overlay, overwrite" The \fBoverlay\fP and \fBoverwrite\fP routines overlay \fIsrcwin\fP on top of \fIdstwin\fP. \fIscrwin\fP and \fIdstwin\fP are not required @@ -63,21 +74,23 @@ If the argument \fIoverlay\fP is \fBtrue\fP, then copying is non-destructive, as in \fBoverlay\fP. .SH RETURN VALUE -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. +These routines return the integer \fBERR\fP upon failure and an \fBOK\fP +(SVr4 specifies only +\*(``an integer value other than \fBERR\fP\*('') +upon successful completion. .PP X/Open defines no error conditions. In this implementation, \fBcopywin\fP, -\fBoverlay\fP and \fBoverwrite\fP return an error +\fBoverlay\fP and \fBoverwrite\fP return +.B ERR 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\fP and \fBoverwrite\fP may be macros. .SH PORTABILITY -The XSI Curses standard, Issue 4 describes these functions (adding the const -qualifiers). +These functions are described in X/Open Curses, Issue 4, +which adds \fI\%const\fP qualifiers to the arguments. It further specifies their behavior in the presence of characters with multibyte renditions (not yet supported in this implementation). .SH SEE ALSO