curs_util(3)

名称
unctrl, keyname, filter, use_env, putwin, getwin, delay_output, flushinp - miscellaneous ncurses utility routines

書式
#include <ncurses.h> char *unctrl(chtype c);
char *keyname(int c);
int filter(void);
void use_env(char bool);
int putwin(WINDOW *win, FILE *filep);
WINDOW *getwin(FILE *filep);
int delay_output(int ms);
int flushinp(void);

解説
unctrl マクロは、キャラクタ c の印刷可能な表現であるキャラクタストリングに 展開されます。制御キャラクタは ^X 表記で表示されます。印刷キャラクタ はそのとおりに表示されます。 keyname ルーチンは、キー c に対応するキャラクタストリングを返します。 filter ルーチンを使用する場合は、 initscr または newterm の前に呼び出す必要があります。そうすると ncurses は 1 行画面があると認識します。 ncurses は、画面のどの行にカーソルが配置されているか認識できることを想定する 端末機能を使用しません。 use_env ルーチンを使用する場合は、 initscr または newterm の前に呼び出す必要があります。引数として FALSE を指定して呼び出された場合、 terminfo データベースに指定された line と column の値が使用されます。環境変数 LINES と COLUMNS ( デフォルトで使用されます ) が設定されていても、または ncurses がウィンドウで実行されていてもです ( この場合、 LINES と COLUMNS が 設定されていない場合、デフォルトの動作ではウィンドウサイズを使用します ) 。 putwin ルーチンは、ウィンドウ win に対応するすべてのデータを filep が指すファイルに書き込みます。この情報は、 getwin 関数を使用して後で取り出すことができます。 getwin ルーチンは、 putwin によってファイルに保存されたウィンドウ関連データ を読み取ります。次に、このルーチンは、そのデータを使用して新しいウィンドウ を作成および初期化し、新しいウィンドウを指すポインタを返してきます。 delay_output ルーチンは、出力に ms ミリ秒を挿入します。このルーチンは広汎に使用しないでください。 CPU 休止ではなくパッドキャラクタが使用されるからです。 flushinp ルーチンは、ユーザが入力し、プログラムがまだ読み取っていない入力 ヘッドを廃棄します。

戻り値
flushinp を除いて、すべてのルーチンが、処理失敗すると整数 ERR を返してきます。処理が正常に完了した場合は、 ERR 以外の整数値を返します。 flushinp は必ず OK を返します。 ポインタを返すルーチンはエラーがあった場合は NULL を返します。

バグ
filter フィルタエントリ点はまだサポートされていません。

注釈
unctrl はマクロであることに注意してください。これは <unctrl.h> 内に定義されています。

関連項目
ncurses(3), curs_initscr(3), curs_scr_dmp(3).