***************************************************************************
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 *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: curs_touch.3x,v 1.47 2024/04/20 21:20:07 tom Exp $
\%touchwin, \%touchline, \%untouchwin, \%wtouchln, \%is_linetouched, \%is_wintouched - control terminal output refresh in a curses window

#include <curses.h>

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

int touchwin(WINDOW *win);
int wtouchln(WINDOW *win, int y, int n, int changed);

int untouchwin(WINDOW *win);

bool is_linetouched(WINDOW *win, int line);
bool is_wintouched(WINDOW *win);

The \%touchwin and \%touchline 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 \%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 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 descriptions.

X/Open Curses does not specify any error conditions. In this implementation

All of these routines except \%wtouchln may be macros. 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.

X/Open Curses, Issue 4 describes these functions, but defines no error conditions.

\%curses(3X), \%curs_refresh(3X), \%curs_variables(3X)