X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_clear.3x.html;h=cfc60626b48e2dab2215e32af3c3c145f5db66a5;hp=bb5ff2269a333c34bc45658bc432c36460070791;hb=6208c89f98f1cf9fe0980bd8e791846ce007a13d;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01;ds=sidebyside diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html index bb5ff226..cfc60626 100644 --- a/doc/html/man/curs_clear.3x.html +++ b/doc/html/man/curs_clear.3x.html @@ -1,7 +1,6 @@ - +
+ +- +curs_clear(3x) curs_clear(3x) --
- erase, werase, clear, wclear, clrtobot, wclrtobot, clr- - toeol, wclrtoeol - clear all or part of a curses window --
+ +
+ erase, werase, clear, wclear, clrtobot, wclrtobot, + clrtoeol, wclrtoeol - clear all or part of a curses window + + +
# include <curses.h> int erase(void); @@ -61,8 +63,7 @@ int wclrtoeol(WINDOW *win); --
+
The erase and werase routines copy blanks to every posi- tion in the window, clearing the screen. @@ -84,89 +85,61 @@ dition (as set by wbkgdset) merged into them. --
- 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. +
+ All routines return the integer OK on success and ERR on + failure. The SVr4.0 manual says "or a non-negative inte- + ger if immedok is set", but this appears to be an error. + X/Open defines no error conditions. In this implementa- + tion, functions using a window pointer parameter return an + error if it is null. --
+ +
Note that erase, werase, clear, wclear, clrtobot, and clr- toeol may be macros. --
+
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. - - --
- curses(3x), curs_outopts(3x), curs_refresh(3x) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + clearok(..., 1) by saying touchwin(stdscr) or clear(std- + scr). This will not work under ncurses. + This implementation, and others such as Solaris, sets the + current position to 0,0 after erasing via werase() and + wclear(). That fact is not documented in other implemen- + tations, and may not be true of implementations which were + not derived from SVr4 source. + Not obvious from the description, most implementations + clear the screen after wclear even for a subwindow or de- + rived window. If you do not want to clear the screen dur- + ing the next wrefresh, use werase instead. +
+ curses(3x), curs_outopts(3x), curs_refresh(3x), curs_vari- + ables(3x) + curs_clear(3x)-