ncurses 5.4
[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-2002,2003 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.24 2003/12/27 18:47:54 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>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
53        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>int</STRONG> <STRONG>getmouse(MEVENT</STRONG> <STRONG>*event);</STRONG>
70        <STRONG>int</STRONG> <STRONG>ungetmouse(MEVENT</STRONG> <STRONG>*event);</STRONG>
71        <STRONG>mmask_t</STRONG> <STRONG>mousemask(mmask_t</STRONG> <STRONG>newmask,</STRONG> <STRONG>mmask_t</STRONG> <STRONG>*oldmask);</STRONG>
72        <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>
73        <STRONG>bool</STRONG> <STRONG>mouse_trafo(int*</STRONG> <STRONG>pY,</STRONG> <STRONG>int*</STRONG> <STRONG>pX,</STRONG> <STRONG>bool</STRONG> <STRONG>to_screen);</STRONG>
74        <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>
75             <STRONG>bool</STRONG> <STRONG>to_screen);</STRONG>
76        <STRONG>int</STRONG> <STRONG>mouseinterval(int</STRONG> <STRONG>erval);</STRONG>
77
78
79 </PRE>
80 <H2>DESCRIPTION</H2><PRE>
81        These  functions provide an interface to mouse events from
82        <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>.  Mouse events are  represented  by  <STRONG>KEY_MOUSE</STRONG>
83        pseudo-key values in the <STRONG>wgetch</STRONG> input stream.
84
85        To  make mouse events visible, use the <STRONG>mousemask</STRONG> function.
86        This will  set  the  mouse  events  to  be  reported.   By
87        default,  no mouse events are reported.  The function will
88        return a mask to indicate which  of  the  specified  mouse
89        events  can be reported; on complete failure it returns 0.
90        If oldmask is non-NULL, this function fills the  indicated
91        location  with  the  previous  value of the given window's
92        mouse event mask.
93
94        As a side effect, setting a zero mousemask  may  turn  off
95        the  mouse pointer; setting a nonzero mask may turn it on.
96        Whether this happens is device-dependent.
97
98        Here are the mouse event type masks:
99
100        <EM>Name</EM>                     <EM>Description</EM>
101        ---------------------------------------------------------------------
102        BUTTON1_PRESSED          mouse button 1 down
103        BUTTON1_RELEASED         mouse button 1 up
104        BUTTON1_CLICKED          mouse button 1 clicked
105        BUTTON1_DOUBLE_CLICKED   mouse button 1 double clicked
106        BUTTON1_TRIPLE_CLICKED   mouse button 1 triple clicked
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        BUTTON3_PRESSED          mouse button 3 down
113        BUTTON3_RELEASED         mouse button 3 up
114        BUTTON3_CLICKED          mouse button 3 clicked
115
116        BUTTON3_DOUBLE_CLICKED   mouse button 3 double clicked
117        BUTTON3_TRIPLE_CLICKED   mouse button 3 triple clicked
118        BUTTON4_PRESSED          mouse button 4 down
119        BUTTON4_RELEASED         mouse button 4 up
120        BUTTON4_CLICKED          mouse button 4 clicked
121        BUTTON4_DOUBLE_CLICKED   mouse button 4 double clicked
122        BUTTON4_TRIPLE_CLICKED   mouse button 4 triple clicked
123        BUTTON_SHIFT             shift was down during button state change
124        BUTTON_CTRL              control was down during button state change
125        BUTTON_ALT               alt was down during button state change
126        ALL_MOUSE_EVENTS         report all button state changes
127        REPORT_MOUSE_POSITION    report mouse movement
128
129        Once a class of mouse events have been made visible  in  a
130        window,  calling  the  <STRONG>wgetch</STRONG>  function on that window may
131        return <STRONG>KEY_MOUSE</STRONG> as an indicator that a  mouse  event  has
132        been queued.  To read the event data and pop the event off
133        the queue, call <STRONG>getmouse</STRONG>.  This function will return <STRONG>OK</STRONG> if
134        a mouse event is actually visible in the given window, <STRONG>ERR</STRONG>
135        otherwise.  When <STRONG>getmouse</STRONG> returns <STRONG>OK</STRONG>, the  data  deposited
136        as  y  and  x  in  the event structure coordinates will be
137        screen-relative character-cell coordinates.  The  returned
138        state  mask  will have exactly one bit set to indicate the
139        event type.
140
141        The <STRONG>ungetmouse</STRONG> function behaves  analogously  to  <STRONG>ungetch</STRONG>.
142        It  pushes  a  <STRONG>KEY_MOUSE</STRONG>  event  onto the input queue, and
143        associates with  that  event  the  given  state  data  and
144        screen-relative character-cell coordinates.
145
146        The  <STRONG>wenclose</STRONG>  function  tests  whether  a  given  pair of
147        screen-relative character-cell coordinates is enclosed  by
148        a  given  window, returning TRUE if it is and FALSE other-
149        wise.  It is useful for determining  what  subset  of  the
150        screen windows enclose the location of a mouse event.
151
152        The <STRONG>wmouse_trafo</STRONG> function transforms a given pair of coor-
153        dinates from stdscr-relative coordinates  to  screen-rela-
154        tive  coordinates  or  vice  versa.  Please remember, that
155        stdscr-relative coordinates are not  always  identical  to
156        screen-relative   coordinates  due  to  the  mechanism  to
157        reserve lines on top or bottom of  the  screen  for  other
158        purposes (ripoff() call, see also slk_...  functions).  If
159        the parameter <STRONG>to_screen</STRONG> is <STRONG>TRUE</STRONG>, the pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG>  must
160        reference  the coordinates of a location inside the window
161        <STRONG>win</STRONG>.  They are converted  to  screen-relative  coordinates
162        and  returned through the pointers.  If the conversion was
163        successful, the function returns  <STRONG>TRUE</STRONG>.   If  one  of  the
164        parameters was NULL or the location is not inside the win-
165        dow, <STRONG>FALSE</STRONG> is returned.  If <STRONG>to_screen</STRONG> is <STRONG>FALSE</STRONG>, the point-
166        ers  <STRONG>pY,</STRONG>  <STRONG>pX</STRONG>  must  reference screen-relative coordinates.
167        They are converted to stdscr-relative coordinates  if  the
168        window <STRONG>win</STRONG> encloses this point.  In this case the function
169        returns <STRONG>TRUE</STRONG>.  If one of the parameters  is  NULL  or  the
170        point is not inside the window, <STRONG>FALSE</STRONG> is returned.  Please
171        notice, that the referenced coordinates are only  replaced
172        by  the  converted  coordinates  if the transformation was
173        successful.
174
175        The <STRONG>mouseinterval</STRONG> function sets the maximum time (in thou-
176        sands  of  a  second)  that  can  elapse between press and
177        release events for them to be recognized as a click.   Use
178        <STRONG>mouseinterval(-1)</STRONG> to disable click resolution.  This func-
179        tion returns the previous interval value.  The default  is
180        one sixth of a second.
181
182        Note  that  mouse  events will be ignored when input is in
183        cooked mode, and will cause an error beep when cooked mode
184        is  being simulated in a window by a function such as <STRONG>get-</STRONG>
185        <STRONG>str</STRONG> that expects a linefeed for input-loop termination.
186
187
188 </PRE>
189 <H2>RETURN VALUE</H2><PRE>
190        <STRONG>getmouse</STRONG>, <STRONG>ungetmouse</STRONG> and <STRONG>mouseinterval</STRONG> return the  integer
191        <STRONG>ERR</STRONG> upon failure or <STRONG>OK</STRONG> upon successful completion.  <STRONG>mouse-</STRONG>
192        <STRONG>mask</STRONG> returns the mask of reportable events.  <STRONG>wenclose</STRONG>  and
193        <STRONG>wmouse_trafo</STRONG> are boolean functions returning <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>
194        depending on their test result.
195
196
197 </PRE>
198 <H2>PORTABILITY</H2><PRE>
199        These calls were designed for  <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>,  and  are  not
200        found in SVr4 curses, 4.4BSD curses, or any other previous
201        version of curses.
202
203        The feature macro <STRONG>NCURSES_MOUSE_VERSION</STRONG> is provided so the
204        preprocessor  can  be  used to test whether these features
205        are present  (its  value  is  1).   If  the  interface  is
206        changed, the value of <STRONG>NCURSES_MOUSE_VERSION</STRONG> will be incre-
207        mented.
208
209        The order of the <STRONG>MEVENT</STRONG> structure members is  not  guaran-
210        teed.   Additional fields may be added to the structure in
211        the future.
212
213        Under  <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>,  these  calls  are  implemented  using
214        either  xterm's  built-in  mouse-tracking API or platform-
215        specific drivers including
216               Alessandro Rubini's gpm server.
217               FreeBSD sysmouse
218               OS/2 EMX
219        If you  are  using  an  unsupported  configuration,  mouse
220        events will not be visible to <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> (and the <STRONG>wmouse-</STRONG>
221        <STRONG>mask</STRONG> function will always return <STRONG>0</STRONG>).
222
223        If the terminfo entry contains a <STRONG>XM</STRONG> string, this  is  used
224        in  the xterm mouse driver to control the way the terminal
225        is initialized for mouse operation.  The default, if <STRONG>XM</STRONG> is
226        not found, corresponds to private mode 1000 of xterm:
227               \E[?1000%?%p1%{1}%=%th%el%;
228        The z member in the event structure is not presently used.
229        It is intended for use with touch screens  (which  may  be
230        pressure-sensitive)   or   with   3D-mice/trackballs/power
231        gloves.
232
233
234 </PRE>
235 <H2>BUGS</H2><PRE>
236        Mouse events under xterm will not in fact be ignored  dur-
237        ing  cooked mode, if they have been enabled by <STRONG>wmousemask</STRONG>.
238        Instead, the xterm mouse report sequence  will  appear  in
239        the string read.
240
241        Mouse events under xterm will not be detected correctly in
242        a window with its keypad bit off, since  they  are  inter-
243        preted  as  a  variety  of  function  key.   Your terminfo
244        description must have <STRONG>kmous</STRONG> set to "\E[M"  (the  beginning
245        of the response from xterm for mouse clicks).
246
247        Because  there  are  no  standard  terminal responses that
248        would serve to identify terminals which support the  xterm
249        mouse  protocol,  <STRONG>ncurses</STRONG> assumes that if your $TERM envi-
250        ronment variable contains "xterm", or <STRONG>kmous</STRONG> is defined  in
251        the terminal description, then the terminal may send mouse
252        events.
253
254
255 </PRE>
256 <H2>SEE ALSO</H2><PRE>
257        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
258
259
260
261                                                    <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>
262 </PRE>
263 <HR>
264 <ADDRESS>
265 Man(1) output converted with
266 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
267 </ADDRESS>
268 </BODY>
269 </HTML>