clrtoeol(3x) 맨 페이지 - 윈디하나의 솔라나라

개요

섹션
맨 페이지 이름
검색(S)

clrtoeol(3x)

curs_clear(3x)                   Library calls                  curs_clear(3x)

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

SYNOPSIS
       #include <ncursesw/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
   erase, werase
       The erase and werase routines copy blanks to every position in the win‐
       dow, clearing the screen.

       Blanks created by erasure have the current background rendition (as set
       by wbkgdset(3X)) merged into them.

   clear, wclear
       The clear and wclear routines are like erase and werase, but they  also
       call  clearok(3X), so that the screen is cleared completely on the next
       call to wrefresh for that window and repainted from scratch.

   clrtobot, wclrtobot
       The clrtobot and wclrtobot 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.

   clrtoeol, wclrtoeol
       The clrtoeol and wclrtoeol routines erase the current line to the right
       of the cursor, inclusive, to the end of the current line.

RETURN VALUE
       All routines return the integer OK on success and ERR on failure.

       In this implementation,

       •   functions using a window pointer parameter return ERR if it is null

       •   wclrtoeol returns an error if the cursor position is about to wrap.


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

       box; cbp-1 | cbp-1 l | l .  ATTRIBUTE TYPE ATTRIBUTE VALUE = Availabil‐
       ity   library/ncurses = Stability Uncommitted

NOTES
       erase, werase, clear, wclear, clrtobot, and clrtoeol may be implemented
       as macros.

       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at:
       https://github.com/oracle/solaris-userland

       The original community source was downloaded from:
       https://invisible-mirror.net/archives/ncurses/cur‐
       rent/ncurses-6.5-20250614.tgz

       Further information about this software can be found on the open source
       community website at https://invisible-island.net/ncurses/.

PORTABILITY
       X/Open Curses Issue 4 describes these functions.  It specifies no error
       conditions for them.

       SVr4  documentation says that these functions return OK “or a non-nega‐
       tive integer if immedok() is set”, referring to the return  value  from
       wrefresh,  which  in  SVr4 returns a count of characters written to the
       window if its immedok property is set; in ncurses, it does not.

       Some historic curses implementations had, as an  undocumented  feature,
       the  ability  to  do the equivalent of clearok(..., 1) by saying touch‐
       win(stdscr) or clear(stdscr).  This will not work under ncurses.

       This implementation, and others such as Solaris, sets the current posi‐
       tion to 0,0 after erasing via werase and wclear.  That fact is not doc‐
       umented in other implementations, and may not be  true  of  implementa‐
       tions which were not derived from SVr4 source.

       Not obvious from the description, most implementations clear the screen
       after  wclear  even  for  a subwindow or derived window.  If you do not
       want to clear the screen during the next wrefresh, use werase instead.

SEE ALSO
       curses(3X), curs_outopts(3X), curs_refresh(3X), curs_variables(3X)


ncurses 6.5                       2025-01-18                    curs_clear(3x)
맨 페이지 내용의 저작권은 맨 페이지 작성자에게 있습니다.
RSS ATOM XHTML 5 CSS3