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

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   ****************************************************************************
   4   * Copyright (c) 1998,2000 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.8 2000/07/08 11:07:57 tom Exp @
  31 -->
  32 <HTML>
  33 <HEAD>
  34 <TITLE>curs_touch 3x</TITLE>
  35 <link rev=made href="mailto:bug-ncurses@gnu.org">
  36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  37 </HEAD>
  38 <BODY>
  39 <H1>curs_touch 3x</H1>
  40 <HR>
  41 <PRE>
  42 <!-- Manpage converted by man2html 3.0.1 -->
  43
  44 </PRE>
  45 <H2>NAME</H2><PRE>
  46        <STRONG>touchwin</STRONG>, <STRONG>touchline</STRONG>, <STRONG>untouchwin</STRONG>, <STRONG>wtouchln</STRONG>, <STRONG>is_linetouched</STRONG>,
  47        <STRONG>is_wintouched</STRONG> - <STRONG>curses</STRONG> refresh control routines
  48
  49
  50 </PRE>
  51 <H2>SYNOPSIS</H2><PRE>
  52        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  53        <STRONG>int</STRONG> <STRONG>touchwin(WINDOW</STRONG> <STRONG>*win);</STRONG>
  54        <STRONG>int</STRONG> <STRONG>touchline(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>start,</STRONG> <STRONG>int</STRONG> <STRONG>count);</STRONG>
  55        <STRONG>int</STRONG> <STRONG>untouchwin(WINDOW</STRONG> <STRONG>*win);</STRONG>
  56        <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>
  57        <STRONG>bool</STRONG> <STRONG>is_linetouched(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>line);</STRONG>
  58        <STRONG>bool</STRONG> <STRONG>is_wintouched(WINDOW</STRONG> <STRONG>*win);</STRONG>
  59
  60
  61 </PRE>
  62 <H2>DESCRIPTION</H2><PRE>
  63        The <STRONG>touchwin</STRONG> and <STRONG>touchline</STRONG> routines throw away  all  opti-
  64        mization  information about which parts of the window have
  65        been touched, by pretending that  the  entire  window  has
  66        been  drawn  on.   This  is sometimes necessary when using
  67        overlapping windows, since a change to one window  affects
  68        the other window, but the records of which lines have been
  69        changed in the other window do  not  reflect  the  change.
  70        The  routine <STRONG>touchline</STRONG> only pretends that <EM>count</EM> lines have
  71        been changed, beginning with line <EM>start</EM>.
  72
  73        The <STRONG>untouchwin</STRONG> routine marks all lines in  the  window  as
  74        unchanged since the last call to <STRONG>wrefresh</STRONG>.
  75
  76        The <STRONG>wtouchln</STRONG> routine makes <EM>n</EM> lines in the window, starting
  77        at line <EM>y</EM>, look as if they have (<EM>changed</EM><STRONG>=1</STRONG>)  or  have  not
  78        (<EM>changed</EM><STRONG>=0</STRONG>)  been changed since the last call to <STRONG>wrefresh</STRONG>.
  79
  80        The <STRONG>is_linetouched</STRONG> and <STRONG>is_wintouched</STRONG> routines return  <STRONG>TRUE</STRONG>
  81        if  the  specified line/window was modified since the last
  82        call to <STRONG>wrefresh</STRONG>; otherwise they return <STRONG>FALSE</STRONG>.   In  addi-
  83        tion,  <STRONG>is_linetouched</STRONG> returns <STRONG>ERR</STRONG> if <EM>line</EM> is not valid for
  84        the given window.
  85
  86
  87 </PRE>
  88 <H2>RETURN VALUE</H2><PRE>
  89        All routines return the integer <STRONG>ERR</STRONG> upon  failure  and  an
  90        integer  value  other than <STRONG>ERR</STRONG> upon successful completion,
  91        unless otherwise noted in the preceding  routine  descrip-
  92        tions.
  93
  94
  95 </PRE>
  96 <H2>PORTABILITY</H2><PRE>
  97        The  XSI  Curses  standard,  Issue 4 describes these func-
  98        tions.
  99
 100        Some historic curses implementations had,  as  an  undocu-
 101        mented  feature,  the  ability  to  do  the  equivalent of
 102        <STRONG>clearok(...,</STRONG> <STRONG>1)</STRONG> by saying <STRONG>touchwin(stdscr)</STRONG>  or  <STRONG>clear(std-</STRONG>
 103        <STRONG>scr)</STRONG>.  This will not work under ncurses.
 104
 105
 106 </PRE>
 107 <H2>NOTES</H2><PRE>
 108        Note that all routines except <STRONG>wtouchln</STRONG> may be macros.
 109
 110
 111 </PRE>
 112 <H2>SEE ALSO</H2><PRE>
 113        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>.
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166 </PRE>
 167 <HR>
 168 <ADDRESS>
 169 Man(1) output converted with
 170 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 171 </ADDRESS>
 172 </BODY>
 173 </HTML>