.\" $FreeBSD$
.TH curs_pad 3 ""
.SH 名称
\fBnewpad\fR, \fBsubpad\fR, \fBprefresh\fR,
\fBpnoutrefresh\fR, \fBpechochar\fR - create and display \fBncurses\fR pads
.SH 書式
\fB#include <ncurses.h>\fR
\fBWINDOW *newpad(int nlines, int ncols);\fR
.br
\fBWINDOW *subpad(WINDOW *orig, int nlines, int ncols,
int begin_y, int begin_x);\fR
\fBint prefresh(WINDOW *pad, int pminrow, int pmincol,
int sminrow, int smincol, int smaxrow, int smaxcol);\fR
\fBint pnoutrefresh(WINDOW *pad, int pminrow, int pmincol,
int sminrow, int smincol, int smaxrow, int smaxcol);\fR
\fBint pechochar(WINDOW *pad, chtype ch);\fR
.SH 解説
\fBnewpad\fR
ルーチンは、指定された数の行
\fInlines\fR
と列
\fIncols\fR
がある新しい
パッドデータ構造を指すポインタを作成し返します。パッドはウィンドウに
類似していますが、画面サイズによって制限されない点、画面の特定の部分に
必ずしも対応していない点は異なります。パッドが使用できるのは、大きな
ウィンドウが必要であり、一度にウィンドウの一部だけが画面に
表示されるときです。パッドの自動的なリフレッシュ
(
\fIたとえば\fR、スクロールまたは
入力のエコーから
)
は発生しません。
\fIpad\fR
を引数として
\fBwrefresh\fR
を呼び出すのは
正しくありません。代わりに、ルーチン
\fBprefresh\fR
またはルーチン
\fBpnoutrefresh\fR
を呼び出す必要があります。表示されるパッドの一部、および表示に使用される
画面上の位置を指定する追加のパラメータがこれらのルーチンには
必要であることに注意してください。
\fBsubpad\fR
ルーチンは、パッド内の指定数の行
\fInlines\fR
と列
\fIncols\fR
があるパッド内の
サブウィンドウを指すポインタを作成し返します。画面座標を使用する
\fBsubwin\fR
と異なり、ウィンドウはパッド上の位置
(\fIbegin\fR_\fIx\fR\fB,\fR \fIbegin\fR_\fIy\fR)
にあります。ウィンドウ
はウィンドウ
\fIorig\fR
の中央に作成されるので、
1
つのウィンドウについて行われた
変更は両方のウィンドウに影響を及ぼします。このルーチンの使用の間、
\fBprefresh\fR
を呼び出す前に
\fIorig\fR
上で
\fBtouchwin\fR
または
\fBtouchline\fR
を呼び出すことがしばしば
必要になります。
\fBprefresh\fR
ルーチンおよび
\fBpnoutrefresh\fR
ルーチンは、
\fBwrefresh\fR
および
\fBwnoutrefresh\fR
と類似していますが、ウィンドウではなくパッドに関連している
点は異なります。パッドと画面のどの部分が関連しているのかを示すために、
追加のパラメータが必要です。
\fIpminrow\fR
と
\fIpmincol\fR
はパッド内で表示される
長方形の左上コーナーを指定します。
\fIsminrow\fR
、
\fIsmincol\fR
、
\fIsmaxrow\fR
、
\fIsmaxcol\fR
は、画面に表示される長方形のエッジを指定します。パッド内に表示される長方形の
右下コーナーは、画面座標から計算されます。長方形は同じサイズ
でなければならないからです。両方の長方形が、それぞれの構造の内部に完全に
入れられる必要があります。
\fIpminrow\fR
、
\fIpmincol\fR
、
\fIminrow\fR
、
\fIsmincol\fR
の値が負の場合は、ゼロであるかのように処理されます。
\fBpechochar\fR
ルーチンは、
\fBaddch\fR
の呼び出しの後の
\fBrefresh\fR
の呼び出し、
\fBwaddch\fR
の
呼び出しの後の
\fBwrefresh\fR
の呼び出し、または
\fBwaddch\fR
の呼び出しの後の
\fBprefresh\fR
の呼び出しと機能的に同等です。
1
文字しか出力されないという知識を
考慮に入れ、制御文字でないキャラクタについては、同等のルーチン
ではなくこれらのルーチンを使用することによって、相当な性能の向上が見られ
可能性があります。
\fBpechochar\fR
の場合、画面上のパッドの最後の位置が、
\fBprefresh\fR
への引数として再使用されます。
.SH 戻り値
整数を返すルーチンは、処理失敗すると
\fBERR\fR
を返してきます。処理が正常に
完了した場合は、
\fBERR\fR
以外の整数値を返します。
ポインタを返すルーチンはエラーがあった場合は
\fBNULL\fR
を返してきます。
.SH 注釈
\fBpechochar\fR
はマクロである可能性があることに注意してください。
.SH 関連項目
\fBncurses\fR(3), \fBcurs_refresh\fR(3), \fBcurs_touch\fR(3), \fBcurs_addch\fR(3)
.\"#
.\"# The following sets edit modes for GNU EMACS
.\"# Local Variables:
.\"# mode:nroff
.\"# fill-column:79
.\"# End:
