X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=man%2Fcurs_touch.3x;h=e1faa612e4f0a05f75c9b8724aab188489ab0e96;hb=aef6681d538d4bd02cfdf9f52aeefec62488efd6;hp=e53207896529db531f2c0e697e729f8ec7785492;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280;p=ncurses.git diff --git a/man/curs_touch.3x b/man/curs_touch.3x index e5320789..e1faa612 100644 --- a/man/curs_touch.3x +++ b/man/curs_touch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018,2020 Thomas E. Dickey * +.\" Copyright 2018-2022,2023 Thomas E. Dickey * .\" Copyright 1998-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,36 +27,35 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_touch.3x,v 1.22 2020/02/02 23:34:34 tom Exp $ -.TH curs_touch 3X "" +.\" $Id: curs_touch.3x,v 1.30 2023/07/01 15:46:10 tom Exp $ +.TH curs_touch 3X 2023-07-01 "ncurses 6.4" "Library calls" .na .hy 0 .SH NAME -\fBtouchwin\fR, -\fBtouchline\fR, -\fBuntouchwin\fR, -\fBwtouchln\fR, -\fBis_linetouched\fR, -\fBis_wintouched\fR \- \fBcurses\fR refresh control routines +\fBtouchwin\fP, +\fBtouchline\fP, +\fBuntouchwin\fP, +\fBwtouchln\fP, +\fBis_linetouched\fP, +\fBis_wintouched\fP \- \fBcurses\fP refresh control routines .ad .hy .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBint touchline(WINDOW *\fIwin\fB, int \fIstart\fB, int \fIcount\fB);\fR +.sp +\fBint touchwin(WINDOW *\fIwin\fB);\fR .br -\fBint touchwin(WINDOW *win);\fR -.br -\fBint touchline(WINDOW *win, int start, int count);\fR -.br -\fBint untouchwin(WINDOW *win);\fR -.br -\fBint wtouchln(WINDOW *win, int y, int n, int changed);\fR -.br -\fBbool is_linetouched(WINDOW *win, int line);\fR -.br -\fBbool is_wintouched(WINDOW *win);\fR +\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 .SH DESCRIPTION -The \fBtouchwin\fR and \fBtouchline\fR routines throw away all +The \fBtouchwin\fP and \fBtouchline\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 @@ -64,25 +63,25 @@ 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\fR only pretends that \fIcount\fR lines have been -changed, beginning with line \fIstart\fR. +routine \fBtouchline\fP only pretends that \fIcount\fP lines have been +changed, beginning with line \fIstart\fP. .PP -The \fBuntouchwin\fR routine marks all lines in the window as unchanged since -the last call to \fBwrefresh\fR. +The \fBuntouchwin\fP routine marks all lines in the window as unchanged since +the last call to \fBwrefresh\fP. .PP -The \fBwtouchln\fR routine makes \fIn\fR lines in the window, starting -at line \fIy\fR, look as if they have (\fIchanged\fR\fB=1\fR) or have -not (\fIchanged\fR\fB=0\fR) been changed since the last call to -\fBwrefresh\fR. +The \fBwtouchln\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. .PP -The \fBis_linetouched\fR and \fBis_wintouched\fR routines return -\fBTRUE\fR if the specified line/window was modified since the last -call to \fBwrefresh\fR; otherwise they return \fBFALSE\fR. In -addition, \fBis_linetouched\fR returns \fBERR\fR if \fIline\fR is not +The \fBis_linetouched\fP and \fBis_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 valid for the given window. .SH RETURN VALUE -All routines return the integer \fBERR\fR upon failure and an integer value -other than \fBERR\fR upon successful completion, unless otherwise noted in the +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. @@ -90,7 +89,7 @@ In this implementation .RS 3 .TP 5 \fBis_linetouched\fP -returns an error +returns an error if the window pointer is null, or if the line number is outside the window. .IP @@ -105,12 +104,11 @@ the \fBERR\fP is provided by a macro named \fBis_linetouched\fP. The actual function returns \fBFALSE\fP when it detects an error. .TP 5 \fBwtouchln\fP -returns an error +returns an error if the window pointer is null, or if the line number is outside the window. .RE .SH PORTABILITY -.PP These functions were introduced by SVr4. The Solaris curses header file, for instance, defines both an actual function and macro for each. @@ -122,8 +120,8 @@ otherwise this implementation behaves the same as SVr4. The XSI Curses standard, Issue 4 describes these functions, but defines no error conditions. .SH NOTES -All of these routines except \fBwtouchln\fR may be macros. +All of these routines except \fBwtouchln\fP may be macros. .SH SEE ALSO -\fBcurses\fR(3X), -\fBcurs_refresh\fR(3X), -\fBcurs_variables\fR(3X). +\fBcurses\fP(3X), +\fBcurs_refresh\fP(3X), +\fBcurs_variables\fP(3X).