e1d130d30368b49c6cf208b890884d49f479dcdc
[ncurses.git] / man / curs_touch.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_touch.3x,v 1.6 1998/03/11 21:12:53 juergen Exp $
30 .TH curs_touch 3X ""
31 .SH NAME
32 \fBtouchwin\fR, \fBtouchline\fR, \fBuntouchwin\fR,
33 \fBwtouchln\fR, \fBis_linetouched\fR, \fBis_wintouched\fR -
34 \fBcurses\fR refresh control routines
35 .SH SYNOPSIS
36 \fB#include <curses.h>\fR
37 .br
38 \fBint touchwin(WINDOW *win);\fR
39 .br
40 \fBint touchline(WINDOW *win, int start, int count);\fR
41 .br
42 \fBint untouchwin(WINDOW *win);\fR
43 .br
44 \fBint wtouchln(WINDOW *win, int y, int n, int changed);\fR
45 .br
46 \fBint is_linetouched(WINDOW *win, int line);\fR
47 .br
48 \fBint is_wintouched(WINDOW *win);\fR
49 .br
50 .SH DESCRIPTION
51 The \fBtouchwin\fR and \fBtouchline\fR routines throw away all
52 optimization information about which parts of the window have been
53 touched, by pretending that the entire window has been drawn on.  This
54 is sometimes necessary when using overlapping windows, since a change
55 to one window affects the other window, but the records of which lines
56 have been changed in the other window do not reflect the change.  The
57 routine \fBtouchline\fR only pretends that \fIcount\fR lines have been
58 changed, beginning with line \fIstart\fR.
59
60 The \fBuntouchwin\fR routine marks all lines in the window as unchanged since
61 the last call to \fBwrefresh\fR.
62
63 The \fBwtouchln\fR routine makes \fIn\fR lines in the window, starting
64 at line \fIy\fR, look as if they have (\fIchanged\fR\fB=1\fR) or have
65 not (\fIchanged\fR\fB=0\fR) been changed since the last call to
66 \fBwrefresh\fR.
67
68 The \fBis_linetouched\fR and \fBis_wintouched\fR routines return
69 \fBTRUE\fR if the specified line/window was modified since the last
70 call to \fBwrefresh\fR; otherwise they return \fBFALSE\fR.  In
71 addition, \fBis_linetouched\fR returns \fBERR\fR if \fIline\fR is not
72 valid for the given window.
73 .SH RETURN VALUE
74 All routines return the integer \fBERR\fR upon failure and an integer value
75 other than \fBERR\fR upon successful completion, unless otherwise noted in the
76 preceding routine descriptions.
77 .SH PORTABILITY
78 The XSI Curses standard, Issue 4 describes these functions.
79
80 Some historic curses implementations had, as an undocumented feature, the
81 ability to do the equivalent of \fBclearok(..., 1)\fR by saying
82 \fBtouchwin(stdscr)\fR or \fBclear(stdscr)\fR.  This will not work under
83 ncurses.
84 .SH NOTES
85 Note that all routines except \fBwtouchln\fR may be macros.
86 .SH SEE ALSO
87 \fBcurses\fR(3X), \fBcurs_refresh\fR(3X).
88 .\"#
89 .\"# The following sets edit modes for GNU EMACS
90 .\"# Local Variables:
91 .\"# mode:nroff
92 .\"# fill-column:79
93 .\"# End: