3 ****************************************************************************
4 * Copyright 2018-2019,2020 Thomas E. Dickey *
5 * Copyright 1998-2015,2017 Free Software Foundation, Inc. *
7 * Permission is hereby granted, free of charge, to any person obtaining a *
8 * copy of this software and associated documentation files (the *
9 * "Software"), to deal in the Software without restriction, including *
10 * without limitation the rights to use, copy, modify, merge, publish, *
11 * distribute, distribute with modifications, sublicense, and/or sell *
12 * copies of the Software, and to permit persons to whom the Software is *
13 * furnished to do so, subject to the following conditions: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
21 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
24 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
26 * Except as contained in this notice, the name(s) of the above copyright *
27 * holders shall not be used in advertising or otherwise to promote the *
28 * sale, use or other dealings in this Software without prior written *
30 ****************************************************************************
31 * @Id: curs_mouse.3x,v 1.52 2020/02/02 23:34:34 tom Exp @
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>curs_mouse 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
43 <H1 class="no-header">curs_mouse 3x</H1>
45 <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>has_mouse</STRONG>, <STRONG>getmouse</STRONG>, <STRONG>ungetmouse</STRONG>, <STRONG>mousemask</STRONG>, <STRONG>wenclose</STRONG>, <STRONG>mouse_trafo</STRONG>,
52 <STRONG>wmouse_trafo</STRONG>, <STRONG>mouseinterval</STRONG> - mouse interface through curses
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
58 <STRONG>typedef</STRONG> <STRONG>unsigned</STRONG> <STRONG>long</STRONG> <STRONG>mmask_t;</STRONG>
60 <STRONG>typedef</STRONG> <STRONG>struct</STRONG> <STRONG>{</STRONG>
61 <STRONG>short</STRONG> <STRONG>id;</STRONG> <EM>/*</EM> <EM>ID</EM> <EM>to</EM> <EM>distinguish</EM> <EM>multiple</EM> <EM>devices</EM> <EM>*/</EM>
62 <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>y,</STRONG> <STRONG>z;</STRONG> <EM>/*</EM> <EM>event</EM> <EM>coordinates</EM> <EM>*/</EM>
63 <STRONG>mmask_t</STRONG> <STRONG>bstate;</STRONG> <EM>/*</EM> <EM>button</EM> <EM>state</EM> <EM>bits</EM> <EM>*/</EM>
64 <STRONG>}</STRONG> <STRONG>MEVENT;</STRONG>
66 <STRONG>bool</STRONG> <STRONG>has_mouse(void);</STRONG>
67 <STRONG>int</STRONG> <STRONG>getmouse(MEVENT</STRONG> <STRONG>*</STRONG><EM>event</EM><STRONG>);</STRONG>
68 <STRONG>int</STRONG> <STRONG>ungetmouse(MEVENT</STRONG> <STRONG>*</STRONG><EM>event</EM><STRONG>);</STRONG>
69 <STRONG>mmask_t</STRONG> <STRONG>mousemask(mmask_t</STRONG> <EM>newmask</EM><STRONG>,</STRONG> <STRONG>mmask_t</STRONG> <STRONG>*</STRONG><EM>oldmask</EM><STRONG>);</STRONG>
70 <STRONG>bool</STRONG> <STRONG>wenclose(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
71 <STRONG>bool</STRONG> <STRONG>mouse_trafo(int*</STRONG> <EM>pY</EM><STRONG>,</STRONG> <STRONG>int*</STRONG> <EM>pX</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>to</EM><STRONG>_</STRONG><EM>screen</EM><STRONG>);</STRONG>
72 <STRONG>bool</STRONG> <STRONG>wmouse_trafo(const</STRONG> <STRONG>WINDOW*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>int*</STRONG> <EM>pY</EM><STRONG>,</STRONG> <STRONG>int*</STRONG> <EM>pX</EM><STRONG>,</STRONG>
73 <STRONG>bool</STRONG> <EM>to</EM><STRONG>_</STRONG><EM>screen</EM><STRONG>);</STRONG>
74 <STRONG>int</STRONG> <STRONG>mouseinterval(int</STRONG> <EM>erval</EM><STRONG>);</STRONG>
77 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
78 These functions provide an interface to mouse events from <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>.
79 Mouse events are represented by <STRONG>KEY_MOUSE</STRONG> pseudo-key values in the
80 <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG> input stream.
83 </PRE><H3><a name="h3-mousemask">mousemask</a></H3><PRE>
84 To make mouse events visible, use the <STRONG>mousemask</STRONG> function. This will
85 set the mouse events to be reported. By default, no mouse events are
86 reported. The function will return a mask to indicate which of the
87 specified mouse events can be reported; on complete failure it returns
88 0. If oldmask is non-NULL, this function fills the indicated location
89 with the previous value of the given window's mouse event mask.
91 As a side effect, setting a zero mousemask may turn off the mouse
92 pointer; setting a nonzero mask may turn it on. Whether this happens
96 </PRE><H3><a name="h3-Mouse-events">Mouse events</a></H3><PRE>
97 Here are the mouse event type masks which may be defined:
99 <EM>Name</EM> <EM>Description</EM>
100 ---------------------------------------------------------------------
101 BUTTON1_PRESSED mouse button 1 down
102 BUTTON1_RELEASED mouse button 1 up
103 BUTTON1_CLICKED mouse button 1 clicked
104 BUTTON1_DOUBLE_CLICKED mouse button 1 double clicked
105 BUTTON1_TRIPLE_CLICKED mouse button 1 triple clicked
106 ---------------------------------------------------------------------
107 BUTTON2_PRESSED mouse button 2 down
108 BUTTON2_RELEASED mouse button 2 up
109 BUTTON2_CLICKED mouse button 2 clicked
110 BUTTON2_DOUBLE_CLICKED mouse button 2 double clicked
111 BUTTON2_TRIPLE_CLICKED mouse button 2 triple clicked
112 ---------------------------------------------------------------------
113 BUTTON3_PRESSED mouse button 3 down
114 BUTTON3_RELEASED mouse button 3 up
116 BUTTON3_CLICKED mouse button 3 clicked
117 BUTTON3_DOUBLE_CLICKED mouse button 3 double clicked
118 BUTTON3_TRIPLE_CLICKED mouse button 3 triple clicked
119 ---------------------------------------------------------------------
120 BUTTON4_PRESSED mouse button 4 down
121 BUTTON4_RELEASED mouse button 4 up
122 BUTTON4_CLICKED mouse button 4 clicked
123 BUTTON4_DOUBLE_CLICKED mouse button 4 double clicked
124 BUTTON4_TRIPLE_CLICKED mouse button 4 triple clicked
125 ---------------------------------------------------------------------
126 BUTTON5_PRESSED mouse button 5 down
127 BUTTON5_RELEASED mouse button 5 up
128 BUTTON5_CLICKED mouse button 5 clicked
129 BUTTON5_DOUBLE_CLICKED mouse button 5 double clicked
130 BUTTON5_TRIPLE_CLICKED mouse button 5 triple clicked
131 ---------------------------------------------------------------------
132 BUTTON_SHIFT shift was down during button state change
133 BUTTON_CTRL control was down during button state change
134 BUTTON_ALT alt was down during button state change
135 ALL_MOUSE_EVENTS report all button state changes
136 REPORT_MOUSE_POSITION report mouse movement
137 ---------------------------------------------------------------------
140 </PRE><H3><a name="h3-getmouse">getmouse</a></H3><PRE>
141 Once a class of mouse events has been made visible in a window, calling
142 the <STRONG>wgetch</STRONG> function on that window may return <STRONG>KEY_MOUSE</STRONG> as an indicator
143 that a mouse event has been queued. To read the event data and pop the
144 event off the queue, call <STRONG>getmouse</STRONG>. This function will return <STRONG>OK</STRONG> if a
145 mouse event is actually visible in the given window, <STRONG>ERR</STRONG> otherwise.
146 When <STRONG>getmouse</STRONG> returns <STRONG>OK</STRONG>, the data deposited as y and x in the event
147 structure coordinates will be screen-relative character-cell coordi-
148 nates. The returned state mask will have exactly one bit set to indi-
149 cate the event type. The corresponding data in the queue is marked in-
150 valid. A subsequent call to <STRONG>getmouse</STRONG> will retrieve the next older item
154 </PRE><H3><a name="h3-ungetmouse">ungetmouse</a></H3><PRE>
155 The <STRONG>ungetmouse</STRONG> function behaves analogously to <STRONG>ungetch</STRONG>. It pushes a
156 <STRONG>KEY_MOUSE</STRONG> event onto the input queue, and associates with that event
157 the given state data and screen-relative character-cell coordinates.
160 </PRE><H3><a name="h3-wenclose">wenclose</a></H3><PRE>
161 The <STRONG>wenclose</STRONG> function tests whether a given pair of screen-relative
162 character-cell coordinates is enclosed by a given window, returning
163 <STRONG>TRUE</STRONG> if it is and <STRONG>FALSE</STRONG> otherwise. It is useful for determining what
164 subset of the screen windows enclose the location of a mouse event.
167 </PRE><H3><a name="h3-wmouse_trafo">wmouse_trafo</a></H3><PRE>
168 The <STRONG>wmouse_trafo</STRONG> function transforms a given pair of coordinates from
169 stdscr-relative coordinates to coordinates relative to the given window
170 or vice versa. The resulting stdscr-relative coordinates are not al-
171 ways identical to window-relative coordinates due to the mechanism to
172 reserve lines on top or bottom of the screen for other purposes (see
173 the <STRONG>ripoffline</STRONG> and <STRONG><A HREF="curs_slk.3x.html">slk_init(3x)</A></STRONG> calls, for example).
175 <STRONG>o</STRONG> If the parameter <STRONG>to_screen</STRONG> is <STRONG>TRUE</STRONG>, the pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must refer-
176 ence the coordinates of a location inside the window <STRONG>win</STRONG>. They are
177 converted to window-relative coordinates and returned through the
178 pointers. If the conversion was successful, the function returns
179 <STRONG>TRUE</STRONG>.
181 <STRONG>o</STRONG> If one of the parameters was NULL or the location is not inside the
182 window, <STRONG>FALSE</STRONG> is returned.
184 <STRONG>o</STRONG> If <STRONG>to_screen</STRONG> is <STRONG>FALSE</STRONG>, the pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must reference window-
185 relative coordinates. They are converted to stdscr-relative coor-
186 dinates if the window <STRONG>win</STRONG> encloses this point. In this case the
187 function returns <STRONG>TRUE</STRONG>.
189 <STRONG>o</STRONG> If one of the parameters is NULL or the point is not inside the
190 window, <STRONG>FALSE</STRONG> is returned. The referenced coordinates are only re-
191 placed by the converted coordinates if the transformation was suc-
195 </PRE><H3><a name="h3-mouse_trafo">mouse_trafo</a></H3><PRE>
196 The <STRONG>mouse_trafo</STRONG> function performs the same translation as <STRONG>wmouse_trafo</STRONG>,
197 using stdscr for <STRONG>win</STRONG>.
200 </PRE><H3><a name="h3-mouseinterval">mouseinterval</a></H3><PRE>
201 The <STRONG>mouseinterval</STRONG> function sets the maximum time (in thousands of a
202 second) that can elapse between press and release events for them to be
203 recognized as a click. Use <STRONG>mouseinterval(0)</STRONG> to disable click resolu-
204 tion. This function returns the previous interval value. Use <STRONG>mousein-</STRONG>
205 <STRONG>terval(-1)</STRONG> to obtain the interval without altering it. The default is
206 one sixth of a second.
209 </PRE><H3><a name="h3-has_mouse">has_mouse</a></H3><PRE>
210 The <STRONG>has_mouse</STRONG> function returns <STRONG>TRUE</STRONG> if the mouse driver has been suc-
211 cessfully initialized.
213 Note that mouse events will be ignored when input is in cooked mode,
214 and will cause an error beep when cooked mode is being simulated in a
215 window by a function such as <STRONG>getstr</STRONG> that expects a linefeed for input-
219 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
220 <STRONG>getmouse</STRONG> and <STRONG>ungetmouse</STRONG> return the integer <STRONG>ERR</STRONG> upon failure or <STRONG>OK</STRONG> upon
221 successful completion:
223 <STRONG>getmouse</STRONG>
226 <STRONG>o</STRONG> If no mouse driver was initialized, or if the mask parameter is
229 <STRONG>o</STRONG> It also returns an error if no more events remain in the queue.
231 <STRONG>ungetmouse</STRONG>
232 returns an error if the FIFO is full.
234 <STRONG>mousemask</STRONG> returns the mask of reportable events.
236 <STRONG>mouseinterval</STRONG> returns the previous interval value, unless the terminal
237 was not initialized. In that case, it returns the maximum interval
240 <STRONG>wenclose</STRONG> and <STRONG>wmouse_trafo</STRONG> are boolean functions returning <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>
241 depending on their test result.
244 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
245 These calls were designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and are not found in SVr4
246 curses, 4.4BSD curses, or any other previous version of curses.
248 SVr4 curses had support for the mouse in a variant of <STRONG>xterm</STRONG>. It is
249 mentioned in a few places, but with no supporting documentation:
251 <STRONG>o</STRONG> the "libcurses" manual page lists functions for this feature which
252 are prototyped in <STRONG>curses.h</STRONG>:
254 extern int mouse_set(long int);
255 extern int mouse_on(long int);
256 extern int mouse_off(long int);
257 extern int request_mouse_pos(void);
258 extern int map_button(unsigned long);
259 extern void wmouse_position(WINDOW *, int *, int *);
260 extern unsigned long getmouse(void), getbmap(void);
262 <STRONG>o</STRONG> the "terminfo" manual page lists capabilities for the feature
264 buttons btns BT Number of buttons on the mouse
265 get_mouse getm Gm Curses should get button events
266 key_mouse kmous Km 0631, Mouse event has occurred
267 mouse_info minfo Mi Mouse status information
268 req_mouse_pos reqmp RQ Request mouse position report
270 <STRONG>o</STRONG> the interface made assumptions (as does ncurses) about the escape
271 sequences sent to and received from the terminal.
273 For instance the SVr4 curses library used the <STRONG>get_mouse</STRONG> capability
274 to tell the terminal which mouse button events it should send,
275 passing the mouse-button bit-mask to the terminal. Also, it could
276 ask the terminal where the mouse was using the <STRONG>req_mouse_pos</STRONG> capa-
279 Those features required a terminal which had been modified to work
280 with curses. They were not part of the X Consortium's xterm.
282 When developing the xterm mouse support for ncurses in September 1995,
283 Eric Raymond was uninterested in using the same interface due to its
284 lack of documentation. Later, in 1998, Mark Hesseling provided support
285 in PDCurses 2.3 using the SVr4 interface. PDCurses, however, does not
286 use video terminals, making it unnecessary to be concerned about com-
287 patibility with the escape sequences.
289 The feature macro <STRONG>NCURSES_MOUSE_VERSION</STRONG> is provided so the preprocessor
290 can be used to test whether these features are present. If the inter-
291 face is changed, the value of <STRONG>NCURSES_MOUSE_VERSION</STRONG> will be increment-
292 ed. These values for <STRONG>NCURSES_MOUSE_VERSION</STRONG> may be specified when con-
295 1 has definitions for reserved events. The mask uses 28 bits.
297 2 adds definitions for button 5, removes the definitions for re-
298 served events. The mask uses 29 bits.
300 The order of the <STRONG>MEVENT</STRONG> structure members is not guaranteed. Addition-
301 al fields may be added to the structure in the future.
303 Under <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, these calls are implemented using either xterm's
304 built-in mouse-tracking API or platform-specific drivers including
306 <STRONG>o</STRONG> Alessandro Rubini's gpm server
308 <STRONG>o</STRONG> FreeBSD sysmouse
310 <STRONG>o</STRONG> OS/2 EMX
312 If you are using an unsupported configuration, mouse events will not be
313 visible to <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> (and the <STRONG>mousemask</STRONG> function will always return
316 If the terminfo entry contains a <STRONG>XM</STRONG> string, this is used in the xterm
317 mouse driver to control the way the terminal is initialized for mouse
318 operation. The default, if <STRONG>XM</STRONG> is not found, corresponds to private
321 \E[?1000%?%p1%{1}%=%th%el%;
323 The mouse driver also recognizes a newer xterm private mode 1006, e.g.,
325 \E[?1006;1000%?%p1%{1}%=%th%el%;
327 The <EM>z</EM> member in the event structure is not presently used. It is in-
328 tended for use with touch screens (which may be pressure-sensitive) or
329 with 3D-mice/trackballs/power gloves.
331 The <STRONG>ALL_MOUSE_EVENTS</STRONG> class does not include <STRONG>REPORT_MOUSE_POSITION</STRONG>.
332 They are distinct. For example, in xterm, wheel/scrolling mice send
333 position reports as a sequence of presses of buttons 4 or 5 without
334 matching button-releases.
337 </PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
338 Mouse events under xterm will not in fact be ignored during cooked
339 mode, if they have been enabled by <STRONG>mousemask</STRONG>. Instead, the xterm mouse
340 report sequence will appear in the string read.
342 Mouse events under xterm will not be detected correctly in a window
343 with its keypad bit off, since they are interpreted as a variety of
344 function key. Your terminfo description should have <STRONG>kmous</STRONG> set to
345 "\E[M" (the beginning of the response from xterm for mouse clicks).
346 Other values for <STRONG>kmous</STRONG> are permitted, but under the same assumption,
347 i.e., it is the beginning of the response.
349 Because there are no standard terminal responses that would serve to
350 identify terminals which support the xterm mouse protocol, <STRONG>ncurses</STRONG> as-
351 sumes that if <STRONG>kmous</STRONG> is defined in the terminal description, or if the
352 terminal description's primary name or aliases contain the string
353 "xterm", then the terminal may send mouse events. The <STRONG>kmous</STRONG> capability
354 is checked first, allowing the use of newer xterm mouse protocols such
355 as xterm's private mode 1006.
358 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
359 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>, <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
363 <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>
367 <li><a href="#h2-NAME">NAME</a></li>
368 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
369 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
371 <li><a href="#h3-mousemask">mousemask</a></li>
372 <li><a href="#h3-Mouse-events">Mouse events</a></li>
373 <li><a href="#h3-getmouse">getmouse</a></li>
374 <li><a href="#h3-ungetmouse">ungetmouse</a></li>
375 <li><a href="#h3-wenclose">wenclose</a></li>
376 <li><a href="#h3-wmouse_trafo">wmouse_trafo</a></li>
377 <li><a href="#h3-mouse_trafo">mouse_trafo</a></li>
378 <li><a href="#h3-mouseinterval">mouseinterval</a></li>
379 <li><a href="#h3-has_mouse">has_mouse</a></li>
382 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
383 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
384 <li><a href="#h2-BUGS">BUGS</a></li>
385 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>