.\"***************************************************************************
-.\" Copyright 2018-2022,2023 Thomas E. Dickey *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey *
.\" Copyright 1998-2015,2017 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_touch.3x,v 1.34 2023/09/16 23:37:03 tom Exp $
-.TH curs_touch 3X 2023-09-16 "ncurses 6.4" "Library calls"
+.\" $Id: curs_touch.3x,v 1.47 2024/04/20 21:20:07 tom Exp $
+.TH curs_touch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
.SH NAME
\fB\%touchwin\fP,
\fB\%touchline\fP,
\fB\%is_wintouched\fP \-
control terminal output refresh in a \fIcurses\fR window
.SH SYNOPSIS
-\fB#include <curses.h>\fP
-.sp
-\fBint touchline(WINDOW *\fIwin\fB, int \fIstart\fB, int \fIcount\fB);\fR
-.sp
-\fBint touchwin(WINDOW *\fIwin\fB);\fR
-.br
-\fBint wtouchln(WINDOW *\fIwin\fB, int \fIy\fB, int \fIn\fB, int \fIchanged\fB);\fR
-.sp
-\fBint untouchwin(WINDOW *\fIwin\fB);\fR
-.sp
-\fBbool is_linetouched(WINDOW *\fIwin\fB, int \fIline\fB);\fR
-.br
-\fBbool is_wintouched(WINDOW *\fIwin\fB);\fR
+.nf
+\fB#include <curses.h>
+.PP
+\fBint touchline(WINDOW *\fIwin\fP, int \fIstart\fP, int \fIcount\fP);
+.PP
+\fBint touchwin(WINDOW *\fIwin\fP);
+\fBint wtouchln(WINDOW *\fIwin\fP, int \fIy\fP, int \fIn\fP, int \fIchanged\fP);
+.PP
+\fBint untouchwin(WINDOW *\fIwin\fP);
+.PP
+\fBbool is_linetouched(WINDOW *\fIwin\fP, int \fIline\fP);
+\fBbool is_wintouched(WINDOW *\fIwin\fP);
+.fi
.SH DESCRIPTION
-The \fBtouchwin\fP and \fBtouchline\fP routines throw away all
+The \fB\%touchwin\fP and \fB\%touchline\fP routines throw away all
optimization information about which parts of the window have been
touched, by pretending that the entire window has been drawn on.
This
to one window affects the other window, but the records of which lines
have been changed in the other window do not reflect the change.
The
-routine \fBtouchline\fP only pretends that \fIcount\fP lines have been
+routine \fB\%touchline\fP only pretends that \fIcount\fP lines have been
changed, beginning with line \fIstart\fP.
.PP
-The \fBuntouchwin\fP routine marks all lines in the window as unchanged since
-the last call to \fBwrefresh\fP.
+The \fB\%untouchwin\fP routine marks all lines in the window as unchanged since
+the last call to \fB\%wrefresh\fP.
.PP
-The \fBwtouchln\fP routine makes \fIn\fP lines in the window, starting
+The \fB\%wtouchln\fP routine makes \fIn\fP lines in the window, starting
at line \fIy\fR, look as if they have (\fIchanged\fB=1\fR) or have
not (\fIchanged\fB=0\fR) been changed since the last call to
-\fBwrefresh\fP.
+\fB\%wrefresh\fP.
.PP
-The \fBis_linetouched\fP and \fBis_wintouched\fP routines return
+The \fB\%is_linetouched\fP and \fB\%is_wintouched\fP routines return
\fBTRUE\fP if the specified line/window was modified since the last
-call to \fBwrefresh\fP; otherwise they return \fBFALSE\fP. In
-addition, \fBis_linetouched\fP returns \fBERR\fP if \fIline\fP is not
+call to \fB\%wrefresh\fP; otherwise they return \fBFALSE\fP. In
+addition, \fB\%is_linetouched\fP returns \fBERR\fP if \fIline\fP is not
valid for the given window.
.SH RETURN VALUE
All routines return the integer \fBERR\fP upon failure and an integer value
other than \fBERR\fP upon successful completion, unless otherwise noted in the
preceding routine descriptions.
.PP
-X/Open does not define any error conditions.
+X/Open Curses does not specify any error conditions.
In this implementation
.RS 3
.TP 5
\fBis_linetouched\fP
returns an error
if the window pointer is null, or
-if the line number is outside the window.
+if the line number is outside the window boundaries.
.IP
The constant \fBERR\fP is distinct from \fBTRUE\fP and \fBFALSE\fP,
which are the normal return values of this function.
may not be supported by the compiler.
.IP
To provide error-checking and also match the X/Open function prototype,
-the \fBERR\fP is provided by a macro named \fBis_linetouched\fP.
+the \fBERR\fP is provided by a macro named \fB\%is_linetouched\fP.
The actual function returns \fBFALSE\fP when it detects an error.
.TP 5
\fBwtouchln\fP
returns an error
if the window pointer is null, or
-if the line number is outside the window.
+if the line number is outside the window boundaries.
.RE
+.SH NOTES
+All of these routines except \fB\%wtouchln\fP may be macros.
.SH PORTABILITY
These functions were introduced by SVr4.
-The Solaris curses header file,
+The Solaris \fIcurses\fP header file,
for instance, defines both an actual function and macro for each.
The macros give the same result as the actual functions.
-SVr4 curses does not check the window parameter \fIwin\fP to ensure
+SVr4 \fIcurses\fP does not check the window parameter \fIwin\fP to ensure
that it is not \fBNULL\fP;
otherwise this implementation behaves the same as SVr4.
.PP
-The XSI Curses standard, Issue 4 describes these functions,
+X/Open Curses, Issue 4 describes these functions,
but defines no error conditions.
-.SH NOTES
-All of these routines except \fBwtouchln\fP may be macros.
.SH SEE ALSO
-\fBcurses\fP(3X),
-\fBcurs_refresh\fP(3X),
-\fBcurs_variables\fP(3X).
+\fB\%curses\fP(3X),
+\fB\%curs_refresh\fP(3X),
+\fB\%curs_variables\fP(3X)
projects / ncurses.git / blobdiff