ncurses 5.8 - patch 20110226
[ncurses.git] / doc / html / man / curs_mouse.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc.              *
6   *                                                                          *
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:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
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.                               *
25   *                                                                          *
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       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: curs_mouse.3x,v 1.38 2010/12/04 18:38:55 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
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">
38 </HEAD>
39 <BODY>
40 <H1>curs_mouse 3x</H1>
41 <HR>
42 <PRE>
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>
45
46
47
48
49 </PRE>
50 <H2>NAME</H2><PRE>
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
53        through curses
54
55
56 </PRE>
57 <H2>SYNOPSIS</H2><PRE>
58        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
59
60        <STRONG>typedef</STRONG> <STRONG>unsigned</STRONG> <STRONG>long</STRONG> <STRONG>mmask_t;</STRONG>
61
62        typedef struct
63        {
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>
67        <STRONG>}</STRONG>
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>
78
79
80 </PRE>
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.
85
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
93        mouse event mask.
94
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.
98
99        Here are the mouse event type masks which may be defined:
100
101
102        <EM>Name</EM>                     <EM>Description</EM>
103        ---------------------------------------------------------------------
104        BUTTON1_PRESSED          mouse button 1 down
105        BUTTON1_RELEASED         mouse button 1 up
106        BUTTON1_CLICKED          mouse button 1 clicked
107        BUTTON1_DOUBLE_CLICKED   mouse button 1 double clicked
108        BUTTON1_TRIPLE_CLICKED   mouse button 1 triple clicked
109        ---------------------------------------------------------------------
110        BUTTON2_PRESSED          mouse button 2 down
111        BUTTON2_RELEASED         mouse button 2 up
112        BUTTON2_CLICKED          mouse button 2 clicked
113        BUTTON2_DOUBLE_CLICKED   mouse button 2 double clicked
114
115
116        BUTTON2_TRIPLE_CLICKED   mouse button 2 triple clicked
117        ---------------------------------------------------------------------
118        BUTTON3_PRESSED          mouse button 3 down
119        BUTTON3_RELEASED         mouse button 3 up
120        BUTTON3_CLICKED          mouse button 3 clicked
121        BUTTON3_DOUBLE_CLICKED   mouse button 3 double clicked
122        BUTTON3_TRIPLE_CLICKED   mouse button 3 triple clicked
123        ---------------------------------------------------------------------
124        BUTTON4_PRESSED          mouse button 4 down
125        BUTTON4_RELEASED         mouse button 4 up
126        BUTTON4_CLICKED          mouse button 4 clicked
127        BUTTON4_DOUBLE_CLICKED   mouse button 4 double clicked
128        BUTTON4_TRIPLE_CLICKED   mouse button 4 triple clicked
129        ---------------------------------------------------------------------
130        BUTTON5_PRESSED          mouse button 5 down
131        BUTTON5_RELEASED         mouse button 5 up
132        BUTTON5_CLICKED          mouse button 5 clicked
133        BUTTON5_DOUBLE_CLICKED   mouse button 5 double clicked
134        BUTTON5_TRIPLE_CLICKED   mouse button 5 triple clicked
135        ---------------------------------------------------------------------
136        BUTTON_SHIFT             shift was down during button state change
137        BUTTON_CTRL              control was down during button state change
138        BUTTON_ALT               alt was down during button state change
139        ALL_MOUSE_EVENTS         report all button state changes
140        REPORT_MOUSE_POSITION    report mouse movement
141        ---------------------------------------------------------------------
142
143        Once a class of mouse events have been made visible  in  a
144        window, calling the <STRONG>wgetch</STRONG> function on that window may re-
145        turn <STRONG>KEY_MOUSE</STRONG> as an indicator that a mouse event has been
146        queued.   To read the event data and pop the event off the
147        queue, call <STRONG>getmouse</STRONG>.  This function will return <STRONG>OK</STRONG>  if  a
148        mouse  event  is actually visible in the given window, <STRONG>ERR</STRONG>
149        otherwise.  When <STRONG>getmouse</STRONG> returns <STRONG>OK</STRONG>, the  data  deposited
150        as  y  and  x  in  the event structure coordinates will be
151        screen-relative character-cell coordinates.  The  returned
152        state  mask  will have exactly one bit set to indicate the
153        event type.  The corresponding data in the queue is marked
154        invalid.   A subsequent call to <STRONG>getmouse</STRONG> will retrieve the
155        next older item from the queue.
156
157        The <STRONG>ungetmouse</STRONG> function behaves  analogously  to  <STRONG>ungetch</STRONG>.
158        It  pushes a <STRONG>KEY_MOUSE</STRONG> event onto the input queue, and as-
159        sociates with that event the given state data and  screen-
160        relative character-cell coordinates.
161
162        The  <STRONG>wenclose</STRONG>  function  tests  whether  a  given  pair of
163        screen-relative character-cell coordinates is enclosed  by
164        a  given  window, returning TRUE if it is and FALSE other-
165        wise.  It is useful for determining  what  subset  of  the
166        screen windows enclose the location of a mouse event.
167
168        The <STRONG>wmouse_trafo</STRONG> function transforms a given pair of coor-
169        dinates from stdscr-relative  coordinates  to  coordinates
170        relative to the given window or vice versa.  Please remem-
171        ber, that stdscr-relative coordinates are not always iden-
172        tical  to window-relative coordinates due to the mechanism
173        to reserve lines on top or bottom of the screen for  other
174        purposes (see the <STRONG>ripoffline()</STRONG> and <STRONG>slk_init</STRONG> calls, for ex-
175        ample).  If the parameter <STRONG>to_screen</STRONG> is <STRONG>TRUE</STRONG>, the  pointers
176        <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must reference the coordinates of a location inside
177        the window <STRONG>win</STRONG>.  They are converted to window-relative co-
178        ordinates  and returned through the pointers.  If the con-
179        version was successful, the function returns <STRONG>TRUE</STRONG>.  If one
180        of  the  parameters was NULL or the location is not inside
181        the window, <STRONG>FALSE</STRONG> is returned.  If <STRONG>to_screen</STRONG> is <STRONG>FALSE</STRONG>, the
182        pointers  <STRONG>pY,</STRONG>  <STRONG>pX</STRONG>  must  reference window-relative coordi-
183        nates.  They are converted to stdscr-relative  coordinates
184        if  the  window <STRONG>win</STRONG> encloses this point.  In this case the
185        function returns <STRONG>TRUE</STRONG>.  If one of the parameters  is  NULL
186        or  the point is not inside the window, <STRONG>FALSE</STRONG> is returned.
187        Please notice, that the referenced  coordinates  are  only
188        replaced  by  the converted coordinates if the transforma-
189        tion was successful.
190
191        The <STRONG>mouse_trafo</STRONG> function performs the same translation  as
192        <STRONG>wmouse_trafo</STRONG>, using stdscr for <STRONG>win</STRONG>.
193
194        The <STRONG>mouseinterval</STRONG> function sets the maximum time (in thou-
195        sands of a second) that can elapse between press  and  re-
196        lease  events  for  them to be recognized as a click.  Use
197        <STRONG>mouseinterval(0)</STRONG> to disable click resolution.  This  func-
198        tion returns the previous interval value.  Use <STRONG>mouseinter-</STRONG>
199        <STRONG>val(-1)</STRONG> to obtain the interval without altering  it.   The
200        default is one sixth of a second.
201
202        The  <STRONG>has_mouse</STRONG>  function  returns TRUE if the mouse driver
203        has been successfully initialized.
204
205        Note that mouse events will be ignored when  input  is  in
206        cooked mode, and will cause an error beep when cooked mode
207        is being simulated in a window by a function such as  <STRONG>get-</STRONG>
208        <STRONG>str</STRONG> that expects a linefeed for input-loop termination.
209
210
211 </PRE>
212 <H2>RETURN VALUE</H2><PRE>
213        <STRONG>getmouse</STRONG>  and <STRONG>ungetmouse</STRONG> return the integer <STRONG>ERR</STRONG> upon fail-
214        ure or <STRONG>OK</STRONG> upon successful completion.
215
216               <STRONG>getmouse</STRONG>
217                    returns an error.  If no mouse driver was ini-
218                    tialized, or if the mask parameter is zero, it
219                    also returns an error if no more events remain
220                    in the queue.
221
222               <STRONG>ungetmouse</STRONG>
223                    returns an error if the FIFO is full.
224
225        <STRONG>mousemask</STRONG> returns the mask of reportable events.
226
227        <STRONG>mouseinterval</STRONG>  returns the previous interval value, unless
228        the terminal was not initialized.  In that  case,  it  re-
229        turns the maximum interval value (166).
230
231        <STRONG>wenclose</STRONG>  and <STRONG>wmouse_trafo</STRONG> are boolean functions returning
232        <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG> depending on their test result.
233
234
235 </PRE>
236 <H2>PORTABILITY</H2><PRE>
237        These calls were designed for  <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>,  and  are  not
238        found in SVr4 curses, 4.4BSD curses, or any other previous
239        version of curses.
240
241        The feature macro <STRONG>NCURSES_MOUSE_VERSION</STRONG> is provided so the
242        preprocessor  can  be  used to test whether these features
243        are present.  If the interface is changed,  the  value  of
244        <STRONG>NCURSES_MOUSE_VERSION</STRONG>  will  be incremented.  These values
245        for <STRONG>NCURSES_MOUSE_VERSION</STRONG> may be specified when  configur-
246        ing ncurses:
247
248               1  has  definitions  for reserved events.  The mask
249                  uses 28 bits.
250
251               2  adds definitions for button 5, removes the defi-
252                  nitions  for  reserved events.  The mask uses 29
253                  bits.
254
255        The order of the <STRONG>MEVENT</STRONG> structure members is  not  guaran-
256        teed.   Additional fields may be added to the structure in
257        the future.
258
259        Under <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, these calls are implemented  using  ei-
260        ther  xterm's built-in mouse-tracking API or platform-spe-
261        cific drivers including
262               Alessandro Rubini's gpm server
263               FreeBSD sysmouse
264               OS/2 EMX
265        If you  are  using  an  unsupported  configuration,  mouse
266        events  will not be visible to <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> (and the <STRONG>mouse-</STRONG>
267        <STRONG>mask</STRONG> function will always return <STRONG>0</STRONG>).
268
269        If the terminfo entry contains a <STRONG>XM</STRONG> string, this  is  used
270        in  the xterm mouse driver to control the way the terminal
271        is initialized for mouse operation.  The default, if <STRONG>XM</STRONG> is
272        not found, corresponds to private mode 1000 of xterm:
273               \E[?1000%?%p1%{1}%=%th%el%;
274        The z member in the event structure is not presently used.
275        It is intended for use with touch screens  (which  may  be
276        pressure-sensitive)   or   with   3D-mice/trackballs/power
277        gloves.
278
279
280 </PRE>
281 <H2>BUGS</H2><PRE>
282        Mouse events under xterm will not in fact be ignored  dur-
283        ing  cooked  mode, if they have been enabled by <STRONG>mousemask</STRONG>.
284        Instead, the xterm mouse report sequence  will  appear  in
285        the string read.
286
287        Mouse events under xterm will not be detected correctly in
288        a window with its keypad bit off, since  they  are  inter-
289        preted  as  a  variety of function key.  Your terminfo de-
290        scription should have <STRONG>kmous</STRONG> set to "\E[M"  (the  beginning
291        of  the response from xterm for mouse clicks).  Other val-
292        ues for <STRONG>kmous</STRONG> are permitted, but under  the  same  assump-
293        tion, i.e., it is the beginning of the response.
294
295        Because  there  are  no  standard  terminal responses that
296        would serve to identify terminals which support the  xterm
297        mouse  protocol,  <STRONG>ncurses</STRONG> assumes that if your $TERM envi-
298        ronment variable contains "xterm", or <STRONG>kmous</STRONG> is defined  in
299        the terminal description, then the terminal may send mouse
300        events.
301
302
303 </PRE>
304 <H2>SEE ALSO</H2><PRE>
305        <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>
306        <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>.
307
308
309
310                                                          <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>
311 </PRE>
312 <HR>
313 <ADDRESS>
314 Man(1) output converted with
315 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
316 </ADDRESS>
317 </BODY>
318 </HTML>