curs_clear 3x

curs_clear(3x)                                           curs_clear(3x)




NAME 名前

       erase, werase, clear, wclear, clrtobot, wclrtobot,
       clrtoeol, wclrtoeol - clear all or part of a curses window
       - curses ウインドウの一部または全部を消去する


SYNOPSIS 書式

       # 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  posi-
       tion in the window, clearing the screen.
        erasewerase ルーチンはウインドウ内のすべての位置に空白を
       コピーして画面を消去します。

       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.
        clearwclear ルーチンは erasewerase に似ていますが、
       これらは clearok も呼び出すため、ウインドウに対する
       次の wrefresh 呼び出しで画面は完全に消去され、
       初めから描き直されます。

       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.
        clrtobotwclrtobot ルーチンは、カーソル位置から
       画面の最後までを消去します。
        すなわち、ウインドウのカーソルより下のすべての行を消去し、
        さらに、現在行のカーソル位置を含めてその右側をも消去します。

       The clrtoeol and wclrtoeol routines erase the current line
       to the right of the cursor, inclusive, to the end  of  the
       current line.
        clrtoeolwclrtoeol ルーチンは現在行のカーソル位置を
       含めてその右側を現在行の終わりまで消去します。

       Blanks created by erasure have the current background ren-
       dition (as set by wbkgdset) merged into them.
        消去で作成される空白は (wbkgdset で設定される) 現在の背景の
       表示属性を持つようになります。
       (訳注: wbkgdsetcurs_bkgd(3x) 参照)


RETURN VALUE 戻り値

       All routines return the integer OK on success and  ERR  on
       failure.   The SVr4.0 manual says "or a non-negative inte-
       ger if immedok is set", but this appears to be an error.
        すべてのルーチンは成功のとき整数 OK を、失敗のとき ERR を
       返します。
        SVr4.0 マニュアルには「または、immedok がセットされていれば
       負でない整数」と書かれていますが、これは間違いであると
       思われます。

       X/Open defines no error conditions.  In  this  implementa-
       tion, functions using a window pointer parameter return an
       error if it is null.
        X/Open はエラーの条件を何も定義していません。
        この実装では、ウインドウ・ポインタ引数を用いる関数は、
       その引数がヌルのとき、エラーを返します。


NOTES 注意

       Note that erase, werase, clear, wclear, clrtobot, and clr-
       toeol may be macros.
        erase, werase, clear, wclear, clrtobot, clrtoeol は
       マクロであるかもしれないことに注意してください。


PORTABILITY 移植性

       These  functions are described in the XSI Curses standard,
       Issue 4.  The standard specifies that they return  ERR  on
       failure, but specifies no error conditions.
        XSI Curses standard, Issue 4 はこれらの関数を記載しており、
       失敗のとき ERR を返すと明記していますが、エラーの条件を何も
       指定していません。

       Some  historic  curses  implementations had, as an undocu-
       mented feature,  the  ability  to  do  the  equivalent  of
       clearok(...,  1)  by saying touchwin(stdscr) or clear(std-
       scr).  This will not work under ncurses.
        curses の歴史的ないくつかの実装では、明文化されていない
       機能として、 touchwin(stdscr) または clear(stdscr) とする
       ことで clearok(..., 1) と同等な処理ができました。
        これは ncurses では動作しません。

       This implementation, and others such as Solaris, sets  the
       current  position  to  0,0  after erasing via werase() and
       wclear().  That fact is not documented in other  implemen-
       tations, and may not be true of implementations which were
       not derived from SVr4 source.
        この実装や Solaris のような他の実装では、werase()wclear() による消去の後に現在位置を 0, 0 に設定します。
        この事実は他の実装では明記されておらず、SVr4 のソースから
       派生していない実装では正しくないかもしれません。

       Not obvious from  the  description,  most  implementations
       clear  the screen after wclear even for a subwindow or de-
       rived window.  If you do not want to clear the screen dur-
       ing the next wrefresh, use werase instead.
        説明からは明らかでありませんが、多くの実装では
       子ウインドウや派生ウインドウに対しても wclear の後に
       画面を消去します。
        次の wrefresh まで画面を消去したくない場合は、
       代わりに werase を使ってください。


SEE ALSO 関連項目

       curses(3x),  curs_outopts(3x),  curs_refresh(3x), 
       curs_variables(3x)



                                                         curs_clear(3x)