diff options
Diffstat (limited to 'ncurses-5.3/doc/html/man/curs_touch.3x.html')
| -rw-r--r-- | ncurses-5.3/doc/html/man/curs_touch.3x.html | 173 |
1 files changed, 173 insertions, 0 deletions
diff --git a/ncurses-5.3/doc/html/man/curs_touch.3x.html b/ncurses-5.3/doc/html/man/curs_touch.3x.html new file mode 100644 index 0000000..eec4c7a --- /dev/null +++ b/ncurses-5.3/doc/html/man/curs_touch.3x.html @@ -0,0 +1,173 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 1998,2000 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_touch.3x,v 1.8 2000/07/08 11:07:57 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_touch 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_touch 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>touchwin</STRONG>, <STRONG>touchline</STRONG>, <STRONG>untouchwin</STRONG>, <STRONG>wtouchln</STRONG>, <STRONG>is_linetouched</STRONG>, + <STRONG>is_wintouched</STRONG> - <STRONG>curses</STRONG> refresh control routines + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + <STRONG>int</STRONG> <STRONG>touchwin(WINDOW</STRONG> <STRONG>*win);</STRONG> + <STRONG>int</STRONG> <STRONG>touchline(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>start,</STRONG> <STRONG>int</STRONG> <STRONG>count);</STRONG> + <STRONG>int</STRONG> <STRONG>untouchwin(WINDOW</STRONG> <STRONG>*win);</STRONG> + <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> + <STRONG>bool</STRONG> <STRONG>is_linetouched(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>line);</STRONG> + <STRONG>bool</STRONG> <STRONG>is_wintouched(WINDOW</STRONG> <STRONG>*win);</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>touchwin</STRONG> and <STRONG>touchline</STRONG> 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 <STRONG>touchline</STRONG> only pretends that <EM>count</EM> lines have + been changed, beginning with line <EM>start</EM>. + + The <STRONG>untouchwin</STRONG> routine marks all lines in the window as + unchanged since the last call to <STRONG>wrefresh</STRONG>. + + The <STRONG>wtouchln</STRONG> routine makes <EM>n</EM> lines in the window, starting + at line <EM>y</EM>, look as if they have (<EM>changed</EM><STRONG>=1</STRONG>) or have not + (<EM>changed</EM><STRONG>=0</STRONG>) been changed since the last call to <STRONG>wrefresh</STRONG>. + + The <STRONG>is_linetouched</STRONG> and <STRONG>is_wintouched</STRONG> routines return <STRONG>TRUE</STRONG> + if the specified line/window was modified since the last + call to <STRONG>wrefresh</STRONG>; otherwise they return <STRONG>FALSE</STRONG>. In addi- + tion, <STRONG>is_linetouched</STRONG> returns <STRONG>ERR</STRONG> if <EM>line</EM> is not valid for + the given window. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <STRONG>ERR</STRONG> upon failure and an + integer value other than <STRONG>ERR</STRONG> 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 + <STRONG>clearok(...,</STRONG> <STRONG>1)</STRONG> by saying <STRONG>touchwin(stdscr)</STRONG> or <STRONG>clear(std-</STRONG> + <STRONG>scr)</STRONG>. This will not work under ncurses. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that all routines except <STRONG>wtouchln</STRONG> may be macros. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> |