X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_clear.3x.html;h=82491d365b85de309023edf2550eb1a3b0e98d2a;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hp=1a874f2e8e430ad0901647f9aa757d05cea6cb73;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34;p=ncurses.git diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html index 1a874f2e..82491d36 100644 --- a/doc/html/man/curs_clear.3x.html +++ b/doc/html/man/curs_clear.3x.html @@ -1,134 +1,149 @@ + + + + + +curs_clear 3X + + + +

curs_clear 3X

-
-
-
-

NAME

-       erase,  werase,  clear,  wclear, clrtobot, wclrtobot, clr-
-       toeol, wclrtoeol - clear all or part of a curses window
-
-
-
-

SYNOPSIS

-       # include <curses.h>
-
-       int erase(void);
-       int werase(WINDOW *win);
-       int clear(void);
-       int wclear(WINDOW *win);
-       int clrtobot(void);
-       int wclrtobot(WINDOW *win);
-       int clrtoeol(void);
-       int wclrtoeol(WINDOW *win);
-
-
-
-

DESCRIPTION

-       The erase and werase routines copy blanks to  every  posi-
-       tion in the window, clearing the screen.
-
-       The  clear  and wclear routines are like erase and werase,
-       but they also call clearok, so that the screen is  cleared
-       completely  on  the  next call to wrefresh for that window
-       and repainted from scratch.
-
-       The clrtobot and wclrtobot routines erase from the  cursor
-       to the end of screen.  That is, they erase all lines below
-       the cursor in the window.  Also, the current line  to  the
-       right of the cursor, inclusive, is erased.
-
-       The clrtoeol and wclrtoeol routines erase the current line
-       to the right of the cursor, inclusive, to the end  of  the
-       current line.
-
-       Blanks created by erasure have the current background ren-
-       dition (as set by wbkgdset) merged into them.
-
-
-
-

RETURN VALUE

-       All routines return the integer  OK.   The  SVr4.0  manual
-       says  "or  a  non-negative integer if immedok is set", but
-       this appears to be an error.
-
-
-
-

NOTES

-       Note that erase, werase, clear, wclear, clrtobot, and clr-
-       toeol may be macros.
-
-
-
-

PORTABILITY

-       These  functions are described in the XSI Curses standard,
-       Issue 4.  The standard specifies that they return  ERR  on
-       failure, but specifies no error conditions.
-
-       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(stdscr).  This will not work under ncurses.
-
-
-
-

SEE ALSO

-       curses(3x), curs_outopts(3x), curs_refresh(3x)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+curs_clear(3X)                                                  curs_clear(3X)
 
 
 
 
+

NAME

+       erase, werase, clear, wclear, clrtobot, wclrtobot, clrtoeol, wclrtoeol
+       - clear all or part of a curses window
 
 
+

SYNOPSIS

+       #include <curses.h>
 
+       int erase(void);
+       int werase(WINDOW *win);
 
+       int clear(void);
+       int wclear(WINDOW *win);
 
+       int clrtobot(void);
+       int wclrtobot(WINDOW *win);
 
+       int clrtoeol(void);
+       int wclrtoeol(WINDOW *win);
 
 
+

DESCRIPTION

+       The erase and werase routines copy blanks to every position in the win-
+       dow, clearing the screen.
 
+       The  clear and wclear routines are like erase and werase, but they also
+       call clearok, so that the screen is cleared completely on the next call
+       to wrefresh for that window and repainted from scratch.
 
+       The clrtobot and wclrtobot routines erase from the cursor to the end of
+       screen.  That is, they erase all lines below the cursor in the  window.
+       Also,  the  current  line  to  the  right  of the cursor, inclusive, is
+       erased.
 
+       The clrtoeol and wclrtoeol routines erase the current line to the right
+       of the cursor, inclusive, to the end of the current line.
 
+       Blanks created by erasure have the current background rendition (as set
+       by wbkgdset) merged into them.
 
 
+

RETURN VALUE

+       All routines return the integer OK on success and ERR on failure.
 
+       X/Open defines no error conditions.  In this implementation,
 
+       o   functions using a window pointer parameter return an error if it is
+           null
 
+       o   wclrtoeol returns an error if the cursor position is about to wrap.
 
 
+

NOTES

+       Note  that  erase, werase, clear, wclear, clrtobot, and clrtoeol may be
+       macros.
 
 
+

PORTABILITY

+       These functions are described in the XSI Curses standard, Issue 4.  The
+       standard  specifies  that  they return ERR on failure, but specifies no
+       error conditions.
 
+       The SVr4.0 manual says that these functions could return  "a  non-nega-
+       tive  integer if immedok is set", referring to the return-value of wre-
+       fresh.  In that implementation, wrefresh would return a  count  of  the
+       number of characters written to the terminal.
 
+       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.
 
+       This implementation, and others such as Solaris, sets the current posi-
+       tion to 0,0 after erasing via werase and wclear.  That fact is not doc-
+       umented  in  other  implementations, and may not be true of implementa-
+       tions which were not derived from SVr4 source.
 
+       Not obvious from the description, most implementations clear the screen
+       after  wclear  even  for  a subwindow or derived window.  If you do not
+       want to clear the screen during the next wrefresh, use werase instead.
 
 
+

SEE ALSO

+       curses(3X), curs_outopts(3X), curs_refresh(3X), curs_variables(3X)
 
 
 
+                                                                curs_clear(3X)
-
-
-Man(1) output converted with -man2html -
+
+ +