Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

touchwin(3) [netbsd man page]

CURSES_TOUCH(3) 					   BSD Library Functions Manual 					   CURSES_TOUCH(3)

NAME
curses_touch, touchline, touchoverlap, touchwin, untouchwin, wtouchln, is_linetouched, is_wintouched, redrawwin, wredrawln, wsyncup, wsyncdown -- curses window modification routines LIBRARY
Curses Library (libcurses, -lcurses) SYNOPSIS
#include <curses.h> int touchline(WINDOW *win, int start, int count); int touchoverlap(WINDOW *win1, WINDOW *win2); int touchwin(WINDOW *win); int untouchwin(WINDOW *win); int wtouchln(WINDOW *win, int line, int n, boolf changed); bool is_linetouched(WINDOW *win, int line); bool is_wintouched(WINDOW *win); int redrawwin(WINDOW *win); int wredrawln(WINDOW *win, int line, int n); void wsyncup(WINDOW *win); void wsyncdown(WINDOW *win); DESCRIPTION
These functions mark lines and windows as modified and check the modification status of lines and windows. The touchline() function marks count lines starting from start in window win as having been modified. These characters will be synced to the terminal on the next call to wrefresh(). The touchoverlap() function marks the portion of win2 that overlaps win1 as being modified. The touchwin() function marks the entire window win as having been modified. Conversely, the untouchwin() function marks the window win as being unmodified, so that any changes made to that window will not be synced to the terminal during a wrefresh(). The wtouchln() function performs one of two operations on n lines starting at line in the given window. If changed is 1 then the given line range is marked as being modified, if changed is 0 then the given line range is set to being unmodified. The is_linetouched() function returns TRUE if line in window win has been modified since the last refresh was done, otherwise FALSE is returned. is_wintouched() returns TRUE if the window win has been modified since the last refresh, otherwise FALSE is returned. The redrawwin() function marks the entire window win as having been corrupted. Is is equivalent to the touchwin() function. The wredrawln() function marks n lines starting at line in the given window as corrupted. It is equivalent to wtouchln(win, line, n, 1). The wsyncup() function touches all ancestors of win. The wsyncdown() function touches win if any of its ancestors is touched. RETURN VALUES
Functions returning pointers will return NULL if an error is detected. The functions that return an int will return one of the following values: OK The function completed successfully. ERR An error occurred in the function. SEE ALSO
curses_refresh(3) STANDARDS
The NetBSD Curses library complies with the X/Open Curses specification, part of the Single Unix Specification. HISTORY
The Curses package appeared in 4.0BSD. BSD
February 23, 2010 BSD

Check Out this Related Man Page

curs_touch(3X)															    curs_touch(3X)

NAME
touchwin, touchline, untouchwin, wtouchln, is_linetouched, is_wintouched - curses refresh control routines SYNOPSIS
#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); DESCRIPTION
The touchwin and touchline routines throw away all optimization information about which parts of the window have been touched, by pretend- ing 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; other- wise they return FALSE. In addition, is_linetouched returns ERR if line is not valid for the given window. RETURN VALUE
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. PORTABILITY
The XSI Curses standard, Issue 4 describes these functions. Some historic curses implementations had, as an undocumented feature, the ability to do the equivalent of clearok(..., 1) by saying touch- win(stdscr) or clear(stdscr). This will not work under ncurses. NOTES
Note that all routines except wtouchln may be macros. SEE ALSO
curses(3X), curs_refresh(3X). curs_touch(3X)
Man Page