Go to main content

man pages section 3: Curses Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

curs_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(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
MT-Level
Unsafe

See Also

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

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.