diff options
Diffstat (limited to 'upstream/archlinux/man3/curs_overlay.3x')
| -rw-r--r-- | upstream/archlinux/man3/curs_overlay.3x | 60 |
1 files changed, 35 insertions, 25 deletions
diff --git a/upstream/archlinux/man3/curs_overlay.3x b/upstream/archlinux/man3/curs_overlay.3x index 9c6561e7..9f7d5562 100644 --- a/upstream/archlinux/man3/curs_overlay.3x +++ b/upstream/archlinux/man3/curs_overlay.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2020-2021,2022 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,28 +27,36 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_overlay.3x,v 1.22 2022/02/12 20:05:11 tom Exp $ -.TH curs_overlay 3X "" -.na -.hy 0 +.\" $Id: curs_overlay.3x,v 1.43 2024/04/20 21:20:07 tom Exp $ +.TH curs_overlay 3X 2024-04-20 "ncurses 6.5" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .SH NAME -\fBoverlay\fP, -\fBoverwrite\fP, -\fBcopywin\fP \- overlay and manipulate overlapped \fBcurses\fP windows -.ad -.hy +\fB\%overlay\fP, +\fB\%overwrite\fP, +\fB\%copywin\fP \- +overlay \fIcurses\fR windows and manipulate them .SH SYNOPSIS -\fB#include <curses.h>\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 <curses.h> +.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 @@ -56,7 +64,6 @@ to be the same size; only text where the two windows overlap is copied. The difference is that \fBoverlay\fP is non-destructive (blanks are not copied) whereas \fBoverwrite\fP is destructive. .SS copywin -.PP The \fBcopywin\fP routine provides a finer granularity of control over the \fBoverlay\fP and \fBoverwrite\fP routines. As in the \fBprefresh\fP routine, @@ -67,9 +74,10 @@ 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, @@ -80,9 +88,11 @@ 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 -\fBcurses\fP(3X), \fBcurs_pad\fP(3X), \fBcurs_refresh\fP(3X) +\fB\%curses\fP(3X), +\fB\%curs_pad\fP(3X), +\fB\%curs_refresh\fP(3X) |