Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
Curses Library Functionscurs_clear(3CURSES)


NAME

 curs_clear, erase, werase, clear, wclear, clrtobot, wclrtobot, clrtoeol, wclrtoeol - clear all or part of a curses window

SYNOPSIS

 
cc [ flag... ] file ... -lcurses [ library ... ]
#include <curses.h>
int erase(void);
 int werase(WINDOW *win);
 int clear(void);
 int wclear(WINDOW *win);
 int clrtobot(void);
 int wclrtobot(WINDOW *win);
 int clrtoeol(void);
 int wclrtoeol(WINDOW *win);

DESCRIPTION

 

The erase() and werase() routines copy blanks to every position in the 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 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.

RETURN VALUES

 

All routines return the integer OK, or a non-negative integer if immedok() is set. See curs_outopts(3CURSES).

ATTRIBUTES

 

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
MT-LevelUnsafe

SEE ALSO

 

curs_outopts(3CURSES), curs_refresh(3CURSES), curses(3CURSES), attributes(5)

NOTES

 

The header <curses.h> automatically includes the headers <stdio.h> and <unctrl.h>.

Note that erase(), werase(), clear(), wclear(), clrtobot(), and clrtoeol() may be macros.


SunOS 5.9Go To TopLast Changed 31 Dec 1996

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.