doc/html/man/curs_mouse.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
   5   * Copyright 1998-2015,2017 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.53 2020/10/17 23:25:08 tom Exp @
  32 -->
  33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  34 <HTML>
  35 <HEAD>
  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">
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">curs_mouse 3x</H1>
  44 <PRE>
  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>
  46
  47
  48
  49
  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
  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
  68        <STRONG>int</STRONG> <STRONG>getmouse(MEVENT</STRONG> <STRONG>*</STRONG><EM>event</EM><STRONG>);</STRONG>
  69        <STRONG>int</STRONG> <STRONG>ungetmouse(MEVENT</STRONG> <STRONG>*</STRONG><EM>event</EM><STRONG>);</STRONG>
  70
  71        <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>
  72
  73        <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>
  74
  75        <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>
  76        <STRONG>bool</STRONG> <STRONG>wmouse_trafo(const</STRONG> <STRONG>WINDOW*</STRONG> <EM>win</EM><STRONG>,</STRONG>
  77                          <STRONG>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>
  78
  79        <STRONG>int</STRONG> <STRONG>mouseinterval(int</STRONG> <EM>erval</EM><STRONG>);</STRONG>
  80
  81
  82 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  83        These functions provide an interface to mouse events from  <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>.
  84        Mouse  events  are  represented  by  <STRONG>KEY_MOUSE</STRONG> pseudo-key values in the
  85        <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG> input stream.
  86
  87
  88 </PRE><H3><a name="h3-mousemask">mousemask</a></H3><PRE>
  89        To make mouse events visible, use the <STRONG>mousemask</STRONG>  function.   This  will
  90        set  the  mouse events to be reported.  By default, no mouse events are
  91        reported.  The function will return a mask to  indicate  which  of  the
  92        specified  mouse events can be reported; on complete failure it returns
  93        0.  If oldmask is non-NULL, this function fills the indicated  location
  94        with the previous value of the given window's mouse event mask.
  95
  96        As  a  side  effect,  setting  a  zero mousemask may turn off the mouse
  97        pointer; setting a nonzero mask may turn it on.  Whether  this  happens
  98        is device-dependent.
  99
 100
 101 </PRE><H3><a name="h3-Mouse-events">Mouse events</a></H3><PRE>
 102        Here are the mouse event type masks which may be defined:
 103
 104        <EM>Name</EM>                     <EM>Description</EM>
 105        ---------------------------------------------------------------------
 106        BUTTON1_PRESSED          mouse button 1 down
 107        BUTTON1_RELEASED         mouse button 1 up
 108        BUTTON1_CLICKED          mouse button 1 clicked
 109        BUTTON1_DOUBLE_CLICKED   mouse button 1 double clicked
 110        BUTTON1_TRIPLE_CLICKED   mouse button 1 triple clicked
 111        ---------------------------------------------------------------------
 112        BUTTON2_PRESSED          mouse button 2 down
 113        BUTTON2_RELEASED         mouse button 2 up
 114        BUTTON2_CLICKED          mouse button 2 clicked
 115
 116        BUTTON2_DOUBLE_CLICKED   mouse button 2 double clicked
 117        BUTTON2_TRIPLE_CLICKED   mouse button 2 triple clicked
 118        ---------------------------------------------------------------------
 119        BUTTON3_PRESSED          mouse button 3 down
 120        BUTTON3_RELEASED         mouse button 3 up
 121        BUTTON3_CLICKED          mouse button 3 clicked
 122        BUTTON3_DOUBLE_CLICKED   mouse button 3 double clicked
 123        BUTTON3_TRIPLE_CLICKED   mouse button 3 triple clicked
 124        ---------------------------------------------------------------------
 125        BUTTON4_PRESSED          mouse button 4 down
 126        BUTTON4_RELEASED         mouse button 4 up
 127        BUTTON4_CLICKED          mouse button 4 clicked
 128        BUTTON4_DOUBLE_CLICKED   mouse button 4 double clicked
 129        BUTTON4_TRIPLE_CLICKED   mouse button 4 triple clicked
 130        ---------------------------------------------------------------------
 131        BUTTON5_PRESSED          mouse button 5 down
 132        BUTTON5_RELEASED         mouse button 5 up
 133        BUTTON5_CLICKED          mouse button 5 clicked
 134        BUTTON5_DOUBLE_CLICKED   mouse button 5 double clicked
 135        BUTTON5_TRIPLE_CLICKED   mouse button 5 triple clicked
 136        ---------------------------------------------------------------------
 137        BUTTON_SHIFT             shift was down during button state change
 138        BUTTON_CTRL              control was down during button state change
 139        BUTTON_ALT               alt was down during button state change
 140        ALL_MOUSE_EVENTS         report all button state changes
 141        REPORT_MOUSE_POSITION    report mouse movement
 142        ---------------------------------------------------------------------
 143
 144
 145 </PRE><H3><a name="h3-getmouse">getmouse</a></H3><PRE>
 146        Once a class of mouse events has been made visible in a window, calling
 147        the <STRONG>wgetch</STRONG> function on that window may return <STRONG>KEY_MOUSE</STRONG> as an indicator
 148        that a mouse event has been queued.  To read the event data and pop the
 149        event off the queue, call <STRONG>getmouse</STRONG>.  This function will return <STRONG>OK</STRONG> if  a
 150        mouse  event  is  actually  visible in the given window, <STRONG>ERR</STRONG> otherwise.
 151        When <STRONG>getmouse</STRONG> returns <STRONG>OK</STRONG>, the data deposited as y and x  in  the  event
 152        structure  coordinates  will  be screen-relative character-cell coordi-
 153        nates.  The returned state mask will have exactly one bit set to  indi-
 154        cate the event type.  The corresponding data in the queue is marked in-
 155        valid.  A subsequent call to <STRONG>getmouse</STRONG> will retrieve the next older item
 156        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>.  It pushes a
 161        <STRONG>KEY_MOUSE</STRONG> event onto the input queue, and associates  with  that  event
 162        the given state data and screen-relative character-cell coordinates.
 163
 164
 165 </PRE><H3><a name="h3-wenclose">wenclose</a></H3><PRE>
 166        The  <STRONG>wenclose</STRONG>  function  tests  whether a given pair of screen-relative
 167        character-cell coordinates is enclosed by  a  given  window,  returning
 168        <STRONG>TRUE</STRONG>  if  it is and <STRONG>FALSE</STRONG> otherwise.  It is useful for determining what
 169        subset of the screen windows enclose the location of a mouse event.
 170
 171
 172 </PRE><H3><a name="h3-wmouse_trafo">wmouse_trafo</a></H3><PRE>
 173        The <STRONG>wmouse_trafo</STRONG> function transforms a given pair of  coordinates  from
 174        stdscr-relative coordinates to coordinates relative to the given window
 175        or vice versa.  The resulting stdscr-relative coordinates are  not  al-
 176        ways  identical  to window-relative coordinates due to the mechanism to
 177        reserve lines on top or bottom of the screen for  other  purposes  (see
 178        the <STRONG>ripoffline</STRONG> and <STRONG><A HREF="curs_slk.3x.html">slk_init(3x)</A></STRONG> calls, for example).
 179
 180        <STRONG>o</STRONG>   If the parameter <STRONG>to_screen</STRONG> is <STRONG>TRUE</STRONG>, the pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must refer-
 181            ence the coordinates of a location inside the window <STRONG>win</STRONG>.  They are
 182            converted  to  window-relative coordinates and returned through the
 183            pointers.  If the conversion was successful, the  function  returns
 184            <STRONG>TRUE</STRONG>.
 185
 186        <STRONG>o</STRONG>   If one of the parameters was NULL or the location is not inside the
 187            window, <STRONG>FALSE</STRONG> is returned.
 188
 189        <STRONG>o</STRONG>   If <STRONG>to_screen</STRONG> is <STRONG>FALSE</STRONG>, the pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must  reference  window-
 190            relative  coordinates.  They are converted to stdscr-relative coor-
 191            dinates if the window <STRONG>win</STRONG> encloses this point.  In  this  case  the
 192            function returns <STRONG>TRUE</STRONG>.
 193
 194        <STRONG>o</STRONG>   If  one  of  the  parameters is NULL or the point is not inside the
 195            window, <STRONG>FALSE</STRONG> is returned.  The referenced coordinates are only re-
 196            placed  by the converted coordinates if the transformation was suc-
 197            cessful.
 198
 199
 200 </PRE><H3><a name="h3-mouse_trafo">mouse_trafo</a></H3><PRE>
 201        The <STRONG>mouse_trafo</STRONG> function performs the same translation as <STRONG>wmouse_trafo</STRONG>,
 202        using stdscr for <STRONG>win</STRONG>.
 203
 204
 205 </PRE><H3><a name="h3-mouseinterval">mouseinterval</a></H3><PRE>
 206        The  <STRONG>mouseinterval</STRONG>  function  sets  the maximum time (in thousands of a
 207        second) that can elapse between press and release events for them to be
 208        recognized  as  a click.  Use <STRONG>mouseinterval(0)</STRONG> to disable click resolu-
 209        tion.  This function returns the previous interval value.  Use <STRONG>mousein-</STRONG>
 210        <STRONG>terval(-1)</STRONG>  to obtain the interval without altering it.  The default is
 211        one sixth of a second.
 212
 213
 214 </PRE><H3><a name="h3-has_mouse">has_mouse</a></H3><PRE>
 215        The <STRONG>has_mouse</STRONG> function returns <STRONG>TRUE</STRONG> if the mouse driver has  been  suc-
 216        cessfully initialized.
 217
 218        Note  that  mouse  events will be ignored when input is in cooked mode,
 219        and will cause an error beep when cooked mode is being simulated  in  a
 220        window  by a function such as <STRONG>getstr</STRONG> that expects a linefeed for input-
 221        loop termination.
 222
 223
 224 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 225        <STRONG>getmouse</STRONG> and <STRONG>ungetmouse</STRONG> return the integer <STRONG>ERR</STRONG> upon failure or <STRONG>OK</STRONG>  upon
 226        successful completion:
 227
 228           <STRONG>getmouse</STRONG>
 229                returns an error.
 230
 231           <STRONG>o</STRONG>   If  no mouse driver was initialized, or if the mask parameter is
 232               zero,
 233
 234           <STRONG>o</STRONG>   It also returns an error if no more events remain in the queue.
 235
 236           <STRONG>ungetmouse</STRONG>
 237                returns an error if the FIFO is full.
 238
 239        <STRONG>mousemask</STRONG> returns the mask of reportable events.
 240
 241        <STRONG>mouseinterval</STRONG> returns the previous interval value, unless the  terminal
 242        was  not  initialized.   In  that case, it returns the maximum interval
 243        value (166).
 244
 245        <STRONG>wenclose</STRONG> and <STRONG>wmouse_trafo</STRONG> are boolean functions returning <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>
 246        depending on their test result.
 247
 248
 249 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 250        These  calls  were  designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and are not found in SVr4
 251        curses, 4.4BSD curses, or any other previous version of curses.
 252
 253        SVr4 curses had support for the mouse in a variant  of  <STRONG>xterm</STRONG>.   It  is
 254        mentioned in a few places, but with no supporting documentation:
 255
 256        <STRONG>o</STRONG>   the  "libcurses" manual page lists functions for this feature which
 257            are prototyped in <STRONG>curses.h</STRONG>:
 258
 259                extern int mouse_set(long int);
 260                extern int mouse_on(long int);
 261                extern int mouse_off(long int);
 262                extern int request_mouse_pos(void);
 263                extern int map_button(unsigned long);
 264                extern void wmouse_position(WINDOW *, int *, int *);
 265                extern unsigned long getmouse(void), getbmap(void);
 266
 267        <STRONG>o</STRONG>   the "terminfo" manual page lists capabilities for the feature
 268
 269                buttons           btns    BT       Number of buttons on the mouse
 270                get_mouse         getm    Gm       Curses should get button events
 271                key_mouse         kmous   Km       0631, Mouse event has occurred
 272                mouse_info        minfo   Mi       Mouse status information
 273                req_mouse_pos     reqmp   RQ       Request mouse position report
 274
 275        <STRONG>o</STRONG>   the interface made assumptions (as does ncurses) about  the  escape
 276            sequences sent to and received from the terminal.
 277
 278            For  instance the SVr4 curses library used the <STRONG>get_mouse</STRONG> capability
 279            to tell the terminal which mouse  button  events  it  should  send,
 280            passing  the mouse-button bit-mask to the terminal.  Also, it could
 281            ask the terminal where the mouse was using the <STRONG>req_mouse_pos</STRONG>  capa-
 282            bility.
 283
 284            Those  features required a terminal which had been modified to work
 285            with curses.  They were not part of the X Consortium's xterm.
 286
 287        When developing the xterm mouse support for ncurses in September  1995,
 288        Eric  Raymond  was  uninterested in using the same interface due to its
 289        lack of documentation.  Later, in 1998, Mark Hesseling provided support
 290        in  PDCurses 2.3 using the SVr4 interface.  PDCurses, however, does not
 291        use video terminals, making it unnecessary to be concerned  about  com-
 292        patibility with the escape sequences.
 293
 294        The feature macro <STRONG>NCURSES_MOUSE_VERSION</STRONG> is provided so the preprocessor
 295        can be used to test whether these features are present.  If the  inter-
 296        face  is changed, the value of <STRONG>NCURSES_MOUSE_VERSION</STRONG> will be increment-
 297        ed.  These values for <STRONG>NCURSES_MOUSE_VERSION</STRONG> may be specified when  con-
 298        figuring ncurses:
 299
 300           1  has definitions for reserved events.  The mask uses 28 bits.
 301
 302           2  adds  definitions  for  button 5, removes the definitions for re-
 303              served events.  The mask uses 29 bits.
 304
 305        The order of the <STRONG>MEVENT</STRONG> structure members is not guaranteed.  Addition-
 306        al fields may be added to the structure in the future.
 307
 308        Under  <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>,  these  calls  are implemented using either xterm's
 309        built-in mouse-tracking API or platform-specific drivers including
 310
 311           <STRONG>o</STRONG>   Alessandro Rubini's gpm server
 312
 313           <STRONG>o</STRONG>   FreeBSD sysmouse
 314
 315           <STRONG>o</STRONG>   OS/2 EMX
 316
 317        If you are using an unsupported configuration, mouse events will not be
 318        visible  to  <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> (and the <STRONG>mousemask</STRONG> function will always return
 319        <STRONG>0</STRONG>).
 320
 321        If the terminfo entry contains a <STRONG>XM</STRONG> string, this is used in  the  xterm
 322        mouse  driver  to control the way the terminal is initialized for mouse
 323        operation.  The default, if <STRONG>XM</STRONG> is not  found,  corresponds  to  private
 324        mode 1000 of xterm:
 325
 326           \E[?1000%?%p1%{1}%=%th%el%;
 327
 328        The mouse driver also recognizes a newer xterm private mode 1006, e.g.,
 329
 330           \E[?1006;1000%?%p1%{1}%=%th%el%;
 331
 332        The  <EM>z</EM>  member in the event structure is not presently used.  It is in-
 333        tended for use with touch screens (which may be pressure-sensitive)  or
 334        with 3D-mice/trackballs/power gloves.
 335
 336        The  <STRONG>ALL_MOUSE_EVENTS</STRONG>  class  does  not  include <STRONG>REPORT_MOUSE_POSITION</STRONG>.
 337        They are distinct.  For example, in xterm,  wheel/scrolling  mice  send
 338        position  reports  as  a  sequence of presses of buttons 4 or 5 without
 339        matching button-releases.
 340
 341
 342 </PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
 343        Mouse events under xterm will not in  fact  be  ignored  during  cooked
 344        mode, if they have been enabled by <STRONG>mousemask</STRONG>.  Instead, the xterm mouse
 345        report sequence will appear in the string read.
 346
 347        Mouse events under xterm will not be detected  correctly  in  a  window
 348        with  its  keypad  bit  off, since they are interpreted as a variety of
 349        function key.  Your terminfo  description  should  have  <STRONG>kmous</STRONG>  set  to
 350        "\E[M"  (the  beginning  of  the response from xterm for mouse clicks).
 351        Other values for <STRONG>kmous</STRONG> are permitted, but under  the  same  assumption,
 352        i.e., it is the beginning of the response.
 353
 354        Because  there  are  no standard terminal responses that would serve to
 355        identify terminals which support the xterm mouse protocol, <STRONG>ncurses</STRONG>  as-
 356        sumes  that  if <STRONG>kmous</STRONG> is defined in the terminal description, or if the
 357        terminal description's primary  name  or  aliases  contain  the  string
 358        "xterm", then the terminal may send mouse events.  The <STRONG>kmous</STRONG> capability
 359        is checked first, allowing the use of newer xterm mouse protocols  such
 360        as xterm's private mode 1006.
 361
 362
 363 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 364        <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>.
 365
 366
 367
 368                                                                 <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>
 369 </PRE>
 370 <div class="nav">
 371 <ul>
 372 <li><a href="#h2-NAME">NAME</a></li>
 373 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 374 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
 375 <ul>
 376 <li><a href="#h3-mousemask">mousemask</a></li>
 377 <li><a href="#h3-Mouse-events">Mouse events</a></li>
 378 <li><a href="#h3-getmouse">getmouse</a></li>
 379 <li><a href="#h3-ungetmouse">ungetmouse</a></li>
 380 <li><a href="#h3-wenclose">wenclose</a></li>
 381 <li><a href="#h3-wmouse_trafo">wmouse_trafo</a></li>
 382 <li><a href="#h3-mouse_trafo">mouse_trafo</a></li>
 383 <li><a href="#h3-mouseinterval">mouseinterval</a></li>
 384 <li><a href="#h3-has_mouse">has_mouse</a></li>
 385 </ul>
 386 </li>
 387 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 388 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 389 <li><a href="#h2-BUGS">BUGS</a></li>
 390 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 391 </ul>
 392 </div>
 393 </BODY>
 394 </HTML>