Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
curs_clear(3CURSES)	   Curses Library Functions	   curs_clear(3CURSES)

NAME
       curs_clear,  erase,  werase,  clear,  wclear, clrtobot, wclrtobot, clr-
       toeol, 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 cur-
       sor 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	 imme-
       dok() is	set. See curs_outopts(3CURSES).

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

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE	TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       curs_outopts(3CURSES),	curs_refresh(3CURSES),	 curses(3CURSES),  at-
       tributes(5)

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

       Note  that  erase(),  werase(), clear(),	wclear(), clrtobot(), and clr-
       toeol() may be macros.

SunOS 5.10			  31 Dec 1996		   curs_clear(3CURSES)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ATTRIBUTES | SEE ALSO | NOTES

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=clrtoeol&sektion=3curses&manpath=SunOS+5.10>

home | help