ncurses 6.0 - patch 20151205
[ncurses.git] / doc / html / man / curs_touch.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
4   *                                                                          *
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:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
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.                               *
23   *                                                                          *
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       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_touch.3x,v 1.16 2015/12/05 23:43:00 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_touch 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_touch 3x</H1>
42 <PRE>
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>
44
45
46
47
48 </PRE>
49 <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> - <STRONG>curses</STRONG> refresh control routines
52
53
54 </PRE>
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57        <STRONG>int</STRONG> <STRONG>touchwin(WINDOW</STRONG> <STRONG>*win);</STRONG>
58        <STRONG>int</STRONG> <STRONG>touchline(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>start,</STRONG> <STRONG>int</STRONG> <STRONG>count);</STRONG>
59        <STRONG>int</STRONG> <STRONG>untouchwin(WINDOW</STRONG> <STRONG>*win);</STRONG>
60        <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>
61        <STRONG>bool</STRONG> <STRONG>is_linetouched(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>line);</STRONG>
62        <STRONG>bool</STRONG> <STRONG>is_wintouched(WINDOW</STRONG> <STRONG>*win);</STRONG>
63
64
65 </PRE>
66 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67        The <STRONG>touchwin</STRONG> and <STRONG>touchline</STRONG> routines throw away  all  opti-
68        mization  information about which parts of the window have
69        been touched, by pretending that  the  entire  window  has
70        been  drawn  on.   This  is sometimes necessary when using
71        overlapping windows, since a change to one window  affects
72        the other window, but the records of which lines have been
73        changed in the other window do  not  reflect  the  change.
74        The  routine <STRONG>touchline</STRONG> only pretends that <EM>count</EM> lines have
75        been changed, beginning with line <EM>start</EM>.
76
77        The <STRONG>untouchwin</STRONG> routine marks all lines in  the  window  as
78        unchanged since the last call to <STRONG>wrefresh</STRONG>.
79
80        The <STRONG>wtouchln</STRONG> routine makes <EM>n</EM> lines in the window, starting
81        at line <EM>y</EM>, look as if they have (<EM>changed</EM><STRONG>=1</STRONG>)  or  have  not
82        (<EM>changed</EM><STRONG>=0</STRONG>) been changed since the last call to <STRONG>wrefresh</STRONG>.
83
84        The  <STRONG>is_linetouched</STRONG> and <STRONG>is_wintouched</STRONG> routines return <STRONG>TRUE</STRONG>
85        if the specified line/window was modified since  the  last
86        call  to  <STRONG>wrefresh</STRONG>; otherwise they return <STRONG>FALSE</STRONG>.  In addi-
87        tion, <STRONG>is_linetouched</STRONG> returns <STRONG>ERR</STRONG> if <EM>line</EM> is not valid  for
88        the given window.
89
90
91 </PRE>
92 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
93        All  routines  return  the integer <STRONG>ERR</STRONG> upon failure and an
94        integer value other than <STRONG>ERR</STRONG> upon  successful  completion,
95        unless  otherwise  noted in the preceding routine descrip-
96        tions.
97
98        X/Open does not define any error conditions.  In this  im-
99        plementation
100
101               <STRONG>is_linetouched</STRONG>
102                    returns  an  error  if  the  window pointer is
103                    null, or if the line  number  is  outside  the
104                    window.   Note  that ERR is distinct from <STRONG>TRUE</STRONG>
105                    and <STRONG>FALSE</STRONG>, which are the normal return  values
106                    of this function.
107
108               <STRONG>wtouchln</STRONG>
109                    returns  an  error  if  the  window pointer is
110                    null, or if the line  number  is  outside  the
111                    window.
112
113
114 </PRE>
115 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
116        The  XSI  Curses  standard,  Issue 4 describes these func-
117        tions.
118
119        Some historic curses implementations had,  as  an  undocu-
120        mented  feature,  the  ability  to  do  the  equivalent of
121        <STRONG>clearok(...,</STRONG> <STRONG>1)</STRONG> by saying <STRONG>touchwin(stdscr)</STRONG>  or  <STRONG>clear(std-</STRONG>
122        <STRONG>scr)</STRONG>.  This will not work under ncurses.
123
124
125 </PRE>
126 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
127        Note that all routines except <STRONG>wtouchln</STRONG> may be macros.
128
129
130 </PRE>
131 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
132        <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>.
133
134
135
136                                                          <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>
137 </PRE>
138 <div class="nav">
139 <ul>
140 <li><a href="#h2-NAME">NAME</a></li>
141 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
142 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
143 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
144 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
145 <li><a href="#h2-NOTES">NOTES</a></li>
146 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
147 </ul>
148 </div>
149 </BODY>
150 </HTML>