1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
4 ****************************************************************************
5 * Copyright (c) 1998-2009,2010 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.38 2010/12/04 18:38:55 tom Exp @
35 <TITLE>curs_mouse 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 <H1>curs_mouse 3x</H1>
43 <!-- Manpage converted by man2html 3.0.1 -->
44 <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>
51 <STRONG>has_mouse</STRONG>, <STRONG>getmouse</STRONG>, <STRONG>ungetmouse</STRONG>, <STRONG>mousemask</STRONG>, <STRONG>wenclose</STRONG>,
52 <STRONG>mouse_trafo</STRONG>, <STRONG>wmouse_trafo</STRONG>, <STRONG>mouseinterval</STRONG> - mouse interface
57 <H2>SYNOPSIS</H2><PRE>
58 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
60 <STRONG>typedef</STRONG> <STRONG>unsigned</STRONG> <STRONG>long</STRONG> <STRONG>mmask_t;</STRONG>
64 short id; <EM>/*</EM> <EM>ID</EM> <EM>to</EM> <EM>distinguish</EM> <EM>multiple</EM> <EM>devices</EM> <EM>*/</EM>
65 <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>y,</STRONG> <STRONG>z;</STRONG> <EM>/*</EM> <EM>event</EM> <EM>coordinates</EM> <EM>*/</EM>
66 <STRONG>mmask_t</STRONG> <STRONG>bstate;</STRONG> <EM>/*</EM> <EM>button</EM> <EM>state</EM> <EM>bits</EM> <EM>*/</EM>
68 <STRONG>MEVENT;</STRONG>
69 <STRONG>bool</STRONG> <STRONG>has_mouse(void);</STRONG>
70 <STRONG>int</STRONG> <STRONG>getmouse(MEVENT</STRONG> <STRONG>*event);</STRONG>
71 <STRONG>int</STRONG> <STRONG>ungetmouse(MEVENT</STRONG> <STRONG>*event);</STRONG>
72 <STRONG>mmask_t</STRONG> <STRONG>mousemask(mmask_t</STRONG> <STRONG>newmask,</STRONG> <STRONG>mmask_t</STRONG> <STRONG>*oldmask);</STRONG>
73 <STRONG>bool</STRONG> <STRONG>wenclose(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
74 <STRONG>bool</STRONG> <STRONG>mouse_trafo(int*</STRONG> <STRONG>pY,</STRONG> <STRONG>int*</STRONG> <STRONG>pX,</STRONG> <STRONG>bool</STRONG> <STRONG>to_screen);</STRONG>
75 <STRONG>bool</STRONG> <STRONG>wmouse_trafo(const</STRONG> <STRONG>WINDOW*</STRONG> <STRONG>win,</STRONG> <STRONG>int*</STRONG> <STRONG>pY,</STRONG> <STRONG>int*</STRONG> <STRONG>pX,</STRONG>
76 <STRONG>bool</STRONG> <STRONG>to_screen);</STRONG>
77 <STRONG>int</STRONG> <STRONG>mouseinterval(int</STRONG> <STRONG>erval);</STRONG>
81 <H2>DESCRIPTION</H2><PRE>
82 These functions provide an interface to mouse events from
83 <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>. Mouse events are represented by <STRONG>KEY_MOUSE</STRONG>
84 pseudo-key values in the <STRONG>wgetch</STRONG> input stream.
86 To make mouse events visible, use the <STRONG>mousemask</STRONG> function.
87 This will set the mouse events to be reported. By de-
88 fault, no mouse events are reported. The function will
89 return a mask to indicate which of the specified mouse
90 events can be reported; on complete failure it returns 0.
91 If oldmask is non-NULL, this function fills the indicated
92 location with the previous value of the given window's
95 As a side effect, setting a zero mousemask may turn off
96 the mouse pointer; setting a nonzero mask may turn it on.
97 Whether this happens is device-dependent.
99 Here are the mouse event type masks which may be defined:
101 <EM>Name</EM> <EM>Description</EM>
102 ---------------------------------------------------------------------
103 BUTTON1_PRESSED mouse button 1 down
104 BUTTON1_RELEASED mouse button 1 up
105 BUTTON1_CLICKED mouse button 1 clicked
106 BUTTON1_DOUBLE_CLICKED mouse button 1 double clicked
107 BUTTON1_TRIPLE_CLICKED mouse button 1 triple clicked
108 ---------------------------------------------------------------------
109 BUTTON2_PRESSED mouse button 2 down
110 BUTTON2_RELEASED mouse button 2 up
111 BUTTON2_CLICKED mouse button 2 clicked
112 BUTTON2_DOUBLE_CLICKED mouse button 2 double clicked
113 BUTTON2_TRIPLE_CLICKED mouse button 2 triple clicked
114 ---------------------------------------------------------------------
116 BUTTON3_PRESSED mouse button 3 down
117 BUTTON3_RELEASED mouse button 3 up
118 BUTTON3_CLICKED mouse button 3 clicked
119 BUTTON3_DOUBLE_CLICKED mouse button 3 double clicked
120 BUTTON3_TRIPLE_CLICKED mouse button 3 triple clicked
121 ---------------------------------------------------------------------
122 BUTTON4_PRESSED mouse button 4 down
123 BUTTON4_RELEASED mouse button 4 up
124 BUTTON4_CLICKED mouse button 4 clicked
125 BUTTON4_DOUBLE_CLICKED mouse button 4 double clicked
126 BUTTON4_TRIPLE_CLICKED mouse button 4 triple clicked
127 ---------------------------------------------------------------------
128 BUTTON5_PRESSED mouse button 5 down
129 BUTTON5_RELEASED mouse button 5 up
130 BUTTON5_CLICKED mouse button 5 clicked
131 BUTTON5_DOUBLE_CLICKED mouse button 5 double clicked
132 BUTTON5_TRIPLE_CLICKED mouse button 5 triple clicked
133 ---------------------------------------------------------------------
134 BUTTON_SHIFT shift was down during button state change
135 BUTTON_CTRL control was down during button state change
136 BUTTON_ALT alt was down during button state change
137 ALL_MOUSE_EVENTS report all button state changes
138 REPORT_MOUSE_POSITION report mouse movement
139 ---------------------------------------------------------------------
141 Once a class of mouse events have been made visible in a
142 window, calling the <STRONG>wgetch</STRONG> function on that window may re-
143 turn <STRONG>KEY_MOUSE</STRONG> as an indicator that a mouse event has been
144 queued. To read the event data and pop the event off the
145 queue, call <STRONG>getmouse</STRONG>. This function will return <STRONG>OK</STRONG> if a
146 mouse event is actually visible in the given window, <STRONG>ERR</STRONG>
147 otherwise. When <STRONG>getmouse</STRONG> returns <STRONG>OK</STRONG>, the data deposited
148 as y and x in the event structure coordinates will be
149 screen-relative character-cell coordinates. The returned
150 state mask will have exactly one bit set to indicate the
151 event type. The corresponding data in the queue is marked
152 invalid. A subsequent call to <STRONG>getmouse</STRONG> will retrieve the
153 next older item from the queue.
155 The <STRONG>ungetmouse</STRONG> function behaves analogously to <STRONG>ungetch</STRONG>.
156 It pushes a <STRONG>KEY_MOUSE</STRONG> event onto the input queue, and as-
157 sociates with that event the given state data and screen-
158 relative character-cell coordinates.
160 The <STRONG>wenclose</STRONG> function tests whether a given pair of
161 screen-relative character-cell coordinates is enclosed by
162 a given window, returning TRUE if it is and FALSE other-
163 wise. It is useful for determining what subset of the
164 screen windows enclose the location of a mouse event.
166 The <STRONG>wmouse_trafo</STRONG> function transforms a given pair of coor-
167 dinates from stdscr-relative coordinates to coordinates
168 relative to the given window or vice versa. Please remem-
169 ber, that stdscr-relative coordinates are not always iden-
170 tical to window-relative coordinates due to the mechanism
171 to reserve lines on top or bottom of the screen for other
172 purposes (see the <STRONG>ripoffline()</STRONG> and <STRONG>slk_init</STRONG> calls, for ex-
173 ample). If the parameter <STRONG>to_screen</STRONG> is <STRONG>TRUE</STRONG>, the pointers
174 <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must reference the coordinates of a location inside
175 the window <STRONG>win</STRONG>. They are converted to window-relative co-
176 ordinates and returned through the pointers. If the con-
177 version was successful, the function returns <STRONG>TRUE</STRONG>. If one
178 of the parameters was NULL or the location is not inside
179 the window, <STRONG>FALSE</STRONG> is returned. If <STRONG>to_screen</STRONG> is <STRONG>FALSE</STRONG>, the
180 pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must reference window-relative coordi-
181 nates. They are converted to stdscr-relative coordinates
182 if the window <STRONG>win</STRONG> encloses this point. In this case the
183 function returns <STRONG>TRUE</STRONG>. If one of the parameters is NULL
184 or the point is not inside the window, <STRONG>FALSE</STRONG> is returned.
185 Please notice, that the referenced coordinates are only
186 replaced by the converted coordinates if the transforma-
189 The <STRONG>mouse_trafo</STRONG> function performs the same translation as
190 <STRONG>wmouse_trafo</STRONG>, using stdscr for <STRONG>win</STRONG>.
192 The <STRONG>mouseinterval</STRONG> function sets the maximum time (in thou-
193 sands of a second) that can elapse between press and re-
194 lease events for them to be recognized as a click. Use
195 <STRONG>mouseinterval(0)</STRONG> to disable click resolution. This func-
196 tion returns the previous interval value. Use <STRONG>mouseinter-</STRONG>
197 <STRONG>val(-1)</STRONG> to obtain the interval without altering it. The
198 default is one sixth of a second.
200 The <STRONG>has_mouse</STRONG> function returns TRUE if the mouse driver
201 has been successfully initialized.
203 Note that mouse events will be ignored when input is in
204 cooked mode, and will cause an error beep when cooked mode
205 is being simulated in a window by a function such as <STRONG>get-</STRONG>
206 <STRONG>str</STRONG> that expects a linefeed for input-loop termination.
210 <H2>RETURN VALUE</H2><PRE>
211 <STRONG>getmouse</STRONG> and <STRONG>ungetmouse</STRONG> return the integer <STRONG>ERR</STRONG> upon fail-
212 ure or <STRONG>OK</STRONG> upon successful completion.
214 <STRONG>getmouse</STRONG>
215 returns an error. If no mouse driver was ini-
216 tialized, or if the mask parameter is zero, it
217 also returns an error if no more events remain
220 <STRONG>ungetmouse</STRONG>
221 returns an error if the FIFO is full.
223 <STRONG>mousemask</STRONG> returns the mask of reportable events.
225 <STRONG>mouseinterval</STRONG> returns the previous interval value, unless
226 the terminal was not initialized. In that case, it re-
227 turns the maximum interval value (166).
229 <STRONG>wenclose</STRONG> and <STRONG>wmouse_trafo</STRONG> are boolean functions returning
230 <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG> depending on their test result.
234 <H2>PORTABILITY</H2><PRE>
235 These calls were designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and are not
236 found in SVr4 curses, 4.4BSD curses, or any other previous
239 The feature macro <STRONG>NCURSES_MOUSE_VERSION</STRONG> is provided so the
240 preprocessor can be used to test whether these features
241 are present. If the interface is changed, the value of
242 <STRONG>NCURSES_MOUSE_VERSION</STRONG> will be incremented. These values
243 for <STRONG>NCURSES_MOUSE_VERSION</STRONG> may be specified when configur-
246 1 has definitions for reserved events. The mask
249 2 adds definitions for button 5, removes the defi-
250 nitions for reserved events. The mask uses 29
253 The order of the <STRONG>MEVENT</STRONG> structure members is not guaran-
254 teed. Additional fields may be added to the structure in
257 Under <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, these calls are implemented using ei-
258 ther xterm's built-in mouse-tracking API or platform-spe-
259 cific drivers including
260 Alessandro Rubini's gpm server
263 If you are using an unsupported configuration, mouse
264 events will not be visible to <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> (and the <STRONG>mouse-</STRONG>
265 <STRONG>mask</STRONG> function will always return <STRONG>0</STRONG>).
267 If the terminfo entry contains a <STRONG>XM</STRONG> string, this is used
268 in the xterm mouse driver to control the way the terminal
269 is initialized for mouse operation. The default, if <STRONG>XM</STRONG> is
270 not found, corresponds to private mode 1000 of xterm:
271 \E[?1000%?%p1%{1}%=%th%el%;
272 The z member in the event structure is not presently used.
273 It is intended for use with touch screens (which may be
274 pressure-sensitive) or with 3D-mice/trackballs/power
280 Mouse events under xterm will not in fact be ignored dur-
281 ing cooked mode, if they have been enabled by <STRONG>mousemask</STRONG>.
282 Instead, the xterm mouse report sequence will appear in
285 Mouse events under xterm will not be detected correctly in
286 a window with its keypad bit off, since they are inter-
287 preted as a variety of function key. Your terminfo de-
288 scription should have <STRONG>kmous</STRONG> set to "\E[M" (the beginning
289 of the response from xterm for mouse clicks). Other val-
290 ues for <STRONG>kmous</STRONG> are permitted, but under the same assump-
291 tion, i.e., it is the beginning of the response.
293 Because there are no standard terminal responses that
294 would serve to identify terminals which support the xterm
295 mouse protocol, <STRONG>ncurses</STRONG> assumes that if your $TERM envi-
296 ronment variable contains "xterm", or <STRONG>kmous</STRONG> is defined in
297 the terminal description, then the terminal may send mouse
302 <H2>SEE ALSO</H2><PRE>
303 <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>curs_vari-</STRONG>
304 <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>.
308 <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>
312 Man(1) output converted with
313 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>