名称

scroll, scrl, wscrl - curses ウィンドウをスクロールする

書式

#include <curses.h> int scroll(WINDOW *win); int scrl(int n); int wscrl(WINDOW *win, int n);

解説

scroll ルーチンは、ウィンドウを 1 行上方にスクロールします。これは、ウィンドウのデータ構造内の行を移動することを伴います。ウィンドウのスクロール領域が画面全体であるなら、最適化として、物理的な画面は、同時にスクロールされます。

正の n がについて、 scrl と wscrl ルーチンは、ウィンドウを上方に n 行スクロールします (行 i+ n が i になります)。そうでなければ、ウィンドウを下方に n 行スクロールします。これは、ウィンドウ文字イメージ構造内の行を移動することを伴います。現在のカーソル位置は、変更されません。

これらの関数が動作するためには、 scrollok でスクロールを有効にしなければなりません。

戻り値

これらのルーチンは、失敗すると ERR を返し、成功して終了すれば、 OK (SVr4 は、" ERR 以外の整数値"とだけ明記されています) を返します。

X/Open は、エラー条件を何も定義していません。

この実装は、ウィンドウのポインタが NULL である、またはスクロールが、ウィンドウで、例えば、 scrollok で、有効にされていないなら、エラーを返します。

注

scrl と scroll は、マクロであるかもしれないことに注意してください。

SVr4 文書は、スクロール領域が全画面であるなら、物理的に直ちにスクロールする最適化が ("たぶん"実行 "されます"ではなく) 実行 "されます"、と書かれています。この実装は、次の更新で複数のスクロール動作のより賢い最適化の可能性を保留したままにするために、これが生じるだろうということを故意に保証していません。

SVr4 も XSI 文書も、スクロール関数によって生成された空白の現在の属性または現在の色ペアが 0 にされたかどうか明記していません。この実装下では、それはそうです。

移植性

XSI Curses standard, Issue 4 は、これらの関数を記述しています。

関連項目

curses(3X), curs_outopts(3X)