man/curs_mouse.3x

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
   4 .\" Copyright 1998-2015,2017 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 .\"
  31 .\" $Id: curs_mouse.3x,v 1.83 2023/12/23 20:37:56 tom Exp $
  32 .TH curs_mouse 3X 2023-12-23 "ncurses 6.4" "Library calls"
  33 .ie \n(.g \{\
  34 .ds `` \(lq
  35 .ds '' \(rq
  36 .\}
  37 .el \{\
  38 .ie t .ds `` ``
  39 .el   .ds `` ""
  40 .ie t .ds '' ''
  41 .el   .ds '' ""
  42 .\}
  43 .
  44 .de bP
  45 .ie n  .IP \(bu 4
  46 .el    .IP \(bu 2
  47 ..
  48 .SH NAME
  49 \fB\%has_mouse\fP,
  50 \fB\%getmouse\fP,
  51 \fB\%ungetmouse\fP,
  52 \fB\%mousemask\fP,
  53 \fB\%wenclose\fP,
  54 \fB\%mouse_trafo\fP,
  55 \fB\%wmouse_trafo\fP,
  56 \fB\%mouseinterval\fP \-
  57 get mouse events in \fIcurses\fR
  58 .SH SYNOPSIS
  59 .nf
  60 \fB#include <curses.h>
  61 .PP
  62 \fBtypedef unsigned long mmask_t;
  63 .PP
  64 \fBtypedef struct {
  65 \fB    short id;         \fI/* ID to distinguish multiple devices */
  66 \fB    int x, y, z;      \fI/* event coordinates */
  67 \fB    mmask_t bstate;   \fI/* button state bits */
  68 \fB} MEVENT;
  69 .PP
  70 \fBbool has_mouse(void);
  71 .PP
  72 \fBint getmouse(MEVENT *\fIevent\fP);
  73 \fBint ungetmouse(MEVENT *\fIevent\fP);
  74 .PP
  75 \fBmmask_t mousemask(mmask_t \fInewmask\fP, mmask_t *\fIoldmask\fP);
  76 .PP
  77 \fBbool wenclose(const WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP);
  78 .PP
  79 \fBbool mouse_trafo(int* \fIpY\fP, int* \fIpX\fP, bool \fIto_screen\fP);
  80 \fBbool wmouse_trafo(const WINDOW* \fIwin\fP,
  81                   \fBint* \fIpY\fB, int* \fIpX\fB, bool \fIto_screen\fB);\fR
  82 .PP
  83 \fBint mouseinterval(int \fIerval\fB);\fR
  84 .fi
  85 .SH DESCRIPTION
  86 These functions provide an interface to mouse events from
  87 \fB\%ncurses\fP(3X).
  88 Mouse events are represented by \fB\%KEY_MOUSE\fP
  89 pseudo-key values in the \fB\%wgetch\fP(3X) input stream.
  90 .SS mousemask
  91 To make mouse events visible, use the \fB\%mousemask\fP function.
  92 This sets the mouse events to be reported.
  93 By default, no mouse events are reported.
  94 .bP
  95 The function returns an updated copy of \fInewmask\fP
  96 to indicate which of the specified mouse events can be reported.
  97 .IP
  98 If the screen has not been initialized,
  99 or if the terminal does not support mouse-events,
 100 this function returns 0.
 101 .bP
 102 If \fIoldmask\fP is non-\fBNULL\fP,
 103 this function fills the indicated location with the previous value of the
 104 current screen's mouse event mask.
 105 .PP
 106 As a side effect, setting a zero mousemask may turn off the mouse pointer;
 107 setting a nonzero mask may turn it on.
 108 Whether this happens is device-dependent.
 109 .SS "Mouse Events"
 110 Here are the mouse event type masks which may be defined:
 111 .PP
 112 .TS
 113 lB lB
 114 lB l .
 115 Name    Description
 116 _
 117 BUTTON1_PRESSED mouse button 1 down
 118 BUTTON1_RELEASED        mouse button 1 up
 119 BUTTON1_CLICKED mouse button 1 clicked
 120 BUTTON1_DOUBLE_CLICKED  mouse button 1 double clicked
 121 BUTTON1_TRIPLE_CLICKED  mouse button 1 triple clicked
 122 _
 123 BUTTON2_PRESSED mouse button 2 down
 124 BUTTON2_RELEASED        mouse button 2 up
 125 BUTTON2_CLICKED mouse button 2 clicked
 126 BUTTON2_DOUBLE_CLICKED  mouse button 2 double clicked
 127 BUTTON2_TRIPLE_CLICKED  mouse button 2 triple clicked
 128 _
 129 BUTTON3_PRESSED mouse button 3 down
 130 BUTTON3_RELEASED        mouse button 3 up
 131 BUTTON3_CLICKED mouse button 3 clicked
 132 BUTTON3_DOUBLE_CLICKED  mouse button 3 double clicked
 133 BUTTON3_TRIPLE_CLICKED  mouse button 3 triple clicked
 134 _
 135 BUTTON4_PRESSED mouse button 4 down
 136 BUTTON4_RELEASED        mouse button 4 up
 137 BUTTON4_CLICKED mouse button 4 clicked
 138 BUTTON4_DOUBLE_CLICKED  mouse button 4 double clicked
 139 BUTTON4_TRIPLE_CLICKED  mouse button 4 triple clicked
 140 _
 141 BUTTON5_PRESSED mouse button 5 down
 142 BUTTON5_RELEASED        mouse button 5 up
 143 BUTTON5_CLICKED mouse button 5 clicked
 144 BUTTON5_DOUBLE_CLICKED  mouse button 5 double clicked
 145 BUTTON5_TRIPLE_CLICKED  mouse button 5 triple clicked
 146 _
 147 BUTTON_SHIFT    shift was down during button state change
 148 BUTTON_CTRL     control was down during button state change
 149 BUTTON_ALT      alt was down during button state change
 150 ALL_MOUSE_EVENTS        report all button state changes
 151 REPORT_MOUSE_POSITION   report mouse movement
 152 _
 153 .TE
 154 .SS getmouse
 155 Once a class of mouse events has been made visible in a window,
 156 calling the \fB\%wgetch\fP function on that window may return
 157 \fB\%KEY_MOUSE\fP as an indicator that a mouse event has been queued.
 158 To read the event data and pop the event off the queue, call
 159 \fB\%getmouse\fP.
 160 This function will return \fBOK\fP if a mouse event
 161 is actually visible in the given window, \fBERR\fP otherwise.
 162 When \fB\%getmouse\fP returns \fBOK\fP, the data deposited as y and
 163 x in the event structure coordinates will be screen-relative character-cell
 164 coordinates.
 165 The returned state mask will have exactly one bit set to
 166 indicate the event type.
 167 The corresponding data in the queue is marked invalid.
 168 A subsequent call to \fB\%getmouse\fP will retrieve the next older
 169 item from the queue.
 170 .SS ungetmouse
 171 The \fB\%ungetmouse\fP function behaves analogously to \fB\%ungetch\fP.
 172 It pushes
 173 a \fB\%KEY_MOUSE\fP event onto the input queue, and associates with that event
 174 the given state data and screen-relative character-cell coordinates.
 175 .SS wenclose
 176 The \fB\%wenclose\fP function tests whether a given pair of screen-relative
 177 character-cell coordinates is enclosed by a given window, returning \fBTRUE\fP
 178 if it is and \fBFALSE\fP otherwise.
 179 It is useful for determining what subset of
 180 the screen windows enclose the location of a mouse event.
 181 .SS wmouse_trafo
 182 The \fB\%wmouse_trafo\fP function transforms a given pair of coordinates
 183 from \fB\%stdscr\fP-relative coordinates
 184 to coordinates relative to the given window or vice versa.
 185 The resulting \fB\%stdscr\fP-relative coordinates are not always
 186 identical to window-relative coordinates due to the mechanism to reserve
 187 lines on top or bottom of the screen for other purposes
 188 (see the \fB\%ripoffline\fP and \fB\%slk_init\fP(3X) calls, for example).
 189 .bP
 190 If the parameter \fIto_screen\fP is \fBTRUE\fP, the pointers
 191 \fIpY, pX\fP must reference the coordinates of a location
 192 inside the window \fIwin\fP.
 193 They are converted to window-relative coordinates and returned
 194 through the pointers.
 195 If the conversion was successful, the function returns \fBTRUE\fP.
 196 .bP
 197 If one of the parameters was \fBNULL\fP or the location is
 198 not inside the window, \fBFALSE\fP is returned.
 199 .bP
 200 If \fIto_screen\fP is
 201 \fBFALSE\fP, the pointers \fIpY, pX\fP must reference window-relative
 202 coordinates.
 203 They are converted to \fB\%stdscr\fP-relative coordinates if the
 204 window \fIwin\fP encloses this point.
 205 In this case the function returns \fBTRUE\fP.
 206 .bP
 207 If one of the parameters is \fBNULL\fP or the point is not inside the
 208 window, \fBFALSE\fP is returned.
 209 The referenced coordinates
 210 are only replaced by the converted coordinates if the transformation was
 211 successful.
 212 .SS mouse_trafo
 213 The \fB\%mouse_trafo\fP function performs the same translation
 214 as \fB\%wmouse_trafo\fP,
 215 using \fB\%stdscr\fP for \fIwin\fP.
 216 .SS mouseinterval
 217 The \fB\%mouseinterval\fP function sets the maximum time (in thousands of a
 218 second) that can elapse between press and release events for them to
 219 be recognized as a click.
 220 Use \fB\%mouseinterval(0)\fP to disable click resolution.
 221 This function returns the previous interval value.
 222 Use \fB\%mouseinterval(\-1)\fP to obtain the interval without altering it.
 223 The default is one sixth of a second.
 224 .SS has_mouse
 225 The \fB\%has_mouse\fP function returns \fBTRUE\fP if the mouse driver
 226 has been successfully initialized,
 227 and \fBFALSE\fP otherwise.
 228 .PP
 229 Note that mouse events will be ignored when input is in cooked mode, and will
 230 cause an error beep when cooked mode is being simulated in a window by a
 231 function such as \fB\%getstr\fP that expects a linefeed for input-loop
 232 termination.
 233 .SH RETURN VALUE
 234 \fB\%has_mouse\fP,
 235 \fB\%wenclose\fP,
 236 \fB\%mouse_trafo\fP,
 237 and
 238 \fB\%wmouse_trafo\fP
 239 return \fBTRUE\fP or \fBFALSE\fP as noted above.
 240 .PP
 241 \fB\%getmouse\fP and \fB\%ungetmouse\fP
 242 return \fBERR\fP upon failure and \fBOK\fP upon success.
 243 .PP
 244 \fB\%getmouse\fP fails if:
 245 .bP
 246 no mouse driver was initialized,
 247 .bP
 248 the mask of reportable events is zero,
 249 .bP
 250 a mouse event was detected that does not match the mask,
 251 .bP
 252 or if no more events remain in the queue.
 253 .PP
 254 \fB\%ungetmouse\fP returns an error if the event queue is full.
 255 .PP
 256 \fB\%mousemask\fP
 257 returns the mask of reportable events.
 258 .PP
 259 \fB\%mouseinterval\fP
 260 returns the previous interval value, unless
 261 the terminal was not initialized.
 262 In that case, it returns the maximum interval value (166).
 263 .SH NOTES
 264 The order of the \fB\%MEVENT\fP structure members is not guaranteed.
 265 Additional fields may be added to the structure in the future.
 266 .PP
 267 Under
 268 .I \%ncurses,
 269 these calls are implemented using either
 270 .IR \%xterm 's
 271 built-in mouse-tracking API or
 272 platform-specific drivers including
 273 .RS 3
 274 .bP
 275 Alessandro Rubini's gpm server
 276 .bP
 277 FreeBSD sysmouse
 278 .bP
 279 OS/2 EMX
 280 .RE
 281 .PP
 282 If you are using an unsupported configuration,
 283 mouse events will not be visible to
 284 \fI\%ncurses\fP (and the \fB\%mousemask\fP function will always
 285 return \fB0\fP).
 286 .PP
 287 If the
 288 .I \%term\%info
 289 entry contains a \fBXM\fP string,
 290 this is used in the
 291 .I \%xterm
 292 mouse driver to control the
 293 way the terminal is initialized for mouse operation.
 294 The default, if \fBXM\fP is not found,
 295 corresponds to private mode 1000 of
 296 .I \%xterm:
 297 .PP
 298 .RS 3
 299 \eE[?1000%?%p1%{1}%=%th%el%;
 300 .RE
 301 .PP
 302 The mouse driver also recognizes a newer
 303 .I \%xterm
 304 private mode 1006,
 305 e.g.,
 306 .PP
 307 .RS 3
 308 \eE[?1006;1000%?%p1%{1}%=%th%el%;
 309 .RE
 310 .PP
 311 The \fIz\fP member in the event structure is not presently used.
 312 It is intended
 313 for use with touch screens (which may be pressure-sensitive) or with
 314 3D-mice/trackballs/power gloves.
 315 .PP
 316 The \fB\%ALL_MOUSE_EVENTS\fP class does not
 317 include \fB\%REPORT_MOUSE_POSITION\fP.
 318 They are distinct.
 319 For example,
 320 in
 321 .I \%xterm,
 322 wheel/scrolling mice send position reports as a sequence of
 323 presses of buttons 4 or 5 without matching button-releases.
 324 .SH EXTENSIONS
 325 These functions were designed for
 326 \fB\%ncurses\fP(3X),
 327 and are not found in SVr4
 328 .IR curses ,
 329 4.4BSD
 330 .IR curses ,
 331 or any other previous curses implementation.
 332 (SVr4
 333 .I curses
 334 did have a
 335 .I \%getmouse
 336 function,
 337 which took no argument and returned a different type.)
 338 .SH PORTABILITY
 339 Applications employing the
 340 .I \%ncurses
 341 mouse extension should condition its use on the visibility of the
 342 .B \%NCURSES_MOUSE_VERSION
 343 preprocessor macro.
 344 When the interface changes,
 345 the macro's value increments.
 346 Multiple versions are available when
 347 .I \%ncurses
 348 is configured;
 349 see section \*(``ALTERNATE CONFIGURATIONS\*('' of \fB\%ncurses\fP(3X).
 350 The following values may be specified.
 351 .RS 3
 352 .TP 3
 353 1
 354 has definitions for reserved events.
 355 The mask uses 28 bits.
 356 .TP 3
 357 2
 358 adds definitions for button 5,
 359 removes the definitions for reserved events.
 360 The mask uses 29 bits.
 361 .RE
 362 .PP
 363 SVr4
 364 .I curses
 365 had support for the mouse in a variant of \fI\%xterm\fP(1).
 366 It is mentioned in a few places,
 367 with little supporting documentation.
 368 .bP
 369 Its \*(``libcurses\*('' manual page lists functions for this feature
 370 prototyped in \fI\%curses.h\fP.
 371 .PP
 372 .RS 8
 373 .EX
 374 extern int mouse_set(long int);
 375 extern int mouse_on(long int);
 376 extern int mouse_off(long int);
 377 extern int request_mouse_pos(void);
 378 extern int map_button(unsigned long);
 379 extern void wmouse_position(WINDOW *, int *, int *);
 380 extern unsigned long getmouse(void), getbmap(void);
 381 .EE
 382 .RE
 383 .bP
 384 Its \*(``terminfo\*('' manual page lists capabilities for the feature.
 385 .PP
 386 .RS 8
 387 .EX
 388 buttons           btns    BT       Number of buttons on the mouse
 389 get_mouse         getm    Gm       Curses should get button events
 390 key_mouse         kmous   Km       0631, Mouse event has occurred
 391 mouse_info        minfo   Mi       Mouse status information
 392 req_mouse_pos     reqmp   RQ       Request mouse position report
 393 .EE
 394 .RE
 395 .bP
 396 The interface made assumptions
 397 (as does
 398 .IR \%ncurses )
 399 about the escape sequences sent to and received from the terminal.
 400 .IP
 401 For instance,
 402 the SVr4
 403 .I curses
 404 library used the \fB\%get_mouse\fP capability to tell the terminal which
 405 mouse button events it should send,
 406 passing the mouse-button bit mask to the terminal.
 407 Also, it could ask the terminal
 408 where the mouse was using the \fB\%req_mouse_pos\fP capability.
 409 .IP
 410 Those features required a terminal program that had been modified
 411 to work with SVr4
 412 .I curses.
 413 They were not part of the X Consortium's
 414 .I \%xterm.
 415 .PP
 416 When developing the
 417 .I \%xterm
 418 mouse support for
 419 .I \%ncurses
 420 in September 1995,
 421 Eric Raymond was uninterested in using the same interface due to its
 422 lack of documentation.
 423 Later, in 1998, Mark Hesseling provided support in
 424 .I \%PDCurses
 425 2.3 using the SVr4 interface.
 426 .I \%PDCurses,
 427 however,
 428 does not use video terminals,
 429 making it unnecessary to be concerned about compatibility with the
 430 escape sequences.
 431 .SH BUGS
 432 Mouse events from
 433 .I \%xterm
 434 are
 435 .I not
 436 ignored in cooked mode if they have been enabled by \fB\%mousemask\fP.
 437 Instead,
 438 the
 439 .I \%xterm
 440 mouse report sequence appears in the string read.
 441 .PP
 442 Mouse event reports from
 443 .I \%xterm
 444 are not detected correctly in a window with keypad application mode
 445 disabled,
 446 since they are interpreted as a variety of function key.
 447 Set the terminal's
 448 .I \%term\%info
 449 capability \fB\%kmous\fP to \*(``\eE[M\*(''
 450 (the beginning of the response from
 451 .I \%xterm
 452 for mouse clicks).
 453 Other values of \fB\%kmous\fP are permitted under the same assumption,
 454 that is,
 455 the report begins with that sequence.
 456 .PP
 457 Because there are no standard response sequences that serve to identify
 458 terminals supporting the
 459 .I \%xterm
 460 mouse protocol,
 461 .I \%ncurses
 462 assumes that if \fB\%kmous\fP is defined in the terminal description,
 463 or if the terminal type's primary name or aliases contain the string
 464 \%\*(``xterm\*('',
 465 then the terminal may send mouse events.
 466 The \fB\%kmous\fP capability is checked first,
 467 allowing use of newer
 468 .I \%xterm
 469 mouse protocols,
 470 such as its private mode 1006.
 471 .SH SEE ALSO
 472 \fB\%curses\fP(3X),
 473 \fB\%curs_inopts\fP(3X),
 474 \fB\%curs_kernel\fP(3X),
 475 \fB\%curs_slk\fP(3X),
 476 \fB\%curs_variables\fP(3X)