diff options
Diffstat (limited to 'doc/html/man/curs_touch.3x.html')
-rw-r--r-- | doc/html/man/curs_touch.3x.html | 78 |
1 files changed, 40 insertions, 38 deletions
diff --git a/doc/html/man/curs_touch.3x.html b/doc/html/man/curs_touch.3x.html index 55eb33ea1525..50717662864c 100644 --- a/doc/html/man/curs_touch.3x.html +++ b/doc/html/man/curs_touch.3x.html @@ -1,6 +1,6 @@ -<!-- +<!-- **************************************************************************** - * Copyright 2018,2020 Thomas E. Dickey * + * Copyright 2018-2023,2024 Thomas E. Dickey * * Copyright 1998-2015,2017 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,28 +27,28 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_touch.3x,v 1.23 2020/10/24 09:51:21 tom Exp @ + * @Id: curs_touch.3x,v 1.47 2024/04/20 21:20:07 tom Exp @ --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> -<TITLE>curs_touch 3x</TITLE> +<TITLE>curs_touch 3x 2024-04-20 ncurses 6.5 Library calls</TITLE> <link rel="author" href="mailto:bug-ncurses@gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + </HEAD> <BODY> -<H1 class="no-header">curs_touch 3x</H1> +<H1 class="no-header">curs_touch 3x 2024-04-20 ncurses 6.5 Library calls</H1> <PRE> -<STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> +<STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> </PRE><H2><a name="h2-NAME">NAME</a></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 + <STRONG>touchwin</STRONG>, <STRONG>touchline</STRONG>, <STRONG>untouchwin</STRONG>, <STRONG>wtouchln</STRONG>, <STRONG>is_linetouched</STRONG>, + <STRONG>is_wintouched</STRONG> - control terminal output refresh in a <EM>curses</EM> window </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> @@ -66,37 +66,39 @@ </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> - The <STRONG>touchwin</STRONG> and <STRONG>touchline</STRONG> routines throw away all optimization infor- - mation 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>touchwin</STRONG> and <STRONG>touchline</STRONG> routines throw away all optimization + 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 + 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 speci- - fied line/window was modified since the last call to <STRONG>wrefresh</STRONG>; other- - wise they return <STRONG>FALSE</STRONG>. In addition, <STRONG>is_linetouched</STRONG> returns <STRONG>ERR</STRONG> if - <EM>line</EM> is not valid for the given window. + 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 addition, <STRONG>is_linetouched</STRONG> returns <STRONG>ERR</STRONG> + if <EM>line</EM> is not valid for the given window. </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></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 + 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 descriptions. - X/Open does not define any error conditions. In this implementation + X/Open Curses does not specify any error conditions. In this + implementation <STRONG>is_linetouched</STRONG> returns an error if the window pointer is null, or if the line - number is outside the window. + number is outside the window boundaries. The constant <STRONG>ERR</STRONG> is distinct from <STRONG>TRUE</STRONG> and <STRONG>FALSE</STRONG>, which are the normal return values of this function. Because the function @@ -109,30 +111,30 @@ <STRONG>wtouchln</STRONG> returns an error if the window pointer is null, or if the line - number is outside the window. + number is outside the window boundaries. + + +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + All of these routines except <STRONG>wtouchln</STRONG> may be macros. </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> - These functions were introduced by SVr4. The Solaris curses header + These functions were introduced by SVr4. The Solaris <EM>curses</EM> header file, for instance, defines both an actual function and macro for each. - The macros give the same result as the actual functions. SVr4 curses + The macros give the same result as the actual functions. SVr4 <EM>curses</EM> does not check the window parameter <EM>win</EM> to ensure that it is not <STRONG>NULL</STRONG>; otherwise this implementation behaves the same as SVr4. - The XSI Curses standard, Issue 4 describes these functions, but defines - no error conditions. - - -</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> - All of these routines except <STRONG>wtouchln</STRONG> may be macros. + X/Open Curses, Issue 4 describes these functions, but defines no error + conditions. </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> - <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>. + <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> - <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> +ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG> </PRE> <div class="nav"> <ul> @@ -140,8 +142,8 @@ <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> -<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> <li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> </ul> </div> |