1996-02-11 23:29:40 +00:00
|
|
|
.TH curs_clear 3 ""
|
1994-10-07 08:58:58 +00:00
|
|
|
.SH NAME
|
1996-02-11 23:29:40 +00:00
|
|
|
\fBerase\fR, \fBwerase\fR, \fBclear\fR,
|
1994-10-07 08:58:58 +00:00
|
|
|
\fBwclear\fR, \fBclrtobot\fR, \fBwclrtobot\fR, \fBclrtoeol\fR,
|
|
|
|
|
\fBwclrtoeol\fR - clear all or part of a \fBncurses\fR window
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
\fB# include <ncurses.h>\fR
|
|
|
|
|
|
|
|
|
|
\fBint erase(void);\fR
|
|
|
|
|
.br
|
|
|
|
|
\fBint werase(WINDOW *win);\fR
|
|
|
|
|
.br
|
|
|
|
|
\fBint clear(void);\fR
|
|
|
|
|
.br
|
|
|
|
|
\fBint wclear(WINDOW *win);\fR
|
|
|
|
|
.br
|
|
|
|
|
\fBint clrtobot(void);\fR
|
|
|
|
|
.br
|
|
|
|
|
\fBint wclrtobot(WINDOW *win);\fR
|
|
|
|
|
.br
|
|
|
|
|
\fBint clrtoeol(void);\fR
|
|
|
|
|
.br
|
|
|
|
|
\fBint wclrtoeol(WINDOW *win);\fR
|
|
|
|
|
.br
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The \fBerase\fR and \fBwerase\fR routines copy blanks to every
|
|
|
|
|
position in the window, clearing the screen.
|
|
|
|
|
|
|
|
|
|
The \fBclear\fR and \fBwclear\fR routines are like \fBerase\fR and
|
|
|
|
|
\fBwerase\fR, but they also call \fBclearok\fR, so that the screen is
|
|
|
|
|
cleared completely on the next call to \fBwrefresh\fR for that window
|
|
|
|
|
and repainted from scratch.
|
|
|
|
|
|
|
|
|
|
The \fBclrtobot\fR and \fBwclrtobot\fR 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 \fBclrtoeol\fR and \fBwclrtoeol\fR routines erase the current line
|
|
|
|
|
to the right of the cursor, inclusive.
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
All routines return the integer \fBOK\fR, or a non-negative integer if
|
|
|
|
|
\fBimmedok\fR is set.
|
|
|
|
|
.SH NOTES
|
|
|
|
|
Note that \fBerase\fR, \fBwerase\fR, \fBclear\fR, \fBwclear\fR,
|
|
|
|
|
\fBclrtobot\fR, and \fBclrtoeol\fR may be macros.
|
|
|
|
|
.SH SEE ALSO
|
1996-02-11 23:29:40 +00:00
|
|
|
\fBncurses\fR(3), \fBcurs_outopts\fR(3), \fBcurs_refresh\fR(3)
|
1994-10-07 08:58:58 +00:00
|
|
|
.\"#
|
|
|
|
|
.\"# The following sets edit modes for GNU EMACS
|
|
|
|
|
.\"# Local Variables:
|
|
|
|
|
.\"# mode:nroff
|
|
|
|
|
.\"# fill-column:79
|
|
|
|
|
.\"# End:
|
