.\"***************************************************************************.\" Copyright (c) 1998,2000 Free Software Foundation, Inc.                   *.\"                                                                          *.\" Permission is hereby granted, free of charge, to any person obtaining a  *.\" copy of this software and associated documentation files (the            *.\" "Software"), to deal in the Software without restriction, including      *.\" without limitation the rights to use, copy, modify, merge, publish,      *.\" distribute, distribute with modifications, sublicense, and/or sell       *.\" copies of the Software, and to permit persons to whom the Software is    *.\" furnished to do so, subject to the following conditions:                 *.\"                                                                          *.\" The above copyright notice and this permission notice shall be included  *.\" in all copies or substantial portions of the Software.                   *.\"                                                                          *.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *.\"                                                                          *.\" Except as contained in this notice, the name(s) of the above copyright   *.\" holders shall not be used in advertising or otherwise to promote the     *.\" sale, use or other dealings in this Software without prior written       *.\" authorization.                                                           *.\"***************************************************************************.\".\" $Id: curs_touch.3x,v 1.8 2000/07/08 11:07:57 tom Exp $.TH curs_touch 3X "".SH NAME\fBtouchwin\fR,\fBtouchline\fR,\fBuntouchwin\fR,\fBwtouchln\fR,\fBis_linetouched\fR,\fBis_wintouched\fR - \fBcurses\fR refresh control routines.SH SYNOPSIS\fB#include <curses.h>\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.br.SH DESCRIPTIONThe \fBtouchwin\fR and \fBtouchline\fR routines throw away alloptimization information about which parts of the window have beentouched, by pretending that the entire window has been drawn on.  Thisis sometimes necessary when using overlapping windows, since a changeto one window affects the other window, but the records of which lineshave been changed in the other window do not reflect the change.  Theroutine \fBtouchline\fR only pretends that \fIcount\fR lines have beenchanged, beginning with line \fIstart\fR.The \fBuntouchwin\fR routine marks all lines in the window as unchanged sincethe last call to \fBwrefresh\fR.The \fBwtouchln\fR routine makes \fIn\fR lines in the window, startingat line \fIy\fR, look as if they have (\fIchanged\fR\fB=1\fR) or havenot (\fIchanged\fR\fB=0\fR) been changed since the last call to\fBwrefresh\fR.The \fBis_linetouched\fR and \fBis_wintouched\fR routines return\fBTRUE\fR if the specified line/window was modified since the lastcall to \fBwrefresh\fR; otherwise they return \fBFALSE\fR.  Inaddition, \fBis_linetouched\fR returns \fBERR\fR if \fIline\fR is notvalid for the given window..SH RETURN VALUEAll routines return the integer \fBERR\fR upon failure and an integer valueother than \fBERR\fR upon successful completion, unless otherwise noted in thepreceding routine descriptions..SH PORTABILITYThe XSI Curses standard, Issue 4 describes these functions.Some historic curses implementations had, as an undocumented feature, theability to do the equivalent of \fBclearok(..., 1)\fR by saying\fBtouchwin(stdscr)\fR or \fBclear(stdscr)\fR.  This will not work underncurses..SH NOTESNote that all routines except \fBwtouchln\fR may be macros..SH SEE ALSO\fBcurses\fR(3X), \fBcurs_refresh\fR(3X)..\"#.\"# The following sets edit modes for GNU EMACS.\"# Local Variables:.\"# mode:nroff.\"# fill-column:79.\"# End: