]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/curs_touch.3x
ncurses 6.4 - patch 20230923
[ncurses.git] / man / curs_touch.3x
index 46270aba32d6850ed66b225c1c11d5af4eabce0c..72bcb6aae23e2bb4f5e05d672cb8208563e5d027 100644 (file)
@@ -27,8 +27,8 @@
 .\" 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.39 2023/09/23 22:49:51 tom Exp $
+.TH curs_touch 3X 2023-09-23 "ncurses 6.4" "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
+.nf
 \fB#include <curses.h>\fP
-.sp
+.PP
 \fBint touchline(WINDOW *\fIwin\fB, int \fIstart\fB, int \fIcount\fB);\fR
-.sp
+.PP
 \fBint touchwin(WINDOW *\fIwin\fB);\fR
-.br
 \fBint wtouchln(WINDOW *\fIwin\fB, int \fIy\fB, int \fIn\fB, int \fIchanged\fB);\fR
-.sp
+.PP
 \fBint untouchwin(WINDOW *\fIwin\fB);\fR
-.sp
+.PP
 \fBbool is_linetouched(WINDOW *\fIwin\fB, int \fIline\fB);\fR
-.br
 \fBbool is_wintouched(WINDOW *\fIwin\fB);\fR
+.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
@@ -60,21 +60,21 @@ is sometimes necessary when using overlapping windows, since a change
 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
@@ -97,7 +97,7 @@ returning \fBERR\fP (which is neither \fBTRUE\fP nor \fBFALSE\fP)
 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
@@ -107,18 +107,18 @@ if the line number is outside the window.
 .RE
 .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,
 but defines no error conditions.
 .SH NOTES
-All of these routines except \fBwtouchln\fP may be macros.
+All of these routines except \fB\%wtouchln\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)