curses モジュールでは以下の例外を定義しています:
注意: 関数やメソッドにおけるオプションの引数 x および y がある場合、標準の値は常に現在のカーソルになります。 オプションの attr がある場合、標準の値は A_NORMAL です。
curses では以下の関数を定義しています:
| ) |
| ) |
| ) |
| ) |
| color_number) |
0 から COLORS の間でなければ
なりません。与えられた色の R、G、B、の値からなる三要素のタプルが
返されます。この値は 0 (その成分はない) から 1000
(その成分の最大強度) の範囲をとります。
| color_number) |
| visibility) |
| ) |
| ) |
| ms) |
| ) |
仮想スクリーンは addstr() のような書き込み操作をウィンドウに 行った後に noutrefresh() を呼び出して更新することができます。 通常の refresh() 呼び出しは、単に noutrefresh() を呼んだ後に doupdate() を呼ぶだけです; 複数のウィンドウを 更新しなければならない場合、全てのウィンドウに対して noutrefresh() を呼び出した後、一度だけ doupdate() を呼ぶことで、パフォーマンスを向上させることができ、おそらくスクリーン のちらつきも押さえることができます。
| ) |
| ) |
| ) |
| ) |
| ) |
| ) |
| ) |
(id, x, y, z, bstate) の
5 要素のタプルで表現されています。
id は複数のデバイスを区別するための ID 値で、
x、 y、z はイベントの座標値です
(現在 z は使われていません)。 bstate は整数値で、
その各ビットはイベントのタイプを示す値に設定されています。
この値は以下に示す定数のうち一つまたはそれ以上のビット単位 OR
になっています。以下の定数のn は 1 から 4 のボタン番号を
示します:
BUTTONn_PRESSED,
BUTTONn_RELEASED,
BUTTONn_CLICKED,
BUTTONn_DOUBLE_CLICKED,
BUTTONn_TRIPLE_CLICKED,
BUTTON_SHIFT,
BUTTON_CTRL,
BUTTON_ALT.
| ) |
| file) |
| ) |
| ) |
| ) |
| ch) |
| tenths) |
| color_number, r, g, b) |
0 から COLORS の間でなければなりません。
r、g、b の値は 0 から 1000 の
間でなければなりません。 init_color() を使うと、
スクリーン上でカラーが使用されている部分は全て新しい設定に
即時変更されます。この関数はほとんどの端末で何も行いません;
can_change_color() が 1 を返す場合にのみ
動作します。
| pair_number, fg, bg) |
1 から COLOR_PAIRS -1 の間でなければなりません
(0 色ペアは黒色背景に白色前景となるように設定されており、
変更することができません) 。fg および bg 引数は
0 と COLORS の間でなければなりません。
色ペアが以前に初期化されていれば、スクリーンを更新して、指定
された色ペアの部分を新たな設定に変更します。
| ) |
| ) |
| k) |
| ) |
| ) |
| yes) |
| interval) |
| mousemask) |
(availmask, oldmask)
の組からなるタプルを返します。
availmask はどの指定されたマウスイベントのどれが報告されるかを
示します; どのイベント指定も完全に失敗した場合には 0 が返ります。
oldmask は与えられたウィンドウの以前のマウスイベントマスク
です。この関数が呼ばれない限り、マウスイベントは何も報告されません。
| ms) |
| nlines, ncols) |
パッドはウィンドウと同じようなものですが、スクリーンのサイズによって 制限されており、スクリーンの特定の部分に関連付けられていなくても かまいません。大きなウィンドウが必要であり、スクリーンにはその ウィンドウの一部しか一度に表示しない場合に使うことができます。 (スクロールや入力エコーなどによる) パッドに対する再描画は起こりません。 パッドに対する refresh() および noutrefresh() メソッド は、パッド中の表示する部分と表示するために利用するスクリーン上の位置を 指定する 6 つの引数が必要です。これらの引数は pminrow、 pmincol、 sminrow、 smincol、 smaxrow、smaxcol です; p で始まる引数はパッド中の表示領域の左上位置で、s で始まる引数は パッド領域を表示するスクリーン上のクリップ矩形を指定します。
| [nlines, ncols,] begin_y, begin_x) |
(begin_y, begin_x) で、高さ/幅が
nlines/ncols の新規ウィンドウを返します。
標準では、ウィンドウは指定された位置からスクリーンの右下まで 広がります。
| ) |
| ) |
| ) |
| ) |
addch('\n') の振る舞いは変更せず、仮想スクリーン
上では常に復帰と改行に等しくなります)。変換をオフにすることで、
curses は水平方向の動きを少しだけ高速化できることがあります;
また、入力中のリターンキーの検出ができるようになります。
| ) |
| ) |
| pair_number) |
(fg, bg) からなる
タプルを返します。pair_number は 0 から
COLOR_PAIRS - 1 の間でなければなりません。
| attr) |
| string) |
tputs(str, 1, putchar) と等価です; 現在の端末における、
指定された terminfo 機能の値を出力します。putp の出力は常に標準
出力に送られるので注意して下さい。
| [flag]) |
| ) |
| ) |
| ) |
| y, x) |
| [termstr, fd]) |
sys.stdout のファイル記述子が使われます。
| ) |
start_color() は 8 つの基本色 (黒、赤、緑、黄、青、マゼンタ、 シアン、および白) と、色数の最大値と端末がサポートする色ペアの最大数 が入っている、curses モジュールにおける二つのグローバル変数、 COLORS および COLOR_PAIRS を初期化します。 この関数はまた、色設定を端末のスイッチが入れられたときの状態に 戻します。
| ) |
| ) |
| capname) |
-1
が返され、機能がキャンセルされているか、端末記述上に見つからない
場合には 0 を返します。
| capname) |
-2
が返され、機能がキャンセルされているか、端末記述上に見つからない
場合には -1 を返します。
| capname) |
None を返します。
| str[,...]) |
tparm(tigetstr("cup"), 5, 3)
は '\033[6;4H' のようになります。厳密には端末の形式に
よって異なる結果となります。
| fd) |
-1 の場合、先読みチェックは行われません。
curses ライブラリはスクリーンを更新する間、先読み文字列を定期的に 検索することで ``行はみ出し最適化 (line-breakout optimization)'' を行います。入力が得られ、かつ入力は端末からのものである場合、現在 行おうとしている更新は refresh や doupdate を再度呼び出すまで 先送りにします。この関数は異なるファイル記述子で先読みチェックを 行うように指定することができます。
| ch) |
^C のようにキャレットに続く文字として表示
されます。印字可能文字はそのままです。
| ch) |
| id, x, y, z, bstate) |
| flag) |
ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。