X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_clear.3x.html;h=7d86e09a35948fbfbd29a46c584b4053fc7a731e;hb=a47b9e53836434777854387fa6f09f2137ec2111;hp=28de850de44903355e78bc9e57102b1c1bff7170;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40;p=ncurses.git diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html index 28de850d..7d86e09a 100644 --- a/doc/html/man/curs_clear.3x.html +++ b/doc/html/man/curs_clear.3x.html @@ -1,6 +1,7 @@ -
- --curs_clear(3x) curs_clear(3x) +curs_clear(3x) Library calls curs_clear(3x) @@ -51,45 +52,58 @@
- # include <curses.h> + #include <curses.h> int erase(void); - int werase(WINDOW *win); + int werase(WINDOW *win); + int clear(void); - int wclear(WINDOW *win); + int wclear(WINDOW *win); + int clrtobot(void); - int wclrtobot(WINDOW *win); + int wclrtobot(WINDOW *win); + int clrtoeol(void); - int wclrtoeol(WINDOW *win); + int wclrtoeol(WINDOW *win);
+ +
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. + Blanks created by erasure have the current background rendition (as set + by wbkgdset(3x)) merged into them. + + +
+ The clear and wclear routines are like erase and werase, but they also + call clearok(3x), 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 + 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. -
- All routines return the integer OK on success and ERR on failure. 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. + + X/Open defines no error conditions. In this implementation, - X/Open defines no error conditions. In this implementation, functions - using a window pointer parameter return an error if it is null. + 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.
@@ -102,17 +116,22 @@ standard specifies that they return ERR on failure, but specifies no error conditions. - Some historic curses implementations had, as an undocumented feature, - the ability to do the equivalent of clearok(..., 1) by saying touch- + The SVr4.0 manual says that these functions could return "a non-nega- + tive integer if immedok(3x) is set", referring to the return-value of + wrefresh. 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- + 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 + 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. @@ -121,13 +140,20 @@ - curs_clear(3x) +ncurses 6.4 2023-07-01 curs_clear(3x)