curs_outopts(3x) curs_outopts(3x)
clearok, idlok, idcok, immedok, leaveok, setscrreg,
wsetscrreg, scrollok, nl, nonl - curses output options
出力オプション
#include <curses.h>
int clearok(WINDOW *win, bool bf);
int idlok(WINDOW *win, bool bf);
void idcok(WINDOW *win, bool bf);
void immedok(WINDOW *win, bool bf);
int leaveok(WINDOW *win, bool bf);
int setscrreg(int top, int bot);
int wsetscrreg(WINDOW *win, int top, int bot);
int scrollok(WINDOW *win, bool bf);
int nl(void);
int nonl(void);
These routines set options that change the style of output
within curses. All options are initially FALSE, unless
otherwise stated. It is not necessary to turn these op-
tions off before calling endwin.
これらのルーチンは、 curses での出力方法を変更する
オプションを設定します。
特記がない限り、すべてのオプションの初期値は FALSE です。
endwin を呼び出す前にこれらのオプションをオフにする必要は
ありません。
If clearok is called with TRUE as argument, the next call
to wrefresh with this window will clear the screen com-
pletely and redraw the entire screen from scratch. This
is useful when the contents of the screen are uncertain,
or in some cases for a more pleasing visual effect. If
the win argument to clearok is the global variable curscr,
the next call to wrefresh with any window causes the
screen to be cleared and repainted from scratch.
clearok を引数 TRUE とともに呼び出すと、このウインドウに
対する次の wrefresh 呼び出しは画面を完全に消去し、全画面を
初めから描き直します。
これは画面の内容が不確定なときや、ある場合にはより望ましい
視覚効果のために有用です。
clearok の引数 win が広域 (グローバル) 変数 curscr の場合は、
どのウインドウに対する次の wrefresh 呼び出しも画面を消去し、
初めから描き直します。
If idlok is called with TRUE as second argument, curses
considers using the hardware insert/delete line feature of
terminals so equipped. Calling idlok with FALSE as second
argument disables use of line insertion and deletion.
This option should be enabled only if the application
needs insert/delete line, for example, for a screen edi-
tor. It is disabled by default because insert/delete line
tends to be visually annoying when used in applications
where it is not really needed. If insert/delete line can-
not be used, curses redraws the changed portions of all
lines.
idlok を第 2 引数 TRUE とともに呼び出すと、 curses は端末に
備わっているハードウェアによる行の挿入/削除機能を使うことを
想定します。
idlok を第 2 引数 FALSE とともに呼び出すと、
行の挿入/削除機能の使用を無効にします。
このオプションは、例えばスクリーン・エディタのように
アプリケーションが行の挿入/削除を必要とする場合のみ
有効にしてください。
本当に必要としないアプリケーションで行の挿入/削除を使うと
見苦しくなりがちなので、デフォルトでは無効になっています。
行の挿入/削除が使えない場合、 curses はすべての行の
変更された部分を描画し直します。
If idcok is called with FALSE as second argument, curses
no longer considers using the hardware insert/delete char-
acter feature of terminals so equipped. Use of character
insert/delete is enabled by default. Calling idcok with
TRUE as second argument re-enables use of character inser-
tion and deletion.
idcok を第 2 引数 FALSE とともに呼び出すと、 curses は
端末に備わっているハードウェアによる文字挿入/削除機能を
使うことを考慮しなくなります。
文字挿入/削除機能の使用はデフォルトでは有効になっています。
idcok を第 2 引数 TRUE とともに呼び出すと、
文字挿入/削除機能の使用が再び有効になります。
If immedok is called with TRUE as argument, any change in
the window image, such as the ones caused by waddch, wclr-
tobot, wscrl, etc., automatically cause a call to wre-
fresh. However, it may degrade performance considerably,
due to repeated calls to wrefresh. It is disabled by de-
fault.
immedok を引数 TRUE とともに呼び出すと、例えば waddch,
wclrtobot, wscrl などによるどのようなウインドウ画像の変化も
自動的に wrefresh 呼び出しを引き起こします。
しかし、これは wrefresh 呼び出しを繰り返すため、
相当に性能が低下します。
デフォルトでは無効になっています。
Normally, the hardware cursor is left at the location of
the window cursor being refreshed. The leaveok option al-
lows the cursor to be left wherever the update happens to
leave it. It is useful for applications where the cursor
is not used, since it reduces the need for cursor motions.
通常、ハードウェアのカーソルはウインドウのカーソルが
更新された位置に置かれます。
leaveok オプションは、カーソルをどこに置こうとする
更新が起こっても、カーソル位置をそのままにします。
カーソルを動かす必要が減少するので、これはカーソルを
使わないアプリケーションに有用です。
The setscrreg and wsetscrreg routines allow the applica-
tion programmer to set a software scrolling region in a
window. The top and bot parameters are the line numbers
of the top and bottom margin of the scrolling region.
(Line 0 is the top line of the window.) If this option
and scrollok are enabled, an attempt to move off the bot-
tom margin line causes all lines in the scrolling region
to scroll one line in the direction of the first line.
Only the text of the window is scrolled. (Note that this
has nothing to do with the use of a physical scrolling re-
gion capability in the terminal, like that in the VT100.
If idlok is enabled and the terminal has either a
scrolling region or insert/delete line capability, they
will probably be used by the output routines.)
setscrreg と wsetscrreg ルーチンはウインドウ内に
ソフトウェア・スクロール領域を設定できるようにします。
引数 top と bot はスクロール領域の上マージンと下マージン
の行番号です。 (行 0 がウインドウの一番上の行です。)
このオプションと scrollok が有効ならば、下マージン行から
出ようとする動きは、スクロール領域内のすべての行が
最初の行に向かう方向に 1 行のスクロールを引き起こします。
ウインドウのテキストのみがスクロールされます。
( VT100 にあるような、端末の物理スクロール領域機能を
使うこととは関係がないことに注意してください。
idlok が有効で、端末がスクロール領域機能か
行の挿入/削除機能を持っているならば、これらはたぶん
出力ルーチンで使われるでしょう。)
The scrollok option controls what happens when the cursor
of a window is moved off the edge of the window or
scrolling region, either as a result of a newline action
on the bottom line, or typing the last character of the
last line. If disabled, (bf is FALSE), the cursor is left
on the bottom line. If enabled, (bf is TRUE), the window
is scrolled up one line (Note that to get the physical
scrolling effect on the terminal, it is also necessary to
call idlok).
scrollok オプションは、最下行での改行動作または最終行での
最終文字の入力により、ウインドウのカーソルがウインドウまたは
スクロール領域の端から出たときに起こる動作を制御します。
無効 (bf が FALSE) ならば、カーソルは最下行に残ります。
有効 (bf が TRUE) ならば、ウインドウは 1 行上へスクロール
します。
(端末で物理スクロール効果を得るためには、 idlok も
呼び出さなければならないことに注意してください。)
The nl and nonl routines control whether the underlying
display device translates the return key into newline on
input, and whether it translates newline into return and
line-feed on output (in either case, the call addch('\n')
does the equivalent of return and line feed on the virtual
screen). Initially, these translations do occur. If you
disable them using nonl, curses will be able to make bet-
ter use of the line-feed capability, resulting in faster
cursor motion. Also, curses will then be able to detect
the return key.
nl と nonl ルーチンは、基盤となる表示装置がリターンキーを
入力時に改行に変換するかどうか、そして改行を出力時に
リターンと行送りに変換するかどうかを制御します。
(どちらの場合も、 addch('\n') の呼び出しは仮想画面上での
リターンおよび行送りと同等な動作です。)
初期状態では、これらの変換が起こります。
nonl を使って無効にすると、 curses は line-feed (行送り)
機能をより良く使えるようになり、結果としてカーソルの動きが
速くなります。
そしてまた、 curses はリターンキーを検出できるように
なります。
The functions setscrreg and wsetscrreg return OK upon suc-
cess and ERR upon failure. All other routines that return
an integer always return OK.
setscrreg と wsetscrreg 関数は正常終了の場合に OK を、
失敗の場合に ERR を返します。
整数を返す他のすべてのルーチンは、常に OK を返します。
X/Open Curses does not define any error conditions.
X/Open Curses はエラーの条件を何も定義していません。
In this implementation, those functions that have a window
pointer will return an error if the window pointer is
null.
この実装では、ウインドウ・ポインタを持つそれらの関数は、
ウインドウ・ポインタがヌルの場合にエラーを返します。
wclrtoeol
returns an error if the cursor position is
about to wrap.
カーソル位置が折り返ししようとしているところ
だった場合にエラーを返します。
(訳注: このページで説明している関数ではありません)
wsetscrreg
returns an error if the scrolling region lim-
its extend outside the window.
スクロール領域の限界がウインドウの外に
広がっている場合にエラーを返します。
(訳注: 以下の説明は重複しています)
X/Open does not define any error conditions. This imple-
mentation returns an error if the window pointer is null.
X/Open はエラーの条件を何も定義していません。
この実装は、ウインドウ・ポインタがヌルの場合にエラーを
返します。
(訳注: ここまで)
These functions are described in the XSI Curses standard,
Issue 4.
これらの関数は XSI Curses standard, Issue 4 に
記載されています。
The XSI Curses standard is ambiguous on the question of
whether raw() should disable the CRLF translations con-
trolled by nl() and nonl(). BSD curses did turn off these
translations; AT&T curses (at least as late as SVr1) did
not. We choose to do so, on the theory that a programmer
requesting raw input wants a clean (ideally 8-bit clean)
connection that the operating system will not alter.
XSI Curses standard は、 raw() が nl() と nonl() の制御する
(リターンと行送りへの) CRLF 変換を無効にするべきかどうか
という問題に対してあいまいです。
BSD curses はこれらの変換を止めます。
AT&T curses (少なくとも SVr1 まで) は止めません。
ncurses は、 raw 入力を求めるならば、オペレーティング・
システム (OS) が変更しないクリーンな (理想的には 8 ビット
クリーンな) 接続を求めるであろうという理論に基づいて、
止めることにしました。
Some historic curses implementations had, as an undocu-
mented feature, the ability to do the equivalent of
clearok(..., 1) by saying touchwin(stdscr) or clear(std-
scr). This will not work under ncurses.
curses の歴史的ないくつかの実装では、明文化されていない
機能として、 touchwin(stdscr) または clear(stdscr) とする
ことで clearok(..., 1) と同等な処理ができました。
これは ncurses では動作しません。
Earlier System V curses implementations specified that
with scrollok enabled, any window modification triggering
a scroll also forced a physical refresh. XSI Curses does
not require this, and ncurses avoids doing it to perform
better vertical-motion optimization at wrefresh time.
初期の System V curses の実装では、 scrollok が有効なとき、
スクロールを引き起こすどのようなウインドウの変更も
物理的な更新 (リフレッシュ) を強制すると明示していました。
XSI Curses はこれを要求しません。
ncurses は wrefresh のときに垂直な動きの最適化をよりよく
行うため、これを行うことを避けています。
The XSI Curses standard does not mention that the cursor
should be made invisible as a side-effect of leaveok.
SVr4 curses documentation does this, but the code does
not. Use curs_set to make the cursor invisible.
XSI Curses standard は leaveok の副作用として、カーソルを
不可視にすることに言及していません。
SVr4 curses の説明文書ではこれを行いますが、コードは
これを行いません。
カーソルを不可視にするには curs_set を使ってください。
Note that clearok, leaveok, scrollok, idcok, nl, nonl and
setscrreg may be macros.
clearok, leaveok, scrollok, idcok, nl, nonl, setscrreg は
マクロであるかもしれないことに注意してください。
The immedok routine is useful for windows that are used as
terminal emulators.
immedok ルーチンは端末エミュレータとして使うウインドウに
有用です。
curses(3x), curs_addch(3x), curs_clear(3x),
curs_initscr(3x), curs_scroll(3x), curs_refresh(3x),
curs_variables(3x).
curs_outopts(3x)