curs_mouse(3X) | Miscellaneous Library Functions | curs_mouse(3X) |
typedef unsigned long mmask_t;
typedef struct { short id; /* ID to distinguish multiple devices */ 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);
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.
Name | Description |
BUTTON1_PRESSED | mouse button 1 down |
BUTTON1_RELEASED | mouse button 1 up |
BUTTON1_CLICKED | mouse button 1 clicked |
BUTTON1_DOUBLE_CLICKED | mouse button 1 double clicked |
BUTTON1_TRIPLE_CLICKED | mouse button 1 triple clicked |
BUTTON2_PRESSED | mouse button 2 down |
BUTTON2_RELEASED | mouse button 2 up |
BUTTON2_CLICKED | mouse button 2 clicked |
BUTTON2_DOUBLE_CLICKED | mouse button 2 double clicked |
BUTTON2_TRIPLE_CLICKED | mouse button 2 triple clicked |
BUTTON3_PRESSED | mouse button 3 down |
BUTTON3_RELEASED | mouse button 3 up |
BUTTON3_CLICKED | mouse button 3 clicked |
BUTTON3_DOUBLE_CLICKED | mouse button 3 double clicked |
BUTTON3_TRIPLE_CLICKED | mouse button 3 triple clicked |
BUTTON4_PRESSED | mouse button 4 down |
BUTTON4_RELEASED | mouse button 4 up |
BUTTON4_CLICKED | mouse button 4 clicked |
BUTTON4_DOUBLE_CLICKED | mouse button 4 double clicked |
BUTTON4_TRIPLE_CLICKED | mouse button 4 triple clicked |
BUTTON5_PRESSED | mouse button 5 down |
BUTTON5_RELEASED | mouse button 5 up |
BUTTON5_CLICKED | mouse button 5 clicked |
BUTTON5_DOUBLE_CLICKED | mouse button 5 double clicked |
BUTTON5_TRIPLE_CLICKED | mouse button 5 triple clicked |
BUTTON_SHIFT | shift was down during button state change |
BUTTON_CTRL | control was down during button state change |
BUTTON_ALT | alt was down during button state change |
ALL_MOUSE_EVENTS | report all button state changes |
REPORT_MOUSE_POSITION | report mouse movement |
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 getstr that expects a linefeed for input-loop termination.
mousemask returns the mask of reportable events.
mouseinterval returns the previous interval value, unless the terminal was not initialized. In that case, it returns the maximum interval value (166).
wenclose and wmouse_trafo are boolean functions returning TRUE or FALSE depending on their test result.
SVr4 curses had support for the mouse in a variant of xterm(1). It is mentioned in a few places, but with no supporting documentation:
extern int mouse_set(long int); extern int mouse_on(long int); extern int mouse_off(long int); extern int request_mouse_pos(void); extern int map_button(unsigned long); extern void wmouse_position(WINDOW *, int *, int *); extern unsigned long getmouse(void), getbmap(void);
buttons btns BT Number of buttons on the mouse get_mouse getm Gm Curses should get button events key_mouse kmous Km 0631, Mouse event has occurred mouse_info minfo Mi Mouse status information req_mouse_pos reqmp RQ Request mouse position report
When developing the xterm mouse support for ncurses in September 1995, Eric Raymond was uninterested in using the same interface due to its lack of documentation. Later, in 1998, Mark Hesseling provided support in PDCurses 2.3 using the SVr4 interface. PDCurses, however, does not use video terminals, making it unnecessary to be concerned about compatibility with the escape sequences.
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 configuring ncurses:
The order of the MEVENT structure members is not guaranteed. Additional fields may be added to the structure in the future.
Under ncurses(3X), these calls are implemented using either xterm's built-in mouse-tracking API or platform-specific drivers including
If you are using an unsupported configuration, mouse events will not be visible to ncurses(3X) (and the mousemask function will always return 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:
The mouse driver also recognizes a newer xterm private mode 1006, e.g.,
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.
The ALL_MOUSE_EVENTS class does not include REPORT_MOUSE_POSITION. They are distinct. For example, in xterm, wheel/scrolling mice send position reports as a sequence of presses of buttons 4 or 5 without matching button-releases.
Mouse events under xterm will not be detected correctly in a window with its keypad bit off, since they are interpreted as a variety of function key. Your terminfo description should have kmous set to “\E[M” (the beginning of the response from xterm for mouse clicks). Other values for kmous are permitted, but under the same assumption, i.e., it is the beginning of the response.
Because there are no standard terminal responses that would serve to identify terminals which support the xterm mouse protocol, ncurses assumes that if kmous is defined in the terminal description, or if the terminal description's primary name or aliases contain the string “xterm”, then the terminal may send mouse events. The kmous capability is checked first, allowing the use of newer xterm mouse protocols such as xterm's private mode 1006.
OmniOS |