doc/html/man/curs_touch.3x.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4 <!-- Manpage converted by man2html 3.0.1 -->
   5
   6 </PRE>
   7 <H2>NAME</H2><PRE>
   8        <B>touchwin</B>, <B>touchline</B>, <B>untouchwin</B>, <B>wtouchln</B>, <B>is_linetouched</B>,
   9        <B>is_wintouched</B> - <B>curses</B> refresh control routines
  10
  11
  12 </PRE>
  13 <H2>SYNOPSIS</H2><PRE>
  14        <B>#include</B> <B>&lt;curses.h&gt;</B>
  15        <B>int</B> <B>touchwin(WINDOW</B> <B>*win);</B>
  16        <B>int</B> <B>touchline(WINDOW</B> <B>*win,</B> <B>int</B> <B>start,</B> <B>int</B> <B>count);</B>
  17        <B>int</B> <B>untouchwin(WINDOW</B> <B>*win);</B>
  18        <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>
  19        <B>bool</B> <B>is_linetouched(WINDOW</B> <B>*win,</B> <B>int</B> <B>line);</B>
  20        <B>bool</B> <B>is_wintouched(WINDOW</B> <B>*win);</B>
  21
  22
  23 </PRE>
  24 <H2>DESCRIPTION</H2><PRE>
  25        The <B>touchwin</B> and <B>touchline</B> routines throw away  all  opti-
  26        mization  information about which parts of the window have
  27        been touched, by pretending that  the  entire  window  has
  28        been  drawn  on.   This  is sometimes necessary when using
  29        overlapping windows, since a change to one window  affects
  30        the other window, but the records of which lines have been
  31        changed in the other window do  not  reflect  the  change.
  32        The  routine <B>touchline</B> only pretends that <I>count</I> lines have
  33        been changed, beginning with line <I>start</I>.
  34
  35        The <B>untouchwin</B> routine marks all lines in  the  window  as
  36        unchanged since the last call to <B>wrefresh</B>.
  37
  38        The <B>wtouchln</B> routine makes <I>n</I> lines in the window, starting
  39        at line <I>y</I>, look as if they have (<I>changed</I><B>=1</B>)  or  have  not
  40        (<I>changed</I><B>=0</B>)  been changed since the last call to <B>wrefresh</B>.
  41
  42        The <B>is_linetouched</B> and <B>is_wintouched</B> routines return  <B>TRUE</B>
  43        if  the  specified line/window was modified since the last
  44        call to <B>wrefresh</B>; otherwise they return <B>FALSE</B>.   In  addi-
  45        tion,  <B>is_linetouched</B> returns <B>ERR</B> if <I>line</I> is not valid for
  46        the given window.
  47
  48
  49 </PRE>
  50 <H2>RETURN VALUE</H2><PRE>
  51        All routines return the integer <B>ERR</B> upon  failure  and  an
  52        integer  value  other than <B>ERR</B> upon successful completion,
  53        unless otherwise noted in the preceding  routine  descrip-
  54        tions.
  55
  56
  57 </PRE>
  58 <H2>PORTABILITY</H2><PRE>
  59        The  XSI  Curses  standard,  Issue 4 describes these func-
  60        tions.
  61
  62        Some historic curses implementations had,  as  an  undocu-
  63        mented  feature,  the  ability  to  do  the  equivalent of
  64        <B>clearok(...,</B> <B>1)</B> by saying <B>touchwin(stdscr)</B>  or  <B>clear(std-</B>
  65        <B>scr)</B>.  This will not work under ncurses.
  66
  67
  68 </PRE>
  69 <H2>NOTES</H2><PRE>
  70        Note that all routines except <B>wtouchln</B> may be macros.
  71
  72
  73 </PRE>
  74 <H2>SEE ALSO</H2><PRE>
  75        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>.
  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 </PRE>
 129 <HR>
 130 <ADDRESS>
 131 Man(1) output converted with
 132 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 133 </ADDRESS>
 134 </BODY>
 135 </HTML>