X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_touch.3x.html;h=52660dba30cc7920bac0e9eac374f6f7a2ae8672;hp=198fc85237c13a95ea7959c0374a81d7223e9f2b;hb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_touch.3x.html b/doc/html/man/curs_touch.3x.html index 198fc852..52660dba 100644 --- a/doc/html/man/curs_touch.3x.html +++ b/doc/html/man/curs_touch.3x.html @@ -1,130 +1,139 @@ + + +
++curs_touch(3x) curs_touch(3x) + + +
- touchwin, touchline, untouchwin, wtouchln, is_linetouched, - is_wintouched - curses refresh control routines + touchwin, touchline, untouchwin, wtouchln, is_linetouched, + is_wintouched - curses refresh control routines
- #include <curses.h> - int touchwin(WINDOW *win); - int touchline(WINDOW *win, int start, int count); - int untouchwin(WINDOW *win); - int wtouchln(WINDOW *win, int y, int n, int changed); - bool is_linetouched(WINDOW *win, int line); - bool is_wintouched(WINDOW *win); + #include <curses.h> + int touchwin(WINDOW *win); + int touchline(WINDOW *win, int start, int count); + int untouchwin(WINDOW *win); + int wtouchln(WINDOW *win, int y, int n, int changed); + bool is_linetouched(WINDOW *win, int line); + bool is_wintouched(WINDOW *win);
- The touchwin and touchline routines throw away all opti- + 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 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 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 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 + 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 + call to wrefresh; otherwise they return FALSE. In addi- + tion, 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, + 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. + X/Open does not define any error conditions. In this im- + plementation + + 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. +
- The XSI Curses standard, Issue 4 describes these func- + 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 - clearok(..., 1) by saying touchwin(stdscr) or clear(std- - scr). This will not work under ncurses. + 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.
- Note that all routines except wtouchln may be macros. + Note that all routines except wtouchln may be macros.
- curses(3x), curs_refresh(3x). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + curses(3x), curs_refresh(3x). + curs_touch(3x)