curs_attr(3x) curs_attr(3x)
attroff, wattroff, attron, wattron, attrset, wattrset,
color_set, wcolor_set, standend, wstandend, standout,
wstandout, attr_get, wattr_get, attr_off, wattr_off,
attr_on, wattr_on, attr_set, wattr_set, chgat, wchgat,
mvchgat, mvwchgat, PAIR_NUMBER - curses character and
window attribute control routines
- curses 文字とウインドウの属性操作ルーチン
#include <curses.h>
int attroff(int attrs);
int wattroff(WINDOW *win, int attrs);
int attron(int attrs);
int wattron(WINDOW *win, int attrs);
int attrset(int attrs);
int wattrset(WINDOW *win, int attrs);
int color_set(short color_pair_number, void* opts);
int wcolor_set(WINDOW *win, short color_pair_number,
void* opts);
int standend(void);
int wstandend(WINDOW *win);
int standout(void);
int wstandout(WINDOW *win);
int attr_get(attr_t *attrs, short *pair, void *opts);
int wattr_get(WINDOW *win, attr_t *attrs, short *pair,
void *opts);
int attr_off(attr_t attrs, void *opts);
int wattr_off(WINDOW *win, attr_t attrs, void *opts);
int attr_on(attr_t attrs, void *opts);
int wattr_on(WINDOW *win, attr_t attrs, void *opts);
int attr_set(attr_t attrs, short pair, void *opts);
int wattr_set(WINDOW *win, attr_t attrs, short pair, void
*opts);
int chgat(int n, attr_t attr, short color,
const void *opts);
int wchgat(WINDOW *win, int n, attr_t attr,
short color, const void *opts);
int mvchgat(int y, int x, int n, attr_t attr,
short color, const void *opts);
int mvwchgat(WINDOW *win, int y, int x, int n,
attr_t attr, short color, const void *opts);
PAIR_NUMBER(attrs);
These routines manipulate the current attributes of the
named window. The current attributes of a window apply to
all characters that are written into the window with wadd-
ch, waddstr and wprintw. Attributes are a property of the
character, and move with the character through any
scrolling and insert/delete line/character operations. To
the extent possible, they are displayed as appropriate
modifications to the graphic rendition of characters put
on the screen.
これらのルーチンは指定のウインドウの現在の属性値を
操作します。
ウインドウの現在の属性値は waddch, waddstr, wprintw で
書き込まれるすべての文字に適用されます。
属性は文字のプロパティで、スクロールや行/文字の挿入/削除
操作を通じて文字とともに移動します。
属性は可能な範囲で、画面上の文字の表示様式の
適切な修飾として表示されます。
The routine attrset sets the current attributes of the
given window to attrs. The routine attroff turns off the
named attributes without turning any other attributes on
or off. The routine attron turns on the named attributes
without affecting any others. The routine standout is the
same as attron(A_STANDOUT). The routine standend is the
same as attrset(A_NORMAL) or attrset(0), that is, it turns
off all attributes.
attrset ルーチンは指定のウインドウの現在の属性値を attrs に
セットします。
attroff ルーチンは、他の属性をオン/オフすることなく、
指定の属性をオフにします。
attron ルーチンは、他の属性に影響を与えることなく、
指定の属性をオンにします。
standout ルーチンは attron(A_STANDOUT) と同じです。
standend ルーチンは attrset(A_NORMAL) または attrset(0) と
同じで、すべての属性をオフにします。
The attrset and related routines do not affect the at-
tributes used when erasing portions of the window. See
curs_bkgd(3x) for functions which modify the attributes
used for erasing and clearing.
attrset やこれに関連するルーチンは、ウインドウ内の一部を
消去するときに使う属性には影響を与えません。
消去とクリアに用いる属性を変更する関数については
curs_bkgd(3x) を参照してください。
The attrset routine is actually a legacy feature predating
SVr4 curses but kept in X/Open Curses for the same reason
that SVr4 curses kept it: compatibility. The routine at-
tr_set provides for passing a color-pair parameter.
attrset ルーチンは実際には SVr4 curses に先行する
古い機能ですが、 X/Open Curses では SVr4 curses と同じ理由、
すなわち互換性のために残されています。
attr_set ルーチンは色のペアを引数として渡すために
用意されています。
The remaining attr_* functions operate exactly like the
corresponding attr* functions, except that they take argu-
ments of type attr_t rather than int.
その他の attr_* 関数は int 型の代わりに attr_t 型の引数を
取ることを除き、対応する attr* 関数と全く同じように動作します。
The routine color_set sets the current color of the given
window to the foreground/background combination described
by the color_pair_number. The parameter opts is reserved
for future use, applications must supply a null pointer.
color_set ルーチンは、与えられたウインドウの現在色を
color_pair_number で指定した前景色/背景色の組に設定します。
引数 opts は将来のために予約されており、ヌルポインタを
与えなくてはなりません。
The routine wattr_get returns the current attribute and
color pair for the given window; attr_get returns the cur-
rent attribute and color pair for stdscr.
wattr_get ルーチンは指定のウインドウにおける
現在の属性と色のペアを返します。
attr_get ルーチンは stdscr における
現在の属性と色のペアを返します。
There is no corresponding attrget function as such in
X/Open Curses, although ncurses provides getattrs (see
curs_legacy(3x)).
X/Open Curses のように attrget に対応する関数はありませんが、
ncurses は getattrs を用意しています。
(curs_legacy(3x) を参照してください。)
The routine chgat changes the attributes of a given number
of characters starting at the current cursor location of
stdscr. It does not update the cursor and does not per-
form wrapping. A character count of -1 or greater than
the remaining window width means to change attributes all
the way to the end of the current line. The wchgat func-
tion generalizes this to any window; the mvwchgat function
does a cursor move before acting. In these functions, the
color argument is a color-pair index (as in the first ar-
gument of init_pair, see curs_color(3x)). The opts argu-
ment is not presently used, but is reserved for the future
(leave it NULL).
chgat ルーチンは stdscr の現在のカーソル位置から始まる
与えられた文字数分の属性値を変更します。
chgat ルーチンはカーソル位置を変更せず、文字列の折返しも
行いません。
文字数が -1 またはウインドウ幅の残りよりも大きな文字数は、
現在行の終わりまですっかり属性値を変更することを意味します。
wchgat 関数は、これを任意のウインドウに対して一般化します。
mvwchgat 関数は、動作の前にカーソル位置を移動させます。
これらの関数で、引数 color は色のペアの番号です。
( init_pair の第 1 引数と同様に。 curs_color(3x) を
参照してください。)
引数 opts は現在使われていませんが、将来のために予約されて
います。( NULL としてください。)
The following video attributes, defined in <curses.h>, can
be passed to the routines attron, attroff, and attrset, or
OR'd with the characters passed to addch (see curs_add-
ch(3x)).
<curses.h> で定義されている下記の表示属性を
attron, attroff, attrset ルーチンに渡すことができます。
文字と論理和( OR )を取った値を addch に渡すことができます。
( curs_addch(3x) を参照してください。)
Name Description
名前 説明
------------------------------------------------------------
A_NORMAL Normal display (no highlight) 通常表示(強調なし)
A_STANDOUT Best highlighting mode of the terminal. 端末で最高の強調モード
A_UNDERLINE Underlining 下線つき
A_REVERSE Reverse video 反転
A_BLINK Blinking 点滅
A_DIM Half bright 半暗
A_BOLD Extra bright or bold 高輝度または太字
A_PROTECT Protected mode プロテクトモード
A_INVIS Invisible or blank mode 不可視または空白モード
A_ALTCHARSET Alternate character set 代替文字セット
A_ITALIC Italics (non-X/Open extension) イタリック(X/Open 拡張外)
A_CHARTEXT Bit-mask to extract a character 文字を取り出すためのビットマスク
COLOR_PAIR(n) Color-pair number n 色のペアの番号 n
These video attributes are supported by attr_on and relat-
ed functions (which also support the attributes recognized
by attron, etc.):
下記の表示属性は、 attr_on とこれに関連する関数が
サポートします。( attron 他が認識する属性もサポートします。)
Name Description
名前 説明
-----------------------------------------
WA_HORIZONTAL Horizontal highlight 水平強調
WA_LEFT Left highlight 左強調
WA_LOW Low highlight 下強調
WA_RIGHT Right highlight 右強調
WA_TOP Top highlight 上強調
WA_VERTICAL Vertical highlight 垂直強調
For consistency 一貫性のために
The following macro is the reverse of COLOR_PAIR(n):
次のマクロは COLOR_PAIR(n) の逆です。
PAIR_NUMBER(attrs) Returns the pair number associated
with the COLOR_PAIR(n) attribute.
COLOR_PAIR(n) 属性に関係づけられた色のペアの番号を返します。
The return values of many of these routines are not mean-
ingful (they are implemented as macro-expanded assignments
and simply return their argument). The SVr4 manual page
claims (falsely) that these routines always return 1.
大半のルーチンの戻り値は無意味です。(これらは
マクロ拡張された代入文として実装されており、単純に引数の値を
返します。) (訳注: この記述は古いかもしれません。
戻り値の節も参照してください。)
SVr4 のマニュアル・ページには(誤って)これらのルーチンは
常に 1 を返すと書かれています。
Note that attroff, wattroff, attron, wattron, attrset,
wattrset, standend and standout may be macros.
attroff, wattroff, attron, wattron, attrset,
wattrset, standend, standout はマクロであるかもしれないことに
注意してください。
COLOR_PAIR values can only be OR'd with attributes if the
pair number is less than 256. The alternate functions
such as color_set can pass a color pair value directly.
However, ncurses ABI 4 and 5 simply OR this value within
the alternate functions. You must use ncurses ABI 6 to
support more than 256 color pairs.
COLOR_PAIR の値は色のペアの数(番号??)が 256 未満のときのみ、
属性値と論理和( OR )を取ることができます。
color_set のような代替関数には、色のペアの値を直接渡すことが
できます。
しかし、 ncurses ABI 4 と 5 は代替関数の内部で単にこの値を
OR しているだけです。
256 を超える色のペアをサポートするには、 ncurses ABI 6 を
使う必要があります。
These functions are supported in the XSI Curses standard,
Issue 4. The standard defined the dedicated type for
highlights, attr_t, which is not defined in SVr4 curses.
The functions taking attr_t arguments are not supported
under SVr4.
これらの関数は XSI Curses standard, Issue 4 で
サポートされています。
XSI Curses standard では強調表示専用の型 attr_t を
定義していますが、 SVr4 curses では定義していません。
attr_t 型の引数を取る関数は、 SVr4 curses では
サポートされません。
The XSI Curses standard states that whether the tradition-
al functions attron/attroff/attrset can manipulate at-
tributes other than A_BLINK, A_BOLD, A_DIM, A_REVERSE,
A_STANDOUT, or A_UNDERLINE is "unspecified". Under this
implementation as well as SVr4 curses, these functions
correctly manipulate all other highlights (specifically,
A_ALTCHARSET, A_PROTECT, and A_INVIS).
XSI Curses standard は、従来からの attron/attroff/attrset
関数が A_BLINK, A_BOLD, A_DIM, A_REVERSE, A_STANDOUT,
A_UNDERLINE 以外の属性を取り扱えるかどうかは「未指定」
としています。
この実装では SVr4 curses と同様、これらの関数は他の強調表示
(具体的には A_ALTCHARSET, A_PROTECT, A_INVIS )もすべて正しく
取り扱います。
This implementation provides the A_ITALIC attribute for
terminals which have the enter_italics_mode (sitm) and ex-
it_italics_mode (ritm) capabilities. Italics are not men-
tioned in X/Open Curses. Unlike the other video at-
tributes, I_ITALIC is unrelated to the set_attributes ca-
pabilities. This implementation makes the assumption that
exit_attribute_mode may also reset italics.
この実装は enter_italics_mode (sitm) と
exit_italics_mode (ritm) 機能項目を持つ端末のために、
A_ITALIC 属性を用意しています。
イタリック体は X/Open Curses には記載されていません。
他の表示属性と違って、 I_ITALIC は set_attributes 機能項目に
関係づけられていません。
この実装は exit_attribute_mode はイタリック体もリセット
するものと仮定しています。
XSI Curses added the new entry points, attr_get, attr_on,
attr_off, attr_set, wattr_on, wattr_off, wattr_get, wat-
tr_set. These are intended to work with a new series of
highlight macros prefixed with WA_. The older macros have
direct counterparts in the newer set of names:
XSI Curses は新しいルーチン attr_get, attr_on, attr_off,
attr_set, wattr_on, wattr_off, wattr_get, wattr_set を
追加しています。
これらは WA_ で始まる一連の新しい強調表示用マクロとともに
動作するよう意図されています。
従来のマクロに対応するものが、下記の新しいマクロの中に
含まれます。
Name Description
名前 説明
------------------------------------------------------------
WA_NORMAL Normal display (no highlight) 通常表示(強調なし)
WA_STANDOUT Best highlighting mode of the terminal. 端末で最高の強調モード
WA_UNDERLINE Underlining 下線つき
WA_REVERSE Reverse video 反転
WA_BLINK Blinking 点滅
WA_DIM Half bright 半暗
WA_BOLD Extra bright or bold 高輝度または太字
WA_ALTCHARSET Alternate character set 代替文字セット
Very old versions of this library did not force an update
of the screen when changing the attributes. Use touchwin
to force the screen to match the updated attributes.
このライブラリのとても古いバージョンは、属性が変化した時に
画面の更新を強制しません。更新した属性を強制的に
画面に反映するには、 touchwin を使ってください。
The XSI curses standard specifies that each pair of corre-
sponding A_ and WA_-using functions operates on the same
current-highlight information.
XSI curses standard は、 A_ と WA_ を使う対応する関数の
ペアは、現在の強調表示に関する同じ情報を操作するように
指定しています。
The XSI standard extended conformance level adds new high-
lights A_HORIZONTAL, A_LEFT, A_LOW, A_RIGHT, A_TOP, A_VER-
TICAL (and corresponding WA_ macros for each). As of Au-
gust 2013, no known terminal provides these highlights
(i.e., via the sgr1 capability).
XSI standard extended conformance level は新しい強調表示属性
A_HORIZONTAL, A_LEFT, A_LOW, A_RIGHT, A_TOP, A_VERTICAL を
追加しています(そしてそれぞれに対応する WA_ マクロも)。
2013年 8月現在、( sgr1 機能項目を通じて)
これらの強調表示属性を与える端末は知られていません。
All routines return the integer OK on success, or ERR on
failure.
すべてのルーチンは、正常終了すると整数 OK を、失敗すると
ERR を返します。
X/Open does not define any error conditions.
X/Open はエラーの条件を何も定義していません。
This implementation returns an error if the window pointer
is null. The wcolor_set function returns an error if the
color pair parameter is outside the range 0..COL-
OR_PAIRS-1. This implementation also provides getattrs
for compatibility with older versions of curses.
この実装では、ウインドウ・ポインタがヌルのときにエラーを
返します。
wcolor_set 関数は色のペアの引数が 0 〜 COLOR_PAIRS-1 の
範囲外のときにエラーを返します。
この実装は古いバージョンの curses との互換性のために
getattrs を用意しています。
Functions with a "mv" prefix first perform a cursor move-
ment using wmove, and return an error if the position is
outside the window, or if the window pointer is null.
mv で始まる関数は、まず wmove を使ってカーソルを移動させ、
カーソルの位置がウインドウの外になった場合と
ウインドウ・ポインタがヌルの場合にエラーを返します。
curses(3x), curs_addch(3x), curs_addstr(3x),
curs_bkgd(3x), curs_printw(3x), curs_variables(3x)
curs_attr(3x)