src - FreeBSD source tree

diff options


context:
space:
mode:

author	Baptiste Daroussin <bapt@FreeBSD.org>	2020-02-07 08:36:41 +0000
committer	Baptiste Daroussin <bapt@FreeBSD.org>	2020-02-07 08:36:41 +0000
commit	f0179cb6083cc92e5947ae56e6a0a5c5328aead0 (patch)
tree	bcee0ba9c2149b71f0bfc036df1e61e3105bf980 /doc/html/man/curs_touch.3x.html
parent	cea297eb34d2361e79529034397465068ae34ecd (diff)
download	src-f0179cb6083cc92e5947ae56e6a0a5c5328aead0.tar.gz src-f0179cb6083cc92e5947ae56e6a0a5c5328aead0.zip

Vendor import ncurses 6.1-20200118vendor/ncurses/6.1-20200118

Notes

Notes: svn path=/vendor/ncurses/dist/; revision=357645 svn path=/vendor/ncurses/6.1-20200118/; revision=357646; tag=vendor/ncurses/6.1-20200118

Diffstat (limited to 'doc/html/man/curs_touch.3x.html')

-rw-r--r--

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

146

1 files changed, 73 insertions, 73 deletions

diff --git a/doc/html/man/curs_touch.3x.html b/doc/html/man/curs_touch.3x.html
index f2057b9e53b7..a60b3690e2a2 100644
--- a/doc/html/man/curs_touch.3x.html
+++ b/doc/html/man/curs_touch.3x.html

@@ -1,7 +1,6 @@

-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">

<!--

****************************************************************************

* *

* Permission is hereby granted, free of charge, to any person obtaining a *

* copy of this software and associated documentation files (the *

@@ -27,32 +26,31 @@

* sale, use or other dealings in this Software without prior written *

* authorization. *

****************************************************************************

- * @Id: curs_touch.3x,v 1.14 2010/12/04 18:38:55 tom Exp @

+ * @Id: curs_touch.3x,v 1.21 2018/07/28 21:34:56 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>

-<link rev=made href="mailto:bug-ncurses@gnu.org">

+<link rel="author" href="mailto:bug-ncurses@gnu.org">

</HEAD>

<BODY>

-<H1>curs_touch 3x</H1>

-<HR>

+<H1 class="no-header">curs_touch 3x</H1>

<PRE>

-

-<A HREF="curs_touch.3x.html">curs_touch(3x)</A> <A HREF="curs_touch.3x.html">curs_touch(3x)</A>

+<A HREF="curs_touch.3x.html">curs_touch(3x)</A> <A HREF="curs_touch.3x.html">curs_touch(3x)</A>

-</PRE>

-<H2>NAME</H2><PRE>

+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>

touchwin, touchline, untouchwin, wtouchln, is_linetouched,

is_wintouched - curses refresh control routines

-</PRE>

-<H2>SYNOPSIS</H2><PRE>

+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>

#include <curses.h>

int touchwin(WINDOW *win);

int touchline(WINDOW *win, int start, int count);

@@ -62,83 +60,85 @@

bool is_wintouched(WINDOW *win);

-</PRE>

-<H2>DESCRIPTION</H2><PRE>

- The touchwin and touchline 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 touchline only pretends that count lines have

- been changed, beginning with line start.

- The untouchwin routine marks all lines in the window as

- unchanged since the last call to wrefresh.

- The wtouchln routine makes n lines in the window, starting

- at line y, look as if they have (changed=1) or have not

- (changed=0) been changed since the last call to wrefresh.

- The is_linetouched and is_wintouched routines return TRUE

- if the specified line/window was modified since the last

- call to wrefresh; otherwise they return FALSE. In addi-

- tion, is_linetouched returns ERR if line is not valid for

- the given window.

+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>

+ The touchwin and touchline 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 touchline only

+ pretends that count lines have been changed, beginning with line start.

+ The untouchwin routine marks all lines in the window as unchanged since

+ the last call to wrefresh.

-</PRE>

-<H2>RETURN VALUE</H2><PRE>

- All routines return the integer ERR upon failure and an

- integer value other than ERR upon successful completion,

- unless otherwise noted in the preceding routine descrip-

- tions.

+ The wtouchln routine makes n lines in the window, starting at line y,

+ look as if they have (changed=1) or have not (changed=0) been changed

+ since the last call to wrefresh.

- X/Open does not define any error conditions. In this im-

- plementation

+ The is_linetouched and is_wintouched routines return TRUE if the speci-

+ fied line/window was modified since the last call to wrefresh; other-

+ wise they return FALSE. In addition, is_linetouched returns ERR if

+ line is not valid for the given window.

- is_linetouched

- returns an error if the window pointer is

- null, or if the line number is outside the

- window. Note that ERR is distinct from TRUE

- and FALSE, which are the normal return values

- of this function.

- wtouchln

- returns an error if the window pointer is

- null, or if the line number is outside the

- window.

+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>

+ All routines return the integer ERR upon failure and an integer value

+ other than ERR upon successful completion, unless otherwise noted in

+ the preceding routine descriptions.

+ X/Open does not define any error conditions. In this implementation

-</PRE>

-<H2>PORTABILITY</H2><PRE>

- The XSI Curses standard, Issue 4 describes these func-

- tions.

+ is_linetouched

+ returns an error if the window pointer is null, or if the line

+ number is outside the window.

- Some historic curses implementations had, as an undocu-

- mented feature, the ability to do the equivalent of

- clearok(..., 1) by saying touchwin(stdscr) or clear(std-

- scr). This will not work under ncurses.

+ The constant ERR is distinct from TRUE and FALSE, which are the

+ normal return values of this function. Because the function

+ returns a bool, returning ERR (which is neither TRUE nor FALSE)

+ may not be supported by the compiler.

+ To provide error-checking and also match the X/Open function

+ prototype, the ERR is provided by a macro named is_linetouched.

+ The actual function returns FALSE when it detects an error.

-</PRE>

-<H2>NOTES</H2><PRE>

- Note that all routines except wtouchln may be macros.

+ wtouchln

+ returns an error if the window pointer is null, or if the line

+ number is outside the window.

-</PRE>

-<H2>SEE ALSO</H2><PRE>

+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>

+ These functions were introduced by SVr4. The Solaris curses 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

+ does not check the window parameter win to ensure that it is not NULL;

+ 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 wtouchln may be macros.

+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>

<A HREF="ncurses.3x.html">curses(3x)</A>, <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>, <A HREF="curs_variables.3x.html">curs_variables(3x)</A>.

- <A HREF="curs_touch.3x.html">curs_touch(3x)</A>

+ <A HREF="curs_touch.3x.html">curs_touch(3x)</A>

</PRE>

-<HR>

-<ADDRESS>

-Man(1) output converted with

-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>

-</ADDRESS>

+<div class="nav">

+<ul>

+<li><a href="#h2-NAME">NAME</a></li>

+<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-SEE-ALSO">SEE ALSO</a></li>

+</ul>

+</div>

</BODY>

</HTML>