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