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