- 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 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.
+ To make mouse events visible, use the mousemask function. This sets
+ the mouse events to be reported. By default, no mouse events are re-
+ ported.
+
+ o The function returns an updated copy of newmask to indicate which
+ of the specified mouse events can be reported.
+
+ If the screen has not been initialized, or if the terminal does not
+ support mouse-events, this function returns 0.
+
+ o If oldmask is non-NULL, this function fills the indicated location
+ with the previous value of the current screen's mouse event mask.
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
@@ -95,11 +107,12 @@
Here are the mouse event type masks which may be defined:
- 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
---------------------------------------------------------------------
@@ -111,7 +124,6 @@
---------------------------------------------------------------------
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
@@ -171,8 +183,8 @@
reserve lines on top or bottom of the screen for other purposes (see
the ripoffline and slk_init(3x) calls, for example).
- o If the parameter to_screen is TRUE, the pointers pY,pX must refer-
- ence the coordinates of a location inside the window win. They are
+ o If the parameter to_screen is TRUE, the pointers pY,pX must refer-
+ ence 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.
@@ -180,9 +192,9 @@
o If one of the parameters was NULL or the location is not inside the
window, FALSE is returned.
- o If to_screen is FALSE, the pointers pY,pX must reference window-
+ o If to_screen is FALSE, the pointers pY,pX must reference window-
relative coordinates. They are converted to stdscr-relative coor-
- dinates if the window win encloses this point. In this case the
+ dinates if the window win encloses this point. In this case the
function returns TRUE.
o If one of the parameters is NULL or the point is not inside the
@@ -193,7 +205,7 @@
@@ -225,6 +237,9 @@
o If no mouse driver was initialized, or if the mask parameter is
zero,
+ o It returns an error if a mouse event was detected which did not
+ match the current mousemask.
+
o It also returns an error if no more events remain in the queue.
ungetmouse
@@ -232,8 +247,8 @@
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
+ 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
@@ -241,13 +256,13 @@
- These calls were designed for ncurses(3x), and are not found in SVr4
+ These calls were designed for ncurses(3x), and are not found in SVr4
curses, 4.4BSD curses, or any other previous version of curses.
- SVr4 curses had support for the mouse in a variant of xterm. It is
+ 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:
- o the "libcurses" manual page lists functions for this feature which
+ o the "libcurses" manual page lists functions for this feature which
are prototyped in curses.h:
extern int mouse_set(long int);
@@ -266,40 +281,40 @@
mouse_info minfo Mi Mouse status information
req_mouse_pos reqmp RQ Request mouse position report
- o the interface made assumptions (as does ncurses) about the escape
+ o the interface made assumptions (as does ncurses) about the escape
sequences sent to and received from the terminal.
- For instance the SVr4 curses library used the get_mouse capability
- to tell the terminal which mouse button events it should send,
- passing the mouse-button bit-mask to the terminal. Also, it could
- ask the terminal where the mouse was using the req_mouse_pos capa-
+ For instance the SVr4 curses library used the get_mouse capability
+ to tell the terminal which mouse button events it should send,
+ passing the mouse-button bit-mask to the terminal. Also, it could
+ ask the terminal where the mouse was using the req_mouse_pos capa-
bility.
- Those features required a terminal which had been modified to work
+ Those features required a terminal which had been modified to work
with curses. They were not part of the X Consortium's xterm.
- When developing the xterm mouse support for ncurses in September 1995,
- Eric Raymond was uninterested in using the same interface due to its
+ 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 com-
+ in PDCurses 2.3 using the SVr4 interface. PDCurses, however, does not
+ use video terminals, making it unnecessary to be concerned about com-
patibility 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 inter-
- face is changed, the value of NCURSES_MOUSE_VERSION will be increment-
- ed. These values for NCURSES_MOUSE_VERSION may be specified when con-
+ can be used to test whether these features are present. If the inter-
+ face is changed, the value of NCURSES_MOUSE_VERSION will be increment-
+ ed. These values for NCURSES_MOUSE_VERSION may be specified when con-
figuring ncurses:
1 has definitions for reserved events. The mask uses 28 bits.
- 2 adds definitions for button 5, removes the definitions for re-
+ 2 adds definitions for button 5, removes the definitions for re-
served events. The mask uses 29 bits.
The order of the MEVENT structure members is not guaranteed. Addition-
al fields may be added to the structure in the future.
- Under ncurses(3x), these calls are implemented using either xterm's
+ Under ncurses(3x), these calls are implemented using either xterm's
built-in mouse-tracking API or platform-specific drivers including
o Alessandro Rubini's gpm server
@@ -309,12 +324,12 @@
o OS/2 EMX
If you are using an unsupported configuration, mouse events will not be
- visible to ncurses(3x) (and the mousemask function will always return
+ 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
+ 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%;
@@ -323,43 +338,44 @@
\E[?1006;1000%?%p1%{1}%=%th%el%;
- The z member in the event structure is not presently used. It is in-
- tended for use with touch screens (which may be pressure-sensitive) or
+ The z member in the event structure is not presently used. It is in-
+ tended 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
+ 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 in fact be ignored during cooked
+ Mouse events under xterm will not in fact be ignored during cooked
mode, if they have been enabled by mousemask. 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 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,
+ 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 as-
- sumes that if kmous is defined in the terminal description, or if the
- terminal description's primary name or aliases contain the string
+ Because there are no standard terminal responses that would serve to
+ identify terminals which support the xterm mouse protocol, ncurses as-
+ sumes 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
+ is checked first, allowing the use of newer xterm mouse protocols such
as xterm's private mode 1006.