X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_touch.3x.html;h=a60b3690e2a2a31b4d16960ccd4ca5258f216ce9;hp=6a7ee9be6ace6e15919c625a955f507771c7e6ab;hb=8f6d94b8d6211a2323caef53fa4c96c475ec9a62;hpb=6208c89f98f1cf9fe0980bd8e791846ce007a13d;ds=sidebyside diff --git a/doc/html/man/curs_touch.3x.html b/doc/html/man/curs_touch.3x.html index 6a7ee9be..a60b3690 100644 --- a/doc/html/man/curs_touch.3x.html +++ b/doc/html/man/curs_touch.3x.html @@ -1,6 +1,6 @@
- +-curs_touch(3x) curs_touch(3x) +curs_touch(3x) curs_touch(3x) @@ -61,64 +61,65 @@
- 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. + 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. + + 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 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.
- 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. + 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 + + is_linetouched + returns an error if the window pointer is null, or if the line + number is outside the window. - X/Open does not define any error conditions. In this im- - plementation + 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. - 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. + 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. - wtouchln - returns an error if the window pointer is - null, or if the line number is outside the - window. + wtouchln + returns an error if the window pointer is null, or if the line + number is outside the window.
- The XSI Curses standard, Issue 4 describes these func- - tions. + 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. - 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 XSI Curses standard, Issue 4 describes these functions, but defines + no error conditions.
- Note that all routines except wtouchln may be macros. + All of these routines except wtouchln may be macros.
@@ -126,7 +127,7 @@ - curs_touch(3x) + curs_touch(3x)