ncurses 6.0 - patch 20160820
[ncurses.git] / doc / html / man / curs_mouse.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2014,2015 Free Software Foundation, Inc.              *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: curs_mouse.3x,v 1.42 2015/07/21 09:27:39 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_mouse 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_mouse 3x</H1>
43 <PRE>
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>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>has_mouse</STRONG>, <STRONG>getmouse</STRONG>, <STRONG>ungetmouse</STRONG>, <STRONG>mousemask</STRONG>, <STRONG>wenclose</STRONG>,
51        <STRONG>mouse_trafo</STRONG>, <STRONG>wmouse_trafo</STRONG>, <STRONG>mouseinterval</STRONG> - mouse interface
52        through curses
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>typedef</STRONG> <STRONG>unsigned</STRONG> <STRONG>long</STRONG> <STRONG>mmask_t;</STRONG>
59
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>
65
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>
75
76
77 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
78        These  functions provide an interface to mouse events from
79        <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>.  Mouse events are  represented  by  <STRONG>KEY_MOUSE</STRONG>
80        pseudo-key values in the <STRONG>wgetch</STRONG> input stream.
81
82
83 </PRE><H3><a name="h3-mousemask">mousemask</a></H3><PRE>
84        To  make mouse events visible, use the <STRONG>mousemask</STRONG> function.
85        This will set the mouse events to  be  reported.   By  de-
86        fault,  no  mouse  events are reported.  The function will
87        return a mask to indicate which  of  the  specified  mouse
88        events  can be reported; on complete failure it returns 0.
89        If oldmask is non-NULL, this function fills the  indicated
90        location  with  the  previous  value of the given window's
91        mouse event mask.
92
93        As a side effect, setting a zero mousemask  may  turn  off
94        the  mouse pointer; setting a nonzero mask may turn it on.
95        Whether this happens is device-dependent.
96
97
98 </PRE><H3><a name="h3-Mouse-events">Mouse events</a></H3><PRE>
99        Here are the mouse event type masks which may be defined:
100
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
114
115        BUTTON2_TRIPLE_CLICKED   mouse button 2 triple clicked
116        ---------------------------------------------------------------------
117        BUTTON3_PRESSED          mouse button 3 down
118        BUTTON3_RELEASED         mouse button 3 up
119        BUTTON3_CLICKED          mouse button 3 clicked
120        BUTTON3_DOUBLE_CLICKED   mouse button 3 double clicked
121        BUTTON3_TRIPLE_CLICKED   mouse button 3 triple clicked
122        ---------------------------------------------------------------------
123        BUTTON4_PRESSED          mouse button 4 down
124        BUTTON4_RELEASED         mouse button 4 up
125        BUTTON4_CLICKED          mouse button 4 clicked
126        BUTTON4_DOUBLE_CLICKED   mouse button 4 double clicked
127        BUTTON4_TRIPLE_CLICKED   mouse button 4 triple clicked
128        ---------------------------------------------------------------------
129        BUTTON5_PRESSED          mouse button 5 down
130        BUTTON5_RELEASED         mouse button 5 up
131        BUTTON5_CLICKED          mouse button 5 clicked
132        BUTTON5_DOUBLE_CLICKED   mouse button 5 double clicked
133        BUTTON5_TRIPLE_CLICKED   mouse button 5 triple clicked
134        ---------------------------------------------------------------------
135        BUTTON_SHIFT             shift was down during button state change
136        BUTTON_CTRL              control was down during button state change
137        BUTTON_ALT               alt was down during button state change
138        ALL_MOUSE_EVENTS         report all button state changes
139        REPORT_MOUSE_POSITION    report mouse movement
140        ---------------------------------------------------------------------
141
142
143 </PRE><H3><a name="h3-getmouse">getmouse</a></H3><PRE>
144        Once a class of mouse events has been made  visible  in  a
145        window, calling the <STRONG>wgetch</STRONG> function on that window may re-
146        turn <STRONG>KEY_MOUSE</STRONG> as an indicator that a mouse event has been
147        queued.   To read the event data and pop the event off the
148        queue, call <STRONG>getmouse</STRONG>.  This function will return <STRONG>OK</STRONG>  if  a
149        mouse  event  is actually visible in the given window, <STRONG>ERR</STRONG>
150        otherwise.  When <STRONG>getmouse</STRONG> returns <STRONG>OK</STRONG>, the  data  deposited
151        as  y  and  x  in  the event structure coordinates will be
152        screen-relative character-cell coordinates.  The  returned
153        state  mask  will have exactly one bit set to indicate the
154        event type.  The corresponding data in the queue is marked
155        invalid.   A subsequent call to <STRONG>getmouse</STRONG> will retrieve the
156        next older item from the queue.
157
158
159 </PRE><H3><a name="h3-ungetmouse">ungetmouse</a></H3><PRE>
160        The <STRONG>ungetmouse</STRONG> function behaves  analogously  to  <STRONG>ungetch</STRONG>.
161        It  pushes a <STRONG>KEY_MOUSE</STRONG> event onto the input queue, and as-
162        sociates with that event the given state data and  screen-
163        relative character-cell coordinates.
164
165
166 </PRE><H3><a name="h3-wenclose">wenclose</a></H3><PRE>
167        The  <STRONG>wenclose</STRONG>  function  tests  whether  a  given  pair of
168        screen-relative character-cell coordinates is enclosed  by
169        a  given  window, returning <STRONG>TRUE</STRONG> if it is and <STRONG>FALSE</STRONG> other-
170        wise.  It is useful for determining  what  subset  of  the
171        screen windows enclose the location of a mouse event.
172
173
174 </PRE><H3><a name="h3-wmouse_trafo">wmouse_trafo</a></H3><PRE>
175        The <STRONG>wmouse_trafo</STRONG> function transforms a given pair of coor-
176        dinates from stdscr-relative  coordinates  to  coordinates
177        relative to the given window or vice versa.  The resulting
178        stdscr-relative coordinates are not  always  identical  to
179        window-relative  coordinates  due  to the mechanism to re-
180        serve lines on top or bottom of the screen for other  pur-
181        poses  (see  the  <STRONG>ripoffline</STRONG> and <STRONG>slk_init</STRONG> calls, for exam-
182        ple).
183
184        <STRONG>o</STRONG>   If the parameter <STRONG>to_screen</STRONG> is <STRONG>TRUE</STRONG>, the  pointers  <STRONG>pY,</STRONG>
185            <STRONG>pX</STRONG> must reference the coordinates of a location inside
186            the window <STRONG>win</STRONG>.  They are converted to window-relative
187            coordinates and returned through the pointers.  If the
188            conversion was successful, the function returns <STRONG>TRUE</STRONG>.
189
190        <STRONG>o</STRONG>   If one of the parameters was NULL or the  location  is
191            not inside the window, <STRONG>FALSE</STRONG> is returned.
192
193        <STRONG>o</STRONG>   If <STRONG>to_screen</STRONG> is <STRONG>FALSE</STRONG>, the pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must refer-
194            ence window-relative coordinates.  They are  converted
195            to  stdscr-relative  coordinates if the window <STRONG>win</STRONG> en-
196            closes this point.  In this case the function  returns
197            <STRONG>TRUE</STRONG>.
198
199        <STRONG>o</STRONG>   If  one  of the parameters is NULL or the point is not
200            inside the window, <STRONG>FALSE</STRONG> is returned.  The  referenced
201            coordinates are only replaced by the converted coordi-
202            nates if the transformation was successful.
203
204
205 </PRE><H3><a name="h3-mouse_trafo">mouse_trafo</a></H3><PRE>
206        The <STRONG>mouse_trafo</STRONG> function performs the same translation  as
207        <STRONG>wmouse_trafo</STRONG>, using stdscr for <STRONG>win</STRONG>.
208
209
210 </PRE><H3><a name="h3-mouseinterval">mouseinterval</a></H3><PRE>
211        The <STRONG>mouseinterval</STRONG> function sets the maximum time (in thou-
212        sands of a second) that can elapse between press  and  re-
213        lease  events  for  them to be recognized as a click.  Use
214        <STRONG>mouseinterval(0)</STRONG> to disable click resolution.  This  func-
215        tion returns the previous interval value.  Use <STRONG>mouseinter-</STRONG>
216        <STRONG>val(-1)</STRONG> to obtain the interval without altering  it.   The
217        default is one sixth of a second.
218
219
220 </PRE><H3><a name="h3-has_mouse">has_mouse</a></H3><PRE>
221        The  <STRONG>has_mouse</STRONG>  function  returns <STRONG>TRUE</STRONG> if the mouse driver
222        has been successfully initialized.
223
224        Note that mouse events will be ignored when  input  is  in
225        cooked mode, and will cause an error beep when cooked mode
226        is being simulated in a window by a function such as  <STRONG>get-</STRONG>
227        <STRONG>str</STRONG> that expects a linefeed for input-loop termination.
228
229
230 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
231        <STRONG>getmouse</STRONG>  and <STRONG>ungetmouse</STRONG> return the integer <STRONG>ERR</STRONG> upon fail-
232        ure or <STRONG>OK</STRONG> upon successful completion:
233
234           <STRONG>getmouse</STRONG>
235                returns an error.
236
237           <STRONG>o</STRONG>   If no mouse driver was initialized, or if the  mask
238               parameter is zero,
239
240           <STRONG>o</STRONG>   It  also  returns an error if no more events remain
241               in the queue.
242
243           <STRONG>ungetmouse</STRONG>
244                returns an error if the FIFO is full.
245
246        <STRONG>mousemask</STRONG> returns the mask of reportable events.
247
248        <STRONG>mouseinterval</STRONG> returns the previous interval value,  unless
249        the  terminal  was  not initialized.  In that case, it re-
250        turns the maximum interval value (166).
251
252        <STRONG>wenclose</STRONG> and <STRONG>wmouse_trafo</STRONG> are boolean functions  returning
253        <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG> depending on their test result.
254
255
256 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
257        These  calls  were  designed  for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and are not
258        found in SVr4 curses, 4.4BSD curses, or any other previous
259        version of curses.
260
261        The feature macro <STRONG>NCURSES_MOUSE_VERSION</STRONG> is provided so the
262        preprocessor can be used to test  whether  these  features
263        are  present.   If  the interface is changed, the value of
264        <STRONG>NCURSES_MOUSE_VERSION</STRONG> will be incremented.   These  values
265        for  <STRONG>NCURSES_MOUSE_VERSION</STRONG> may be specified when configur-
266        ing ncurses:
267
268           1  has definitions for reserved events.  The mask  uses
269              28 bits.
270
271           2  adds  definitions  for button 5, removes the defini-
272              tions for reserved events.  The mask uses 29 bits.
273
274        The order of the <STRONG>MEVENT</STRONG> structure members is  not  guaran-
275        teed.   Additional fields may be added to the structure in
276        the future.
277
278        Under <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, these calls are implemented  using  ei-
279        ther  xterm's built-in mouse-tracking API or platform-spe-
280        cific drivers including
281
282           <STRONG>o</STRONG>   Alessandro Rubini's gpm server
283
284           <STRONG>o</STRONG>   FreeBSD sysmouse
285
286           <STRONG>o</STRONG>   OS/2 EMX
287
288        If you  are  using  an  unsupported  configuration,  mouse
289        events  will not be visible to <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> (and the <STRONG>mouse-</STRONG>
290        <STRONG>mask</STRONG> function will always return <STRONG>0</STRONG>).
291
292        If the terminfo entry contains a <STRONG>XM</STRONG> string, this  is  used
293        in  the xterm mouse driver to control the way the terminal
294        is initialized for mouse operation.  The default, if <STRONG>XM</STRONG> is
295        not found, corresponds to private mode 1000 of xterm:
296
297           \E[?1000%?%p1%{1}%=%th%el%;
298
299        The <EM>z</EM> member in the event structure is not presently used.
300        It is intended for use with touch screens  (which  may  be
301        pressure-sensitive)   or   with   3D-mice/trackballs/power
302        gloves.
303
304        The  <STRONG>ALL_MOUSE_EVENTS</STRONG>   class   does   not   include   <STRONG>RE-</STRONG>
305        <STRONG>PORT_MOUSE_POSITION</STRONG>.   They are distinct.  For example, in
306        xterm, wheel/scrolling mice send position reports as a se-
307        quence  of presses of buttons 4 or 5 without matching but-
308        ton-releases.
309
310
311 </PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
312        Mouse events under xterm will not in fact be ignored  dur-
313        ing  cooked  mode, if they have been enabled by <STRONG>mousemask</STRONG>.
314        Instead, the xterm mouse report sequence  will  appear  in
315        the string read.
316
317        Mouse events under xterm will not be detected correctly in
318        a window with its keypad bit off, since  they  are  inter-
319        preted  as  a  variety of function key.  Your terminfo de-
320        scription should have <STRONG>kmous</STRONG> set to "\E[M"  (the  beginning
321        of  the response from xterm for mouse clicks).  Other val-
322        ues for <STRONG>kmous</STRONG> are permitted, but under  the  same  assump-
323        tion, i.e., it is the beginning of the response.
324
325        Because  there  are  no  standard  terminal responses that
326        would serve to identify terminals which support the  xterm
327        mouse  protocol,  <STRONG>ncurses</STRONG> assumes that if your $TERM envi-
328        ronment variable contains "xterm", or <STRONG>kmous</STRONG> is defined  in
329        the terminal description, then the terminal may send mouse
330        events.
331
332
333 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
334        <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>
335        <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>.
336
337
338
339                                                          <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>
340 </PRE>
341 <div class="nav">
342 <ul>
343 <li><a href="#h2-NAME">NAME</a></li>
344 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
345 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
346 <ul>
347 <li><a href="#h3-mousemask">mousemask</a></li>
348 <li><a href="#h3-Mouse-events">Mouse events</a></li>
349 <li><a href="#h3-getmouse">getmouse</a></li>
350 <li><a href="#h3-ungetmouse">ungetmouse</a></li>
351 <li><a href="#h3-wenclose">wenclose</a></li>
352 <li><a href="#h3-wmouse_trafo">wmouse_trafo</a></li>
353 <li><a href="#h3-mouse_trafo">mouse_trafo</a></li>
354 <li><a href="#h3-mouseinterval">mouseinterval</a></li>
355 <li><a href="#h3-has_mouse">has_mouse</a></li>
356 </ul>
357 </li>
358 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
359 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
360 <li><a href="#h2-BUGS">BUGS</a></li>
361 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
362 </ul>
363 </div>
364 </BODY>
365 </HTML>