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). Mouse events are represented by KEY_MOUSE
+ pseudo-key values in the wgetch input stream.
- To make mouse events visible, use the mousemask function.
+ To make mouse events visible, use the mousemask function.
This will set the mouse events to be reported. By
default, no mouse events are reported. The function will
return a mask to indicate which of the specified mouse
@@ -54,14 +97,13 @@
Here are the mouse event type masks:
- NameDescription
+ NameDescription
---------------------------------------------------------------------
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
@@ -70,6 +112,7 @@
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
@@ -84,95 +127,104 @@
REPORT_MOUSE_POSITION report mouse movement
Once a class of mouse events have been made visible in a
- window, calling the wgetch function on that window may
- return KEY_MOUSE as an indicator that a mouse event has
+ window, calling the wgetch function on that window may
+ return 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
+ 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 ungetmouse function behaves analogously to ungetch.
- It pushes a KEY_MOUSE event onto the input queue, and
+ The ungetmouse function behaves analogously to ungetch.
+ It pushes a KEY_MOUSE event onto the input queue, and
associates with that event the given state data and
screen-relative character-cell coordinates.
- The wenclose function tests whether a given pair of
+ 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.
- The wmouse_trafo function transforms a given pair of coor-
+ The wmouse_trafo function transforms a given pair of coor-
dinates from stdscr-relative coordinates to screen-rela-
tive coordinates or vice versa. Please remember, that
stdscr-relative coordinates are not always identical to
screen-relative coordinates due to the mechanism to
reserve lines on top or bottom of the screen for other
- purposes (ripoff() call, see also slk_... functions). If
- the parameter to_screen is TRUE, the pointers pY,pX must
+ purposes (ripoff() call, see also slk_... functions). 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 screen-relative coordinates and
- returned through the pointers. If the conversion was suc-
- cessful, the function returns TRUE. If one of the parame-
- ters was NULL or the location is not inside the window,
- FALSE is returned. If to_screen is FALSE, the pointers pY,
- pX must reference screen-relative coordinates. They are
- converted to stdscr-relative coordinates if the window win
- encloses this point. In this case the function returns
- TRUE. If one of the parameters is NULL or the point is not
- inside the window, FALSE is returned. Please notice, that
- the referenced coordinates are only replaced by the con-
- verted coordinates if the transformation was successful.
-
- The mouseinterval function sets the maximum time (in thou-
- sands of a second) that can elapse between press and
- release events in order for them to be recognized as a
- click. This function returns the previous interval value.
- The default is one fifth of a second.
+ win. They are converted to screen-relative coordinates
+ and returned through the pointers. If the conversion was
+ successful, the function returns TRUE. If one of the
+ parameters was NULL or the location is not inside the win-
+ dow, FALSE is returned. If to_screen is FALSE, the point-
+ ers pY,pX must reference screen-relative coordinates.
+ They are converted to stdscr-relative coordinates if the
+ window win encloses this point. In this case the function
+ returns TRUE. If one of the parameters is NULL or the
+ point is not inside the window, FALSE is returned. Please
+ notice, that the referenced coordinates are only replaced
+ by the converted coordinates if the transformation was
+ successful.
+
+ The mouseinterval function sets the maximum time (in thou-
+ sands of a second) that can elapse between press and
+ release events for them to be recognized as a click. Use
+ mouseinterval(-1) to disable click resolution. This func-
+ tion returns the previous interval value. The default is
+ one sixth of a second.
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.
-
+ is being simulated in a window by a function such as get-
+ str that expects a linefeed for input-loop termination.
RETURN VALUE
- getmouse, ungetmouse and mouseinterval return the integer
- ERR upon failure or OK upon successful completion. mouse-
- mask returns the mask of reportable events. wenclose and
- wmouse_trafo are boolean functions returning TRUE or FALSE
+ getmouse, ungetmouse and mouseinterval return the integer
+ ERR upon failure or OK upon successful completion. mouse-
+ mask returns the mask of reportable events. wenclose and
+ wmouse_trafo are boolean functions returning TRUE or FALSE
depending on their test result.
PORTABILITY
- These calls were designed for ncurses(3x), and are not
+ These calls were designed for ncurses(3x), and are not
found in SVr4 curses, 4.4BSD curses, or any other previous
version of curses.
- The feature macro NCURSES_MOUSE_VERSION is provided so the
+ The feature macro NCURSES_MOUSE_VERSION is provided so the
preprocessor can be used to test whether these features
are present (its value is 1). If the interface is
- changed, the value of NCURSES_MOUSE_VERSION will be incre-
+ changed, the value of NCURSES_MOUSE_VERSION will be incre-
mented.
- The order of the MEVENT structure members is not guaran-
+ The order of the MEVENT structure members is not guaran-
teed. 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 Alessandro
- Rubini's gpm server. If you are using something other
- than xterm and there is no gpm daemon running on your
- machine, mouse events will not be visible to ncurses(3x)
- (and the wmousemask function will always return 0).
-
+ Under ncurses(3x), these calls are implemented using
+ either xterm's built-in mouse-tracking API or platform-
+ specific drivers including
+ Alessandro Rubini's gpm server.
+ FreeBSD sysmouse
+ OS/2 EMX
+ If you are using an unsupported configuration, mouse
+ events will not be visible to ncurses(3x) (and the wmouse-
+ mask 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:
+ \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
@@ -182,56 +234,31 @@
BUGS
Mouse events under xterm will not in fact be ignored dur-
- ing cooked mode, if they have been enabled by wmousemask.
+ ing cooked mode, if they have been enabled by wmousemask.
Instead, the xterm mouse report sequence will appear in
the string read.
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
- description must have kmous set to "\E[M" (the beginning
+ description must have kmous set to "\E[M" (the beginning
of the response from xterm for mouse clicks).
Because there are no standard terminal responses that
would serve to identify terminals which support the xterm
- mouse protocol, ncurses assumes that if your $DISPLAY
- environment variable is set, and kmous is defined in the
- terminal description, then the terminal may send mouse
+ 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.