MirOS Manual: curs_touch(3), is_linetouched(3), is_wintouched(3), touchline(3), touchwin(3), untouchwin(3), wtouchln(3)


curs_touch(3)       UNIX Programmer's Manual        curs_touch(3)

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 optimiza-
     tion  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 win-
     dows, since a change to one window affects the other window,
     but the records of which lines have been changed in the oth-
     er 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  un-
     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 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.

RETURN VALUE

     All routines return the integer ERR upon failure and an  in-
     teger  value  other than ERR upon successful completion, un-
     less otherwise noted in the preceding routine descriptions.

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

          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

MirOS BSD #10-current  Printed 03.04.2017                       1

curs_touch(3)       UNIX Programmer's Manual        curs_touch(3)

               returns an error if the window pointer is null, or
               if the line number is outside the window.

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 touchwin(stdscr) or clear(stdscr).  This will  not
     work under ncurses.

NOTES

     Note that all routines except wtouchln may be macros.

SEE ALSO

     curses(3), curs_refresh(3).

MirOS BSD #10-current  Printed 03.04.2017                       2

Generated on 2017-04-03 16:26:17 by $MirOS: src/scripts/roff2htm,v 1.88 2017/01/29 00:51:06 tg Exp $

These manual pages and other documentation are copyrighted by their respective writers; their source is available at our CVSweb, AnonCVS, and other mirrors. The rest is Copyright © 2002–2017 The MirOS Project, Germany.
This product includes material provided by mirabilos.

This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report — diffs preferred.