2 ****************************************************************************
3 * Copyright (c) 1998-2017,2018 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************
29 * @Id: curs_touch.3x,v 1.21 2018/07/28 21:34:56 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_touch 3x</TITLE>
37 <link rel="author" href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 <H1 class="no-header">curs_touch 3x</H1>
43 <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49 <STRONG>touchwin</STRONG>, <STRONG>touchline</STRONG>, <STRONG>untouchwin</STRONG>, <STRONG>wtouchln</STRONG>, <STRONG>is_linetouched</STRONG>,
50 <STRONG>is_wintouched</STRONG> - <STRONG>curses</STRONG> refresh control routines
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
55 <STRONG>int</STRONG> <STRONG>touchwin(WINDOW</STRONG> <STRONG>*win);</STRONG>
56 <STRONG>int</STRONG> <STRONG>touchline(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>start,</STRONG> <STRONG>int</STRONG> <STRONG>count);</STRONG>
57 <STRONG>int</STRONG> <STRONG>untouchwin(WINDOW</STRONG> <STRONG>*win);</STRONG>
58 <STRONG>int</STRONG> <STRONG>wtouchln(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>n,</STRONG> <STRONG>int</STRONG> <STRONG>changed);</STRONG>
59 <STRONG>bool</STRONG> <STRONG>is_linetouched(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>line);</STRONG>
60 <STRONG>bool</STRONG> <STRONG>is_wintouched(WINDOW</STRONG> <STRONG>*win);</STRONG>
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64 The <STRONG>touchwin</STRONG> and <STRONG>touchline</STRONG> routines throw away all optimization infor-
65 mation about which parts of the window have been touched, by pretending
66 that the entire window has been drawn on. This is sometimes necessary
67 when using overlapping windows, since a change to one window affects
68 the other window, but the records of which lines have been changed in
69 the other window do not reflect the change. The routine <STRONG>touchline</STRONG> only
70 pretends that <EM>count</EM> lines have been changed, beginning with line <EM>start</EM>.
72 The <STRONG>untouchwin</STRONG> routine marks all lines in the window as unchanged since
73 the last call to <STRONG>wrefresh</STRONG>.
75 The <STRONG>wtouchln</STRONG> routine makes <EM>n</EM> lines in the window, starting at line <EM>y</EM>,
76 look as if they have (<EM>changed</EM><STRONG>=1</STRONG>) or have not (<EM>changed</EM><STRONG>=0</STRONG>) been changed
77 since the last call to <STRONG>wrefresh</STRONG>.
79 The <STRONG>is_linetouched</STRONG> and <STRONG>is_wintouched</STRONG> routines return <STRONG>TRUE</STRONG> if the speci-
80 fied line/window was modified since the last call to <STRONG>wrefresh</STRONG>; other-
81 wise they return <STRONG>FALSE</STRONG>. In addition, <STRONG>is_linetouched</STRONG> returns <STRONG>ERR</STRONG> if
82 <EM>line</EM> is not valid for the given window.
85 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
86 All routines return the integer <STRONG>ERR</STRONG> upon failure and an integer value
87 other than <STRONG>ERR</STRONG> upon successful completion, unless otherwise noted in
88 the preceding routine descriptions.
90 X/Open does not define any error conditions. In this implementation
92 <STRONG>is_linetouched</STRONG>
93 returns an error if the window pointer is null, or if the line
94 number is outside the window.
96 The constant <STRONG>ERR</STRONG> is distinct from <STRONG>TRUE</STRONG> and <STRONG>FALSE</STRONG>, which are the
97 normal return values of this function. Because the function
98 returns a <STRONG>bool</STRONG>, returning <STRONG>ERR</STRONG> (which is neither <STRONG>TRUE</STRONG> nor <STRONG>FALSE</STRONG>)
99 may not be supported by the compiler.
101 To provide error-checking and also match the X/Open function
102 prototype, the <STRONG>ERR</STRONG> is provided by a macro named <STRONG>is_linetouched</STRONG>.
103 The actual function returns <STRONG>FALSE</STRONG> when it detects an error.
105 <STRONG>wtouchln</STRONG>
106 returns an error if the window pointer is null, or if the line
107 number is outside the window.
110 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
111 These functions were introduced by SVr4. The Solaris curses header
112 file, for instance, defines both an actual function and macro for each.
113 The macros give the same result as the actual functions. SVr4 curses
114 does not check the window parameter <EM>win</EM> to ensure that it is not <STRONG>NULL</STRONG>;
115 otherwise this implementation behaves the same as SVr4.
117 The XSI Curses standard, Issue 4 describes these functions, but defines
121 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
122 All of these routines except <STRONG>wtouchln</STRONG> may be macros.
125 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
126 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
130 <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>
134 <li><a href="#h2-NAME">NAME</a></li>
135 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
136 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
137 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
138 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
139 <li><a href="#h2-NOTES">NOTES</a></li>
140 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>