diff options
Diffstat (limited to 'ncurses-5.2/doc/html/man/curs_clear.3x.html')
| -rw-r--r-- | ncurses-5.2/doc/html/man/curs_clear.3x.html | 134 |
1 files changed, 134 insertions, 0 deletions
diff --git a/ncurses-5.2/doc/html/man/curs_clear.3x.html b/ncurses-5.2/doc/html/man/curs_clear.3x.html new file mode 100644 index 0000000..1a874f2 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_clear.3x.html @@ -0,0 +1,134 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>erase</B>, <B>werase</B>, <B>clear</B>, <B>wclear</B>, <B>clrtobot</B>, <B>wclrtobot</B>, <B>clr-</B> + <B>toeol</B>, <B>wclrtoeol</B> - clear all or part of a <B>curses</B> window + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#</B> <B>include</B> <B><curses.h></B> + + <B>int</B> <B>erase(void);</B> + <B>int</B> <B>werase(WINDOW</B> <B>*win);</B> + <B>int</B> <B>clear(void);</B> + <B>int</B> <B>wclear(WINDOW</B> <B>*win);</B> + <B>int</B> <B>clrtobot(void);</B> + <B>int</B> <B>wclrtobot(WINDOW</B> <B>*win);</B> + <B>int</B> <B>clrtoeol(void);</B> + <B>int</B> <B>wclrtoeol(WINDOW</B> <B>*win);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>erase</B> and <B>werase</B> routines copy blanks to every posi- + tion in the window, clearing the screen. + + The <B>clear</B> and <B>wclear</B> routines are like <B>erase</B> and <B>werase</B>, + but they also call <B>clearok</B>, so that the screen is cleared + completely on the next call to <B>wrefresh</B> for that window + and repainted from scratch. + + The <B>clrtobot</B> and <B>wclrtobot</B> 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 <B>clrtoeol</B> and <B>wclrtoeol</B> 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 <B>wbkgdset</B>) merged into them. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <B>OK</B>. The SVr4.0 manual + says "or a non-negative integer if <B>immedok</B> is set", but + this appears to be an error. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>erase</B>, <B>werase</B>, <B>clear</B>, <B>wclear</B>, <B>clrtobot</B>, and <B>clr-</B> + <B>toeol</B> may be macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These functions are described in the XSI Curses standard, + Issue 4. The standard specifies that they return <B>ERR</B> on + failure, but specifies no error conditions. + + Some historic curses implementations had, as an undocu- + mented feature, the ability to do the equivalent of + <B>clearok(...,</B> <B>1)</B> by saying <B>touchwin(stdscr)</B> or + <B>clear(stdscr)</B>. This will not work under ncurses. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> |