X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_clear.3x.html;h=1f59187084736915fea6e62ce78846b8c5e9ca4e;hp=e70f7757289e1f41401c40a69d2ba1d52e014474;hb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html index e70f7757..1f591870 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)-
+NAME
erase, werase, clear, wclear, clrtobot, wclrtobot, clrtoeol, wclrtoeol - clear all or part of a curses window-SYNOPSIS
+SYNOPSIS
# include <curses.h> int erase(void); @@ -66,22 +67,22 @@-DESCRIPTION
- The erase and werase routines copy blanks to every posi- +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 + 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 + 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 + 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 + to the right of the cursor, inclusive, to the end of the current line. Blanks created by erasure have the current background ren- @@ -89,52 +90,64 @@-RETURN VALUE
- All routines return the integer OK on success and ERR on - failure. The SVr4.0 manual says "or a non-negative inte- +RETURN VALUE
+ 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- + X/Open defines no error conditions. In this implementa- tion, functions using a window pointer parameter return an error if it is null.-NOTES
+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 +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(std- + 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. - 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- + 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. +-SEE ALSO
- curses(3x), curs_outopts(3x), curs_refresh(3x) +SEE ALSO
+ curses(3x), curs_outopts(3x), curs_refresh(3x), curs_vari- + ables(3x) curs_clear(3x)-
- -Man(1) output converted with -man2html - +