X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_touch.3x.html;h=d63e4de8d24ed2ee2ba3104fbba51ed252acd3e5;hp=64f83cdc530faa80e1ec528db5d3a1ad8cbeb725;hb=ed646e3f683083e787c6ba773364401dc9fa9d40;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_touch.3x.html b/doc/html/man/curs_touch.3x.html index 64f83cdc..d63e4de8 100644 --- a/doc/html/man/curs_touch.3x.html +++ b/doc/html/man/curs_touch.3x.html @@ -1,7 +1,6 @@ - + + + curs_touch 3x -

curs_touch 3x

-
+

curs_touch 3x

-
-curs_touch(3x)                                     curs_touch(3x)
+curs_touch(3x)                                                  curs_touch(3x)
 
 
 
 
-
-

NAME

+

NAME

        touchwin, touchline, untouchwin, wtouchln, is_linetouched,
        is_wintouched - curses refresh control routines
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        #include <curses.h>
        int touchwin(WINDOW *win);
        int touchline(WINDOW *win, int start, int count);
@@ -62,68 +60,75 @@
        bool is_wintouched(WINDOW *win);
 
 
-
-

DESCRIPTION

-       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.
+

DESCRIPTION

+       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.
 
-
-

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  descrip-
-       tions.
+       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.
 
-
-

PORTABILITY

-       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.
+

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.
 
+       X/Open does not define any error conditions.  In this implementation
 
-
-

NOTES

+              is_linetouched
+                   returns an error if the window pointer is null, or  if  the
+                   line  number  is outside the window.  Note that ERR is dis-
+                   tinct from TRUE and FALSE, which are the normal return val-
+                   ues of this function.
+
+              wtouchln
+                   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 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).
+

SEE ALSO

+       curses(3x), curs_refresh(3x), curs_variables(3x).
 
 
 
-                                                   curs_touch(3x)
+                                                                curs_touch(3x)
 
-
-
-Man(1) output converted with -man2html -
+