curs_mouse(3x) curs_mouse(3x)
has_mouse, getmouse, ungetmouse, mousemask, wenclose,
mouse_trafo, wmouse_trafo, mouseinterval - mouse interface
through curses
- curses によるマウス・インターフェイス
#include <curses.h>
typedef unsigned long mmask_t;
typedef struct {
short id; /* ID to distinguish multiple devices */
/* 複数デバイス識別用ID */
int x, y, z; /* event coordinates */
/* イベント座標 */
mmask_t bstate; /* button state bits */
/* ボタン状態ビット */
} MEVENT;
bool has_mouse(void);
int getmouse(MEVENT *event);
int ungetmouse(MEVENT *event);
mmask_t mousemask(mmask_t newmask, mmask_t *oldmask);
bool wenclose(const WINDOW *win, int y, int x);
bool mouse_trafo(int* pY, int* pX, bool to_screen);
bool wmouse_trafo(const WINDOW* win, int* pY, int* pX,
bool to_screen);
int mouseinterval(int erval);
These functions provide an interface to mouse events from
ncurses(3x). Mouse events are represented by KEY_MOUSE
pseudo-key values in the wgetch input stream.
これらの関数は ncurses(3x) からマウスイベントへの
インターフェイスを提供します。
マウスイベントは wgetch 入力ストリームの
擬似キー値 KEY_MOUSE で表されます。
(訳注: wgetch … curs_getch(3x) 参照)
To make mouse events visible, use the mousemask function.
This will set the mouse events to be reported. By de-
fault, no mouse events are reported. The function will
return a mask to indicate which of the specified mouse
events can be reported; on complete failure it returns 0.
If oldmask is non-NULL, this function fills the indicated
location with the previous value of the given window's
mouse event mask.
マウスイベントを可視化するには mousemask 関数を使います。
これはマウスイベントを報告するように設定します。
デフォルトでは、マウスイベントは報告されません。
この関数は、どのマウスイベントが報告されるかを示すマスクを
返します。完全に失敗した場合は 0 を返します。
oldmask が NULL でない場合、この関数は指定されたウインドウの
以前のマウスイベント・マスクの値をポインタの指す場所に
格納します。
(訳注: ウインドウに関連付ける引数はありません)
As a side effect, setting a zero mousemask may turn off
the mouse pointer; setting a nonzero mask may turn it on.
Whether this happens is device-dependent.
副作用として、mousemask にゼロを設定するとマウスポインタが
オフになることがあります。非ゼロ値のマスクを設定すると、
オンになることがあります。
これが起こるかどうかはデバイス依存です。
Here are the mouse event type masks which may be defined:
定義されたマウスイベント型マスクを次の表に示します。
Name Description
名前 説明
---------------------------------------------------------------------
BUTTON1_PRESSED mouse button 1 down
BUTTON1_PRESSED マウスボタン 1 押下 (押されること)
BUTTON1_RELEASED mouse button 1 up
BUTTON1_RELEASED マウスボタン 1 解放 (離されること)
BUTTON1_CLICKED mouse button 1 clicked
BUTTON1_CLICKED マウスボタン 1 クリック
BUTTON1_DOUBLE_CLICKED mouse button 1 double clicked
BUTTON1_DOUBLE_CLICKED マウスボタン 1 ダブルクリック
BUTTON1_TRIPLE_CLICKED mouse button 1 triple clicked
BUTTON1_TRIPLE_CLICKED マウスボタン 1 トリプルクリック
---------------------------------------------------------------------
BUTTON2_PRESSED mouse button 2 down
BUTTON2_PRESSED マウスボタン 2 押下
BUTTON2_RELEASED mouse button 2 up
BUTTON2_RELEASED マウスボタン 2 解放
BUTTON2_CLICKED mouse button 2 clicked
BUTTON2_CLICKED マウスボタン 2 クリック
BUTTON2_DOUBLE_CLICKED mouse button 2 double clicked
BUTTON2_DOUBLE_CLICKED マウスボタン 2 ダブルクリック
BUTTON2_TRIPLE_CLICKED mouse button 2 triple clicked
BUTTON2_TRIPLE_CLICKED マウスボタン 2 トリプルクリック
---------------------------------------------------------------------
BUTTON3_PRESSED mouse button 3 down
BUTTON3_PRESSED マウスボタン 3 押下
BUTTON3_RELEASED mouse button 3 up
BUTTON3_RELEASED マウスボタン 3 解放
BUTTON3_CLICKED mouse button 3 clicked
BUTTON3_CLICKED マウスボタン 3 クリック
BUTTON3_DOUBLE_CLICKED mouse button 3 double clicked
BUTTON3_DOUBLE_CLICKED マウスボタン 3 ダブルクリック
BUTTON3_TRIPLE_CLICKED mouse button 3 triple clicked
BUTTON3_TRIPLE_CLICKED マウスボタン 3 トリプルクリック
---------------------------------------------------------------------
BUTTON4_PRESSED mouse button 4 down
BUTTON4_PRESSED マウスボタン 4 押下
BUTTON4_RELEASED mouse button 4 up
BUTTON4_RELEASED マウスボタン 4 解放
BUTTON4_CLICKED mouse button 4 clicked
BUTTON4_CLICKED マウスボタン 4 クリック
BUTTON4_DOUBLE_CLICKED mouse button 4 double clicked
BUTTON4_DOUBLE_CLICKED マウスボタン 4 ダブルクリック
BUTTON4_TRIPLE_CLICKED mouse button 4 triple clicked
BUTTON4_TRIPLE_CLICKED マウスボタン 4 トリプルクリック
---------------------------------------------------------------------
BUTTON5_PRESSED mouse button 5 down
BUTTON5_PRESSED マウスボタン 5 押下
BUTTON5_RELEASED mouse button 5 up
BUTTON5_RELEASED マウスボタン 5 解放
BUTTON5_CLICKED mouse button 5 clicked
BUTTON5_CLICKED マウスボタン 5 クリック
BUTTON5_DOUBLE_CLICKED mouse button 5 double clicked
BUTTON5_DOUBLE_CLICKED マウスボタン 5 ダブルクリック
BUTTON5_TRIPLE_CLICKED mouse button 5 triple clicked
BUTTON5_TRIPLE_CLICKED マウスボタン 5 トリプルクリック
---------------------------------------------------------------------
BUTTON_SHIFT shift was down during button state change
BUTTON_SHIFT ボタンの状態変化中にシフト押下
BUTTON_CTRL control was down during button state change
BUTTON_CTRL ボタンの状態変化中にコントロール押下
BUTTON_ALT alt was down during button state change
BUTTON_ALT ボタンの状態変化中に Alt 押下
ALL_MOUSE_EVENTS report all button state changes
ALL_MOUSE_EVENTS すべてのボタン状態変化を報告する
REPORT_MOUSE_POSITION report mouse movement
REPORT_MOUSE_POSITION マウスの動きを報告する
---------------------------------------------------------------------
Once a class of mouse events has been made visible in a
window, calling the wgetch function on that window may re-
turn KEY_MOUSE as an indicator that a mouse event has been
queued. To read the event data and pop the event off the
queue, call getmouse. This function will return OK if a
mouse event is actually visible in the given window, ERR
otherwise. When getmouse returns OK, the data deposited
as y and x in the event structure coordinates will be
screen-relative character-cell coordinates. The returned
state mask will have exactly one bit set to indicate the
event type. The corresponding data in the queue is marked
invalid. A subsequent call to getmouse will retrieve the
next older item from the queue.
ウインドウでマウスイベントの種類が可視になった後、
そのウインドウで wgetch 関数を呼び出すと、マウスイベントが
キューにあることを知らせるため KEY_MOUSE を返します。
イベントのデータを読み出し、キューからイベントを
取り出すには、getmouse を呼び出します。
この関数は、指定のウインドウでマウスイベントが実際に
可視ならば OK を、そうでなければ ERR を返します。
getmouse が OK を返したとき、イベント構造体の座標 y と x
として置かれたデータは、文字を置くマスの、画面に相対的な
座標です。
返された状態マスクは、イベントの種類を示すため、きっかり
1 ビットがセットされています。
キュー中の対応するデータは無効としてマークされます。
続けて getmouse を呼び出すと、キューから次に古い項目を
取り出します。
The ungetmouse function behaves analogously to ungetch.
It pushes a KEY_MOUSE event onto the input queue, and as-
sociates with that event the given state data and screen-
relative character-cell coordinates.
ungetmouse 関数の動作は ungetch に似ています。
KEY_MOUSE イベントを入力キューに戻し、そのイベントと
与えられた (ボタン) 状態データや、マスの画面に相対的な座標を
結びつけます。
(訳注: ungetch … curs_getch(3x) 参照)
The wenclose function tests whether a given pair of
screen-relative character-cell coordinates is enclosed by
a given window, returning TRUE if it is and FALSE other-
wise. It is useful for determining what subset of the
screen windows enclose the location of a mouse event.
wenclose 関数はマスの画面に相対的な座標の与えられた組が
与えられたウインドウに含まれるかどうかを調べ、
そうであれば TRUE を、そうでなければ FALSE を返します。
これはマウスイベントの位置がどのウインドウに含まれるかを
決めるために便利です。
The wmouse_trafo function transforms a given pair of coor-
dinates from stdscr-relative coordinates to coordinates
relative to the given window or vice versa. The resulting
stdscr-relative coordinates are not always identical to
window-relative coordinates due to the mechanism to re-
serve lines on top or bottom of the screen for other pur-
poses (see the ripoffline and slk_init calls, for exam-
ple).
wmouse_trafo 関数は、与えられた座標の組を stdscr に相対的な
座標から与えられたウインドウに相対的な座標へと変換します。
または、その逆を行います。
変換結果である stdscr に相対的な座標は、常にウインドウに
相対的な座標と同じとは限りません。
これは、他の用途のために画面の最上部または最下部の行を
予約するしくみがあるためです。(例えば ripoffline と slk_init
呼び出しを参照)
o If the parameter to_screen is TRUE, the pointers pY,
pX must reference the coordinates of a location inside
the window win. They are converted to window-relative
coordinates and returned through the pointers. If the
conversion was successful, the function returns TRUE.
o 引数 to_screen が TRUE のとき、ポインタ pY, pX は
ウインドウ win 内の座標を参照していなければなりません。
これらはウインドウに相対的な座標に変換され、
ポインタを通して値が返されます。
正常に変換されると、関数は TRUE を返します。
o If one of the parameters was NULL or the location is
not inside the window, FALSE is returned.
o 引数のどれかが NULL だったとき、
または位置がウインドウの中でないとき、FALSE を返します。
o If to_screen is FALSE, the pointers pY, pX must refer-
ence window-relative coordinates. They are converted
to stdscr-relative coordinates if the window win en-
closes this point. In this case the function returns
TRUE.
o 引数 to_screen が FALSE のとき、pY, pX は
ウインドウに相対的な座標を参照していなければなりません。
ウインドウ win がこの点を含んでいれば、これらは stdscr に
相対的な座標に変換されます。
この場合、関数は TRUE を返します。
o If one of the parameters is NULL or the point is not
inside the window, FALSE is returned. The referenced
coordinates are only replaced by the converted coordi-
nates if the transformation was successful.
o 引数のどれかが NULL だったとき、
または位置がウインドウの中でないとき、FALSE を返します。
正常に変換されると、参照される座標は変換後の座標に
単に置き換えられます。
The mouse_trafo function performs the same translation as
wmouse_trafo, using stdscr for win.
mouse_trafo 関数は win として stdscr を使って
wmouse_trafo と同じ変換を行います。
The mouseinterval function sets the maximum time (in thou-
sands of a second) that can elapse between press and re-
lease events for them to be recognized as a click. Use
mouseinterval(0) to disable click resolution. This func-
tion returns the previous interval value. Use mouseinter-
val(-1) to obtain the interval without altering it. The
default is one sixth of a second.
mouseinterval 関数は、クリックとして認識される押下と解放の
イベントの間に経過する最大の時間 (千秒単位) を設定します。
(訳注: 千分の 1 秒単位か)
クリックの分離を無効にするには mouseinterval(0) を
使ってください。
この関数は以前の間隔値を返します。
値を変化させずに時間間隔を得るには mouseinterval(-1) を
使ってください。
デフォルト値は 1/6 秒です。
The has_mouse function returns TRUE if the mouse driver
has been successfully initialized.
has_mouse 関数はマウスドライバが正常に初期化されていれば
TRUE を返します。
Note that mouse events will be ignored when input is in
cooked mode, and will cause an error beep when cooked mode
is being simulated in a window by a function such as get-
str that expects a linefeed for input-loop termination.
入力が cooked モードのとき、マウスイベントは無視されること、
そして入力ループを終了するために改行を期待する getstr のような
関数によって cooked モードがウインドウでシミュレート
されているときマウスイベントはエラー音を発生させることに
注意してください。
(訳注: cooked モード … curs_inopts(3x) 参照)
getmouse and ungetmouse return the integer ERR upon fail-
ure or OK upon successful completion:
getmouse と ungetmouse は失敗のとき整数 ERR を、
正常終了のとき OK を返します。
getmouse
returns an error.
次の場合にエラーを返します。
o If no mouse driver was initialized, or if the mask
parameter is zero,
o マウスドライバが初期化されていなかったとき、
またはマスク引数がゼロのとき
(訳注: mousemask の newmask か)
o It also returns an error if no more events remain
in the queue.
o キューにそれ以上イベントがない場合にもエラーを返します
ungetmouse
returns an error if the FIFO is full.
キューに空きがない場合にエラーを返します。
mousemask returns the mask of reportable events.
mousemask は報告可能なイベントのマスクを返します。
mouseinterval returns the previous interval value, unless
the terminal was not initialized. In that case, it re-
turns the maximum interval value (166).
mouseinterval は直前の間隔値を返します。ただし端末が
初期化されていなかった場合を除きます。この場合には
最大の間隔値 (166) を返します。
wenclose and wmouse_trafo are boolean functions returning
TRUE or FALSE depending on their test result.
wenclose と wmouse_trafo はそれぞれの調査結果によって
TRUE または FALSE を返すブール値関数です。
These calls were designed for ncurses(3x), and are not
found in SVr4 curses, 4.4BSD curses, or any other previous
version of curses.
これらの呼び出しは ncurses(3x) 用に設計されており、
SVr4 curses, 4.4BSD curses, その他 curses の以前の
バージョンにはみられません。
The feature macro NCURSES_MOUSE_VERSION is provided so the
preprocessor can be used to test whether these features
are present. If the interface is changed, the value of
NCURSES_MOUSE_VERSION will be incremented. These values
for NCURSES_MOUSE_VERSION may be specified when configur-
ing ncurses:
機能が存在するかどうかをプリプロセッサを使って調べるために
マクロ NCURSES_MOUSE_VERSION が提供されます。
インターフェイスが変更されると、NCURSES_MOUSE_VERSION の値は
増加します。
ncurses を構成するとき NCURSES_MOUSE_VERSION に次の値が
設定されます。
1 has definitions for reserved events. The mask uses
28 bits.
1 予約されたイベントのための定義を持ちます。
マスクは 28 ビットを使います。
2 adds definitions for button 5, removes the defini-
tions for reserved events. The mask uses 29 bits.
2 ボタン 5 の定義を加え、予約されたイベントのための定義を
削除しています。
マスクは 29 ビットを使います。
The order of the MEVENT structure members is not guaran-
teed. Additional fields may be added to the structure in
the future.
MEVENT 構造体のメンバの順序は保証されません。
将来、構造体に追加の項目が加えられるかもしれません。
Under ncurses(3x), these calls are implemented using ei-
ther xterm's built-in mouse-tracking API or platform-spe-
cific drivers including
ncurses(3x) では、これらの呼び出しは xterm の組込みマウス(追跡)
API も、プラットフォーム依存の以下を含むドライバも使うように
実装されています。
o Alessandro Rubini's gpm server
o FreeBSD sysmouse
o OS/2 EMX
If you are using an unsupported configuration, mouse
events will not be visible to ncurses(3x) (and the mouse-
mask function will always return 0).
サポートされていない構成を使っている場合、マウスイベントは
ncurses(3x) で可視になりません。(そして mousemask 関数は常に
0 を返します。)
If the terminfo entry contains a XM string, this is used
in the xterm mouse driver to control the way the terminal
is initialized for mouse operation. The default, if XM is
not found, corresponds to private mode 1000 of xterm:
terminfo 収録項目に XM 文字列が含まれていれば、
xterm マウスドライバがマウス操作のために端末を初期化する方法を
制御するために使われます。
デフォルトで、XM が見つからない場合、xterm の
プライベート・モード 1000 に対応するのは
\E[?1000%?%p1%{1}%=%th%el%;
です。
The z member in the event structure is not presently used.
It is intended for use with touch screens (which may be
pressure-sensitive) or with 3D-mice/trackballs/power
gloves.
イベント構造体のメンバ z は現在使われていません。
これは (感圧式などの) タッチスクリーンや３Ｄマウス、
トラックボール、パワーグローブで使うことを意図したものです。
The ALL_MOUSE_EVENTS class does not include RE-
PORT_MOUSE_POSITION. They are distinct. For example, in
xterm, wheel/scrolling mice send position reports as a se-
quence of presses of buttons 4 or 5 without matching but-
ton-releases.
ALL_MOUSE_EVENTS クラスは REPORT_MOUSE_POSITION を含みません。
両者は別のものです。
例えば、xterm では、ホイールマウス、スクロールマウスは
位置情報をボタン 4 または 5 の一連の押下として送信し、
ボタン解放とのマッチングをしません。
Mouse events under xterm will not in fact be ignored dur-
ing cooked mode, if they have been enabled by mousemask.
Instead, the xterm mouse report sequence will appear in
the string read.
xterm でのマウスイベントは、もし mousemask で有効に
なっている場合には、実のところ cooked モードの間、
無視されません。
代わりに xterm マウス報告シーケンスが読み込んだ文字列中に
現れます。
Mouse events under xterm will not be detected correctly in
a window with its keypad bit off, since they are inter-
preted as a variety of function key. Your terminfo de-
scription should have kmous set to "\E[M" (the beginning
of the response from xterm for mouse clicks). Other val-
ues for kmous are permitted, but under the same assump-
tion, i.e., it is the beginning of the response.
keypad ビットがオフのウインドウでは xterm のマウスイベントは
種々のファンクションキーに変換されるため正しく検出されません。
terminfo 記述で kmous を "\E[M" に設定しなくてはなりません
(xterm からのマウスクリックの応答の開始) 。
kmous の他の値も許されますが、同じ仮定のもとで、
つまり応答の開始としてです。
(訳注: keypad … curs_inopts(3x) 参照)
Because there are no standard terminal responses that
would serve to identify terminals which support the xterm
mouse protocol, ncurses assumes that if your $TERM envi-
ronment variable contains "xterm", or kmous is defined in
the terminal description, then the terminal may send mouse
events.
xterm マウス・プロトコルをサポートする端末を
識別するのに役立つ標準的な端末応答が存在しないため、
環境変数 $TERM が "xterm" を含んでいるか、
または端末記述の中に kmous が定義されている場合に、
端末がマウスイベントを送れるものと ncurses は仮定します。
curses(3x), curs_kernel(3x), curs_slk(3x),
curs_variables(3x).
curs_mouse(3x)