summaryrefslogtreecommitdiffstats
path: root/ncurses-5.2/doc/html/man/curs_touch.3x.html
blob: 198fc85237c13a95ea7959c0374a81d7223e9f2b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<HTML>
<BODY>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->

</PRE>
<H2>NAME</H2><PRE>
       <B>touchwin</B>, <B>touchline</B>, <B>untouchwin</B>, <B>wtouchln</B>, <B>is_linetouched</B>,
       <B>is_wintouched</B> - <B>curses</B> refresh control routines


</PRE>
<H2>SYNOPSIS</H2><PRE>
       <B>#include</B> <B>&lt;curses.h&gt;</B>
       <B>int</B> <B>touchwin(WINDOW</B> <B>*win);</B>
       <B>int</B> <B>touchline(WINDOW</B> <B>*win,</B> <B>int</B> <B>start,</B> <B>int</B> <B>count);</B>
       <B>int</B> <B>untouchwin(WINDOW</B> <B>*win);</B>
       <B>int</B> <B>wtouchln(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>n,</B> <B>int</B> <B>changed);</B>
       <B>bool</B> <B>is_linetouched(WINDOW</B> <B>*win,</B> <B>int</B> <B>line);</B>
       <B>bool</B> <B>is_wintouched(WINDOW</B> <B>*win);</B>


</PRE>
<H2>DESCRIPTION</H2><PRE>
       The <B>touchwin</B> and <B>touchline</B> routines throw away  all  opti-
       mization  information about which parts of the window have
       been touched, by pretending that  the  entire  window  has
       been  drawn  on.   This  is sometimes necessary when using
       overlapping windows, since a change to one window  affects
       the other window, but the records of which lines have been
       changed in the other window do  not  reflect  the  change.
       The  routine <B>touchline</B> only pretends that <I>count</I> lines have
       been changed, beginning with line <I>start</I>.

       The <B>untouchwin</B> routine marks all lines in  the  window  as
       unchanged since the last call to <B>wrefresh</B>.

       The <B>wtouchln</B> routine makes <I>n</I> lines in the window, starting
       at line <I>y</I>, look as if they have (<I>changed</I><B>=1</B>)  or  have  not
       (<I>changed</I><B>=0</B>)  been changed since the last call to <B>wrefresh</B>.

       The <B>is_linetouched</B> and <B>is_wintouched</B> routines return  <B>TRUE</B>
       if  the  specified line/window was modified since the last
       call to <B>wrefresh</B>; otherwise they return <B>FALSE</B>.   In  addi-
       tion,  <B>is_linetouched</B> returns <B>ERR</B> if <I>line</I> is not valid for
       the given window.


</PRE>
<H2>RETURN VALUE</H2><PRE>
       All routines return the integer <B>ERR</B> upon  failure  and  an
       integer  value  other than <B>ERR</B> upon successful completion,
       unless otherwise noted in the preceding  routine  descrip-
       tions.


</PRE>
<H2>PORTABILITY</H2><PRE>
       The  XSI  Curses  standard,  Issue 4 describes these func-
       tions.

       Some historic curses implementations had,  as  an  undocu-
       mented  feature,  the  ability  to  do  the  equivalent of
       <B>clearok(...,</B> <B>1)</B> by saying <B>touchwin(stdscr)</B>  or  <B>clear(std-</B>
       <B>scr)</B>.  This will not work under ncurses.


</PRE>
<H2>NOTES</H2><PRE>
       Note that all routines except <B>wtouchln</B> may be macros.


</PRE>
<H2>SEE ALSO</H2><PRE>
       <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>.




















































</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>