cb5d1a9147
jpman project specific RCS keyword (jpman %Id) is obsolete, after manual entries are stored in freefall CVS repository. This old Id is useless and more worse it confuses users and bug reporters. So, this old Id is removed. Submitted by:jpman project <man-jp@jp.FreeBSD.org>
145 lines
2.9 KiB
Groff
145 lines
2.9 KiB
Groff
.\" $FreeBSD$
|
|
.TH curs_util 3 ""
|
|
.SH 名称
|
|
\fBunctrl\fR, \fBkeyname\fR, \fBfilter\fR,
|
|
\fBuse_env\fR, \fBputwin\fR, \fBgetwin\fR, \fBdelay_output\fR,
|
|
\fBflushinp\fR - miscellaneous \fBncurses\fR utility routines
|
|
.SH 書式
|
|
\fB#include <ncurses.h>\fR
|
|
|
|
\fBchar *unctrl(chtype c);\fR
|
|
.br
|
|
\fBchar *keyname(int c);\fR
|
|
.br
|
|
\fBint filter(void);\fR
|
|
.br
|
|
\fBvoid use_env(char bool);\fR
|
|
.br
|
|
\fBint putwin(WINDOW *win, FILE *filep);\fR
|
|
.br
|
|
\fBWINDOW *getwin(FILE *filep);\fR
|
|
.br
|
|
\fBint delay_output(int ms);\fR
|
|
.br
|
|
\fBint flushinp(void);\fR
|
|
.br
|
|
.SH 解説
|
|
\fBunctrl\fR
|
|
マクロは、キャラクタ
|
|
\fIc\fR
|
|
の印刷可能な表現であるキャラクタストリングに
|
|
展開されます。制御キャラクタは
|
|
\fB^\fR\fIX\fR
|
|
表記で表示されます。印刷キャラクタ
|
|
はそのとおりに表示されます。
|
|
|
|
\fBkeyname\fR
|
|
ルーチンは、キー
|
|
\fIc\fR
|
|
に対応するキャラクタストリングを返します。
|
|
|
|
\fBfilter\fR
|
|
ルーチンを使用する場合は、
|
|
\fBinitscr\fR
|
|
または
|
|
\fBnewterm\fR
|
|
の前に呼び出す必要があります。そうすると
|
|
\fBncurses\fR
|
|
は
|
|
1
|
|
行画面があると認識します。
|
|
\fBncurses\fR
|
|
は、画面のどの行にカーソルが配置されているか認識できることを想定する
|
|
端末機能を使用しません。
|
|
|
|
\fBuse_env\fR
|
|
ルーチンを使用する場合は、
|
|
\fBinitscr\fR
|
|
または
|
|
\fBnewterm\fR
|
|
の前に呼び出す必要があります。引数として
|
|
\fBFALSE\fR
|
|
を指定して呼び出された場合、
|
|
\fIterminfo\fR
|
|
データベースに指定された
|
|
\fBline\fR
|
|
と
|
|
\fBcolumn\fR
|
|
の値が使用されます。環境変数
|
|
\fBLINES\fR
|
|
と
|
|
\fBCOLUMNS\fR
|
|
(
|
|
デフォルトで使用されます
|
|
)
|
|
が設定されていても、または
|
|
\fBncurses\fR
|
|
がウィンドウで実行されていてもです
|
|
(
|
|
この場合、
|
|
\fBLINES\fR
|
|
と
|
|
\fBCOLUMNS\fR
|
|
が
|
|
設定されていない場合、デフォルトの動作ではウィンドウサイズを使用します
|
|
)
|
|
。
|
|
|
|
\fBputwin\fR
|
|
ルーチンは、ウィンドウ
|
|
\fIwin\fR
|
|
に対応するすべてのデータを
|
|
\fIfilep\fR
|
|
が指すファイルに書き込みます。この情報は、
|
|
\fBgetwin\fR
|
|
関数を使用して後で取り出すことができます。
|
|
|
|
\fBgetwin\fR
|
|
ルーチンは、
|
|
\fBputwin\fR
|
|
によってファイルに保存されたウィンドウ関連データ
|
|
を読み取ります。次に、このルーチンは、そのデータを使用して新しいウィンドウ
|
|
を作成および初期化し、新しいウィンドウを指すポインタを返してきます。
|
|
|
|
\fBdelay_output\fR
|
|
ルーチンは、出力に
|
|
\fIms\fR
|
|
ミリ秒を挿入します。このルーチンは広汎に使用しないでください。
|
|
CPU
|
|
休止ではなくパッドキャラクタが使用されるからです。
|
|
|
|
\fBflushinp\fR
|
|
ルーチンは、ユーザが入力し、プログラムがまだ読み取っていない入力
|
|
ヘッドを廃棄します。
|
|
.SH 戻り値
|
|
\fBflushinp\fR
|
|
を除いて、すべてのルーチンが、処理失敗すると整数
|
|
\fBERR\fR
|
|
を返してきます。処理が正常に完了した場合は、
|
|
\fBERR\fR
|
|
以外の整数値を返します。
|
|
|
|
\fBflushinp\fR
|
|
は必ず
|
|
\fBOK\fR
|
|
を返します。
|
|
|
|
ポインタを返すルーチンはエラーがあった場合は
|
|
\fBNULL\fR
|
|
を返します。
|
|
.SH バグ
|
|
\fBfilter\fR
|
|
フィルタエントリ点はまだサポートされていません。
|
|
.SH 注釈
|
|
\fBunctrl\fR
|
|
はマクロであることに注意してください。これは
|
|
<\fBunctrl.h\fR>
|
|
内に定義されています。
|
|
.SH 関連項目
|
|
\fBncurses\fR(3), \fBcurs_initscr\fR(3), \fBcurs_scr_dmp\fR(3).
|
|
.\"#
|
|
.\"# The following sets edit modes for GNU EMACS
|
|
.\"# Local Variables:
|
|
.\"# mode:nroff
|
|
.\"# fill-column:79
|
|
.\"# End:
|