2002-10-13 11:35:53 +08:00
<!--
****************************************************************************
2010-08-01 08:45:28 +08:00
* Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. *
2002-10-13 11:35:53 +08:00
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* "Software"), to deal in the Software without restriction, including *
* without limitation the rights to use, copy, modify, merge, publish, *
* distribute, distribute with modifications, sublicense, and/or sell *
* copies of the Software, and to permit persons to whom the Software is *
* furnished to do so, subject to the following conditions: *
* *
* The above copyright notice and this permission notice shall be included *
* in all copies or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
* *
* Except as contained in this notice, the name(s) of the above copyright *
* holders shall not be used in advertising or otherwise to promote the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
2011-01-09 09:17:12 +08:00
* @Id: curs_clear.3x,v 1.14 2010/12/04 18:36:44 tom Exp @
2002-10-13 11:35:53 +08:00
-->
2015-02-15 09:42:27 +08:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2000-07-09 10:46:08 +08:00
< HTML >
2002-10-13 11:35:53 +08:00
< HEAD >
2015-02-15 09:42:27 +08:00
< meta http-equiv = "Content-Type" content = "text/html; charset=us-ascii" >
< meta name = "generator" content = "Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts" >
2002-10-13 11:35:53 +08:00
< TITLE > curs_clear 3x< / TITLE >
< link rev = made href = "mailto:bug-ncurses@gnu.org" >
< meta http-equiv = "Content-Type" content = "text/html; charset=iso-8859-1" >
< / HEAD >
2000-07-09 10:46:08 +08:00
< BODY >
2002-10-13 11:35:53 +08:00
< H1 > curs_clear 3x< / H1 >
< HR >
2000-07-09 10:46:08 +08:00
< PRE >
2005-10-10 02:41:57 +08:00
< STRONG > < A HREF = "curs_clear.3x.html" > curs_clear(3x)< / A > < / STRONG > < STRONG > < A HREF = "curs_clear.3x.html" > curs_clear(3x)< / A > < / STRONG >
2004-02-09 10:15:26 +08:00
2000-07-09 10:46:08 +08:00
< / PRE >
2015-02-15 09:42:27 +08:00
< H2 > < a name = "h2-NAME" > NAME< / a > < / H2 > < PRE >
2005-10-10 02:41:57 +08:00
< STRONG > erase< / STRONG > , < STRONG > werase< / STRONG > , < STRONG > clear< / STRONG > , < STRONG > wclear< / STRONG > , < STRONG > clrtobot< / STRONG > , < STRONG > wclrtobot< / STRONG > ,
< STRONG > clrtoeol< / STRONG > , < STRONG > wclrtoeol< / STRONG > - clear all or part of a < STRONG > curses< / STRONG > window
2000-07-09 10:46:08 +08:00
< / PRE >
2015-02-15 09:42:27 +08:00
< H2 > < a name = "h2-SYNOPSIS" > SYNOPSIS< / a > < / H2 > < PRE >
2002-10-13 11:35:53 +08:00
< STRONG > #< / STRONG > < STRONG > include< / STRONG > < STRONG > < curses.h> < / STRONG >
2000-07-09 10:46:08 +08:00
2002-10-13 11:35:53 +08:00
< STRONG > int< / STRONG > < STRONG > erase(void);< / STRONG >
< STRONG > int< / STRONG > < STRONG > werase(WINDOW< / STRONG > < STRONG > *win);< / STRONG >
< STRONG > int< / STRONG > < STRONG > clear(void);< / STRONG >
< STRONG > int< / STRONG > < STRONG > wclear(WINDOW< / STRONG > < STRONG > *win);< / STRONG >
< STRONG > int< / STRONG > < STRONG > clrtobot(void);< / STRONG >
< STRONG > int< / STRONG > < STRONG > wclrtobot(WINDOW< / STRONG > < STRONG > *win);< / STRONG >
< STRONG > int< / STRONG > < STRONG > clrtoeol(void);< / STRONG >
< STRONG > int< / STRONG > < STRONG > wclrtoeol(WINDOW< / STRONG > < STRONG > *win);< / STRONG >
2000-07-09 10:46:08 +08:00
< / PRE >
2015-02-15 09:42:27 +08:00
< H2 > < a name = "h2-DESCRIPTION" > DESCRIPTION< / a > < / H2 > < PRE >
2010-08-01 08:45:28 +08:00
The < STRONG > erase< / STRONG > and < STRONG > werase< / STRONG > routines copy blanks to every posi-
2000-07-09 10:46:08 +08:00
tion in the window, clearing the screen.
2010-08-01 08:45:28 +08:00
The < STRONG > clear< / STRONG > and < STRONG > wclear< / STRONG > routines are like < STRONG > erase< / STRONG > and < STRONG > werase< / STRONG > ,
but they also call < STRONG > clearok< / STRONG > , so that the screen is cleared
completely on the next call to < STRONG > wrefresh< / STRONG > for that window
2000-07-09 10:46:08 +08:00
and repainted from scratch.
2010-08-01 08:45:28 +08:00
The < STRONG > clrtobot< / STRONG > and < STRONG > wclrtobot< / STRONG > routines erase from the cursor
2000-07-09 10:46:08 +08:00
to the end of screen. That is, they erase all lines below
2010-08-01 08:45:28 +08:00
the cursor in the window. Also, the current line to the
2000-07-09 10:46:08 +08:00
right of the cursor, inclusive, is erased.
2002-10-13 11:35:53 +08:00
The < STRONG > clrtoeol< / STRONG > and < STRONG > wclrtoeol< / STRONG > routines erase the current line
2010-08-01 08:45:28 +08:00
to the right of the cursor, inclusive, to the end of the
2000-07-09 10:46:08 +08:00
current line.
Blanks created by erasure have the current background ren-
2002-10-13 11:35:53 +08:00
dition (as set by < STRONG > wbkgdset< / STRONG > ) merged into them.
2000-07-09 10:46:08 +08:00
< / PRE >
2015-02-15 09:42:27 +08:00
< H2 > < a name = "h2-RETURN-VALUE" > RETURN VALUE< / a > < / H2 > < PRE >
2010-08-01 08:45:28 +08:00
All routines return the integer < STRONG > OK< / STRONG > on success and < STRONG > ERR< / STRONG > on
failure. The SVr4.0 manual says "or a non-negative inte-
2005-10-10 02:41:57 +08:00
ger if < STRONG > immedok< / STRONG > is set", but this appears to be an error.
2010-08-01 08:45:28 +08:00
X/Open defines no error conditions. In this implementa-
2005-10-10 02:41:57 +08:00
tion, functions using a window pointer parameter return an
error if it is null.
2000-07-09 10:46:08 +08:00
< / PRE >
2015-02-15 09:42:27 +08:00
< H2 > < a name = "h2-NOTES" > NOTES< / a > < / H2 > < PRE >
2002-10-13 11:35:53 +08:00
Note that < STRONG > erase< / STRONG > , < STRONG > werase< / STRONG > , < STRONG > clear< / STRONG > , < STRONG > wclear< / STRONG > , < STRONG > clrtobot< / STRONG > , and < STRONG > clr-< / STRONG >
< STRONG > toeol< / STRONG > may be macros.
2000-07-09 10:46:08 +08:00
< / PRE >
2015-02-15 09:42:27 +08:00
< H2 > < a name = "h2-PORTABILITY" > PORTABILITY< / a > < / H2 > < PRE >
2010-08-01 08:45:28 +08:00
These functions are described in the XSI Curses standard,
Issue 4. The standard specifies that they return < STRONG > ERR< / STRONG > on
2000-07-09 10:46:08 +08:00
failure, but specifies no error conditions.
2010-08-01 08:45:28 +08:00
Some historic curses implementations had, as an undocu-
mented feature, the ability to do the equivalent of
< STRONG > clearok(...,< / STRONG > < STRONG > 1)< / STRONG > by saying < STRONG > touchwin(stdscr)< / STRONG > or < STRONG > clear(std-< / STRONG >
2004-02-09 10:15:26 +08:00
< STRONG > scr)< / STRONG > . This will not work under ncurses.
2000-07-09 10:46:08 +08:00
2010-08-01 08:45:28 +08:00
This implementation, and others such as Solaris, sets the
current position to 0,0 after erasing via < STRONG > werase()< / STRONG > and
< STRONG > wclear()< / STRONG > . That fact is not documented in other implemen-
2005-10-10 02:41:57 +08:00
tations, and may not be true of implementations which were
not derived from SVr4 source.
2010-08-01 08:45:28 +08:00
Not obvious from the description, most implementations
clear the screen after < STRONG > wclear< / STRONG > even for a subwindow or de-
2008-06-22 08:16:39 +08:00
rived window. If you do not want to clear the screen dur-
ing the next < STRONG > wrefresh< / STRONG > , use < STRONG > werase< / STRONG > instead.
2000-07-09 10:46:08 +08:00
< / PRE >
2015-02-15 09:42:27 +08:00
< H2 > < a name = "h2-SEE-ALSO" > SEE ALSO< / a > < / H2 > < PRE >
2010-10-03 08:50:21 +08:00
< STRONG > < A HREF = "ncurses.3x.html" > curses(3x)< / A > < / STRONG > , < STRONG > < A HREF = "curs_outopts.3x.html" > curs_outopts(3x)< / A > < / STRONG > , < STRONG > < A HREF = "curs_refresh.3x.html" > curs_refresh(3x)< / A > < / STRONG > , < STRONG > curs_vari-< / STRONG >
< STRONG > < A HREF = "curs_variables.3x.html" > ables(3x)< / A > < / STRONG >
2000-07-09 10:46:08 +08:00
2005-10-10 02:41:57 +08:00
< STRONG > < A HREF = "curs_clear.3x.html" > curs_clear(3x)< / A > < / STRONG >
2000-07-09 10:46:08 +08:00
< / PRE >
2015-02-15 09:42:27 +08:00
< div class = "nav" >
< ul >
< li > < a href = "#h2-NAME" > NAME< / a > < / li >
< li > < a href = "#h2-SYNOPSIS" > SYNOPSIS< / a > < / li >
< li > < a href = "#h2-DESCRIPTION" > DESCRIPTION< / a > < / li >
< li > < a href = "#h2-RETURN-VALUE" > RETURN VALUE< / a > < / li >
< li > < a href = "#h2-NOTES" > NOTES< / a > < / li >
< li > < a href = "#h2-PORTABILITY" > PORTABILITY< / a > < / li >
< li > < a href = "#h2-SEE-ALSO" > SEE ALSO< / a > < / li >
< / ul >
< / div >
2000-07-09 10:46:08 +08:00
< / BODY >
< / HTML >
