curs_border(3X) | curs_border(3X) |
名称
border, wborder, box, hline, whline, vline, wvline, mvhline, mvwhline, mvvline, mvwvline - curses の境界線、水平線、垂直線を作成する書式
#include <curses.h>chtype tl, chtype tr, chtype bl, chtype br);
chtype ts, chtype bs, chtype tl, chtype tr,
chtype bl, chtype br);
解説
border, wborder と box ルーチンは、ウィンドウのエッジ (端) の回りにボックスを描画します。ウィンドウ以外の各引数は、次の属性がある文字です:
ls - 左側
rs - 右側
ts - 上側
bs - 下側
tl - 左上側の角
tr - 右上側の角
bl - 左下側の角
br - 右下側の角
これらの引数のいずれかが 0 であるなら、( curses.h に定義された) 対応するデフォルト値が代わりに使用されます:
ACS_VLINE,
ACS_VLINE,
ACS_HLINE,
ACS_HLINE,
ACS_ULCORNER,
ACS_URCORNER,
ACS_LLCORNER,
ACS_LRCORNER.
box(win, verch, horch) は、次の呼び出しの省略表現です:
wborder(win, verch, verch, horch, horch, 0, 0, 0, 0)。
hline と whline 関数は、ウィンドウ内の現在のカーソル位置から始まり ch を使用して水平線 (左から右へ) を描画します。現在のカーソル位置は、変更されません。線は、長くても n 文字の長さであるか、またはウィンドウに入るだけの長さになります。
vline と wvline 関数は、ウィンドウ内の現在のカーソル位置から始まり ch を使用して垂直線 (上端から下端へ) を描画します。現在のカーソル位置は、変更されません。線は、長くても n 文字の長さであるか、またはウィンドウに入るだけの長さになります。
戻り値
すべてのルーチンは、整数 OK を返します。 SVr4.0 マニュアルには、 "または、 immedok が設定されているなら、負でない整数"と書いてありますが、これは、間違いと思われます。X/Open は、エラー条件を何も定義していません。この実装は、ウィンドウのポインタが NULL であるなら、エラーを返します。
注
これらの関数によって生成された境界線 (border) は、 内側の境界線です (また、実際は、文書化されていませんが、SVr4 curses でも当てはまります)。border と box は、マクロであるかもしれないことに注意してください。