docs/latex/wx/mouseevt.tex

   1 \section{\class{wxMouseEvent}}\label{wxmouseevent}
   2
   3 This event class contains information about the events generated by the mouse:
   4 they include mouse buttons press and release events and mouse move events.
   5
   6 All mouse events involving the buttons use {\tt wxMOUSE\_BTN\_LEFT} for the
   7 left mouse button, {\tt wxMOUSE\_BTN\_MIDDLE} for the middle one and
   8 {\tt wxMOUSE\_BTN\_RIGHT} for the right one. Note that not all mice have a
   9 middle button so a portable application should avoid relying on the events from
  10 it.
  11
  12 {\bf NB:} Note that under Windows mouse enter and leave events are not natively supported
  13 by the system but are generated by wxWidgets itself. This has several
  14 drawbacks: the LEAVE\_WINDOW event might be received some time after the mouse
  15 left the window and the state variables for it may have changed during this
  16 time.
  17
  18 {\bf NB:} Note the difference between methods like
  19 \helpref{LeftDown}{wxmouseeventleftdown} and
  20 \helpref{LeftIsDown}{wxmouseeventleftisdown}: the former returns {\tt true}
  21 when the event corresponds to the left mouse button click while the latter
  22 returns {\tt true} if the left mouse button is currently being pressed. For
  23 example, when the user is dragging the mouse you can use
  24 \helpref{LeftIsDown}{wxmouseeventleftisdown} to test
  25 whether the left mouse button is (still) depressed. Also, by convention, if
  26 \helpref{LeftDown}{wxmouseeventleftdown} returns {\tt true},
  27 \helpref{LeftIsDown}{wxmouseeventleftisdown} will also return {\tt true} in
  28 wxWidgets whatever the underlying GUI behaviour is (which is
  29 platform-dependent). The same applies, of course, to other mouse buttons as
  30 well.
  31
  32 \wxheading{Derived from}
  33
  34 \helpref{wxEvent}{wxevent}
  35
  36 \wxheading{Include files}
  37
  38 <wx/event.h>
  39
  40 \wxheading{Event table macros}
  41
  42 To process a mouse event, use these event handler macros to direct input to member
  43 functions that take a wxMouseEvent argument.
  44
  45 \twocolwidtha{7cm}
  46 \begin{twocollist}\itemsep=0pt
  47 \twocolitem{{\bf EVT\_LEFT\_DOWN(func)}}{Process a wxEVT\_LEFT\_DOWN event.}
  48 \twocolitem{{\bf EVT\_LEFT\_UP(func)}}{Process a wxEVT\_LEFT\_UP event.}
  49 \twocolitem{{\bf EVT\_LEFT\_DCLICK(func)}}{Process a wxEVT\_LEFT\_DCLICK event.}
  50 \twocolitem{{\bf EVT\_MIDDLE\_DOWN(func)}}{Process a wxEVT\_MIDDLE\_DOWN event.}
  51 \twocolitem{{\bf EVT\_MIDDLE\_UP(func)}}{Process a wxEVT\_MIDDLE\_UP event.}
  52 \twocolitem{{\bf EVT\_MIDDLE\_DCLICK(func)}}{Process a wxEVT\_MIDDLE\_DCLICK event.}
  53 \twocolitem{{\bf EVT\_RIGHT\_DOWN(func)}}{Process a wxEVT\_RIGHT\_DOWN event.}
  54 \twocolitem{{\bf EVT\_RIGHT\_UP(func)}}{Process a wxEVT\_RIGHT\_UP event.}
  55 \twocolitem{{\bf EVT\_RIGHT\_DCLICK(func)}}{Process a wxEVT\_RIGHT\_DCLICK event.}
  56 \twocolitem{{\bf EVT\_MOTION(func)}}{Process a wxEVT\_MOTION event.}
  57 \twocolitem{{\bf EVT\_ENTER\_WINDOW(func)}}{Process a wxEVT\_ENTER\_WINDOW event.}
  58 \twocolitem{{\bf EVT\_LEAVE\_WINDOW(func)}}{Process a wxEVT\_LEAVE\_WINDOW event.}
  59 \twocolitem{{\bf EVT\_MOUSEWHEEL(func)}}{Process a wxEVT\_MOUSEWHEEL event.}
  60 \twocolitem{{\bf EVT\_MOUSE\_EVENTS(func)}}{Process all mouse events.}
  61 \end{twocollist}%
  62
  63 \latexignore{\rtfignore{\wxheading{Members}}}
  64
  65
  66 \membersection{wxMouseEvent::m\_altDown}
  67
  68 \member{bool}{m\_altDown}
  69
  70 true if the Alt key is pressed down.
  71
  72
  73 \membersection{wxMouseEvent::m\_controlDown}
  74
  75 \member{bool}{m\_controlDown}
  76
  77 true if control key is pressed down.
  78
  79
  80 \membersection{wxMouseEvent::m\_leftDown}
  81
  82 \member{bool}{m\_leftDown}
  83
  84 true if the left mouse button is currently pressed down.
  85
  86
  87 \membersection{wxMouseEvent::m\_middleDown}
  88
  89 \member{bool}{m\_middleDown}
  90
  91 true if the middle mouse button is currently pressed down.
  92
  93
  94 \membersection{wxMouseEvent::m\_rightDown}
  95
  96 \member{bool}{m\_rightDown}
  97
  98 true if the right mouse button is currently pressed down.
  99
 100
 101 \membersection{wxMouseEvent::m\_metaDown}
 102
 103 \member{bool}{m\_metaDown}
 104
 105 true if the Meta key is pressed down.
 106
 107
 108 \membersection{wxMouseEvent::m\_shiftDown}
 109
 110 \member{bool}{m\_shiftDown}
 111
 112 true if shift is pressed down.
 113
 114
 115 \membersection{wxMouseEvent::m\_x}
 116
 117 \member{long}{m\_x}
 118
 119 X-coordinate of the event.
 120
 121
 122 \membersection{wxMouseEvent::m\_y}
 123
 124 \member{long}{m\_y}
 125
 126 Y-coordinate of the event.
 127
 128
 129 \membersection{wxMouseEvent::m\_wheelRotation}
 130
 131 \member{int}{m\_wheelRotation}
 132
 133 The distance the mouse wheel is rotated.
 134
 135
 136 \membersection{wxMouseEvent::m\_wheelDelta}
 137
 138 \member{int}{m\_wheelDelta}
 139
 140 The wheel delta, normally $120$.
 141
 142
 143 \membersection{wxMouseEvent::m\_linesPerAction}
 144
 145 \member{int}{m\_linesPerAction}
 146
 147 The configured number of lines (or whatever) to be scrolled per wheel
 148 action.
 149
 150
 151
 152 \membersection{wxMouseEvent::wxMouseEvent}
 153
 154 \func{}{wxMouseEvent}{\param{WXTYPE}{ mouseEventType = 0}, \param{int}{ id = 0}}
 155
 156 Constructor. Valid event types are:
 157
 158 \begin{itemize}
 159 \itemsep=0pt
 160 \item {\bf wxEVT\_ENTER\_WINDOW}
 161 \item {\bf wxEVT\_LEAVE\_WINDOW}
 162 \item {\bf wxEVT\_LEFT\_DOWN}
 163 \item {\bf wxEVT\_LEFT\_UP}
 164 \item {\bf wxEVT\_LEFT\_DCLICK}
 165 \item {\bf wxEVT\_MIDDLE\_DOWN}
 166 \item {\bf wxEVT\_MIDDLE\_UP}
 167 \item {\bf wxEVT\_MIDDLE\_DCLICK}
 168 \item {\bf wxEVT\_RIGHT\_DOWN}
 169 \item {\bf wxEVT\_RIGHT\_UP}
 170 \item {\bf wxEVT\_RIGHT\_DCLICK}
 171 \item {\bf wxEVT\_MOTION}
 172 \item {\bf wxEVT\_MOUSEWHEEL}
 173 \end{itemize}
 174
 175
 176 \membersection{wxMouseEvent::AltDown}
 177
 178 \func{bool}{AltDown}{\void}
 179
 180 Returns true if the Alt key was down at the time of the event.
 181
 182
 183 \membersection{wxMouseEvent::Button}\label{wxmouseeventbutton}
 184
 185 \func{bool}{Button}{\param{int}{ button}}
 186
 187 Returns true if the identified mouse button is changing state. Valid
 188 values of {\it button} are:
 189
 190 \begin{twocollist}\itemsep=0pt
 191 \twocolitem{{\tt wxMOUSE\_BTN\_LEFT}}{check if left button was pressed}
 192 \twocolitem{{\tt wxMOUSE\_BTN\_MIDDLE}}{check if left button was pressed}
 193 \twocolitem{{\tt wxMOUSE\_BTN\_RIGHT}}{check if left button was pressed}
 194 \twocolitem{{\tt wxMOUSE\_BTN\_ANY}}{check if any button was pressed}
 195 \end{twocollist}
 196
 197
 198 \membersection{wxMouseEvent::ButtonDClick}
 199
 200 \func{bool}{ButtonDClick}{\param{int}{ but = wxMOUSE\_BTN\_ANY}}
 201
 202 If the argument is omitted, this returns true if the event was a mouse
 203 double click event. Otherwise the argument specifies which double click event
 204 was generated (see \helpref{Button}{wxmouseeventbutton} for the possible
 205 values).
 206
 207
 208 \membersection{wxMouseEvent::ButtonDown}
 209
 210 \func{bool}{ButtonDown}{\param{int}{ but = -1}}
 211
 212 If the argument is omitted, this returns true if the event was a mouse
 213 button down event. Otherwise the argument specifies which button-down event
 214 was generated (see \helpref{Button}{wxmouseeventbutton} for the possible
 215 values).
 216
 217
 218
 219 \membersection{wxMouseEvent::ButtonUp}
 220
 221 \func{bool}{ButtonUp}{\param{int}{ but = -1}}
 222
 223 If the argument is omitted, this returns true if the event was a mouse
 224 button up event. Otherwise the argument specifies which button-up event
 225 was generated (see \helpref{Button}{wxmouseeventbutton} for the possible
 226 values).
 227
 228
 229
 230 \membersection{wxKeyEvent::CmdDown}\label{wxmouseeventcmddown}
 231
 232 \constfunc{bool}{CmdDown}{\void}
 233
 234 Same as \helpref{MetaDown}{wxmouseeventmetadown} under Mac, same as
 235 \helpref{ControlDown}{wxmouseeventcontroldown} elsewhere.
 236
 237 \wxheading{See also}
 238
 239 \helpref{wxKeyEvent::CmdDown}{wxkeyeventcmddown}
 240
 241
 242 \membersection{wxMouseEvent::ControlDown}\label{wxmouseeventcontroldown}
 243
 244 \func{bool}{ControlDown}{\void}
 245
 246 Returns true if the control key was down at the time of the event.
 247
 248
 249 \membersection{wxMouseEvent::Dragging}\label{wxmouseeventdragging}
 250
 251 \func{bool}{Dragging}{\void}
 252
 253 Returns true if this was a dragging event (motion while a button is depressed).
 254
 255 \wxheading{See also}
 256
 257 \helpref{Moving}{wxmouseeventmoving}
 258
 259
 260 \membersection{wxMouseEvent::Entering}\label{wxmouseevententering}
 261
 262 \func{bool}{Entering}{\void}
 263
 264 Returns true if the mouse was entering the window.
 265
 266 See also \helpref{wxMouseEvent::Leaving}{wxmouseeventleaving}.
 267
 268
 269 \membersection{wxMouseEvent::GetButton}\label{wxmouseeventgetbutton}
 270
 271 \constfunc{int}{GetButton}{\void}
 272
 273 Returns the mouse button which generated this event or {\tt wxMOUSE\_BTN\_NONE}
 274 if no button is involved (for mouse move, enter or leave event, for example).
 275 Otherwise {\tt wxMOUSE\_BTN\_LEFT} is returned for the left button down, up and
 276 double click events, {\tt wxMOUSE\_BTN\_MIDDLE} and {\tt wxMOUSE\_BTN\_RIGHT}
 277 for the same events for the middle and the right buttons respectively.
 278
 279
 280 \membersection{wxMouseEvent::GetPosition}\label{wxmouseeventgetposition}
 281
 282 \constfunc{wxPoint}{GetPosition}{\void}
 283
 284 \constfunc{void}{GetPosition}{\param{wxCoord*}{ x}, \param{wxCoord*}{ y}}
 285
 286 \constfunc{void}{GetPosition}{\param{long*}{ x}, \param{long*}{ y}}
 287
 288 Sets *x and *y to the position at which the event occurred.
 289
 290 Returns the physical mouse position in pixels.
 291
 292
 293 \membersection{wxMouseEvent::GetLogicalPosition}\label{wxmouseeventgetlogicalposition}
 294
 295 \constfunc{wxPoint}{GetLogicalPosition}{\param{const wxDC\&}{ dc}}
 296
 297 Returns the logical mouse position in pixels (i.e. translated according to the
 298 translation set for the DC, which usually indicates that the window has been scrolled).
 299
 300
 301
 302 \membersection{wxMouseEvent::GetLinesPerAction}\label{wxmouseeventgetlinesperaction}
 303
 304 \constfunc{int}{GetLinesPerAction}{\void}
 305
 306 Returns the configured number of lines (or whatever) to be scrolled per
 307 wheel action.  Defaults to three.
 308
 309
 310 \membersection{wxMouseEvent::GetWheelRotation}\label{wxmouseeventgetwheelrotation}
 311
 312 \constfunc{int}{GetWheelRotation}{\void}
 313
 314 Get wheel rotation, positive or negative indicates direction of
 315 rotation.  Current devices all send an event when rotation is equal to
 316 +/-WheelDelta, but this allows for finer resolution devices to be
 317 created in the future.  Because of this you shouldn't assume that one
 318 event is equal to 1 line or whatever, but you should be able to either
 319 do partial line scrolling or wait until +/-WheelDelta rotation values
 320 have been accumulated before scrolling.
 321
 322
 323 \membersection{wxMouseEvent::GetWheelDelta}\label{wxmouseeventgetwheeldelta}
 324
 325 \constfunc{int}{GetWheelDelta}{\void}
 326
 327 Get wheel delta, normally $120$.  This is the threshold for action to be
 328 taken, and one such action (for example, scrolling one increment)
 329 should occur for each delta.
 330
 331
 332 \membersection{wxMouseEvent::GetX}\label{wxmouseeventgetx}
 333
 334 \constfunc{long}{GetX}{\void}
 335
 336 Returns X coordinate of the physical mouse event position.
 337
 338
 339 \membersection{wxMouseEvent::GetY}\label{wxmouseeventgety}
 340
 341 \func{long}{GetY}{\void}
 342
 343 Returns Y coordinate of the physical mouse event position.
 344
 345
 346 \membersection{wxMouseEvent::IsButton}
 347
 348 \constfunc{bool}{IsButton}{\void}
 349
 350 Returns true if the event was a mouse button event (not necessarily a button down event -
 351 that may be tested using {\it ButtonDown}).
 352
 353
 354 \membersection{wxMouseEvent::IsPageScroll}
 355
 356 \constfunc{bool}{IsPageScroll}{\void}
 357
 358 Returns true if the system has been setup to do page scrolling with
 359 the mouse wheel instead of line scrolling.
 360
 361
 362 \membersection{wxMouseEvent::Leaving}\label{wxmouseeventleaving}
 363
 364 \constfunc{bool}{Leaving}{\void}
 365
 366 Returns true if the mouse was leaving the window.
 367
 368 See also \helpref{wxMouseEvent::Entering}{wxmouseevententering}.
 369
 370
 371 \membersection{wxMouseEvent::LeftDClick}
 372
 373 \constfunc{bool}{LeftDClick}{\void}
 374
 375 Returns true if the event was a left double click.
 376
 377
 378 \membersection{wxMouseEvent::LeftDown}\label{wxmouseeventleftdown}
 379
 380 \constfunc{bool}{LeftDown}{\void}
 381
 382 Returns true if the left mouse button changed to down.
 383
 384
 385 \membersection{wxMouseEvent::LeftIsDown}\label{wxmouseeventleftisdown}
 386
 387 \constfunc{bool}{LeftIsDown}{\void}
 388
 389 Returns true if the left mouse button is currently down, independent
 390 of the current event type.
 391
 392 Please notice that it is {\bf not} the same as
 393 \helpref{LeftDown}{wxmouseeventleftdown} which returns true if the left mouse
 394 button was just pressed. Rather, it describes the state of the mouse button
 395 before the event happened.
 396
 397 This event is usually used in the mouse event handlers which process "move
 398 mouse" messages to determine whether the user is (still) dragging the mouse.
 399
 400
 401 \membersection{wxMouseEvent::LeftUp}
 402
 403 \constfunc{bool}{LeftUp}{\void}
 404
 405 Returns true if the left mouse button changed to up.
 406
 407
 408 \membersection{wxMouseEvent::MetaDown}\label{wxmouseeventmetadown}
 409
 410 \constfunc{bool}{MetaDown}{\void}
 411
 412 Returns true if the Meta key was down at the time of the event.
 413
 414
 415 \membersection{wxMouseEvent::MiddleDClick}
 416
 417 \constfunc{bool}{MiddleDClick}{\void}
 418
 419 Returns true if the event was a middle double click.
 420
 421
 422 \membersection{wxMouseEvent::MiddleDown}
 423
 424 \constfunc{bool}{MiddleDown}{\void}
 425
 426 Returns true if the middle mouse button changed to down.
 427
 428
 429 \membersection{wxMouseEvent::MiddleIsDown}\label{wxmouseeventmiddleisdown}
 430
 431 \constfunc{bool}{MiddleIsDown}{\void}
 432
 433 Returns true if the middle mouse button is currently down, independent
 434 of the current event type.
 435
 436
 437 \membersection{wxMouseEvent::MiddleUp}
 438
 439 \constfunc{bool}{MiddleUp}{\void}
 440
 441 Returns true if the middle mouse button changed to up.
 442
 443
 444 \membersection{wxMouseEvent::Moving}\label{wxmouseeventmoving}
 445
 446 \constfunc{bool}{Moving}{\void}
 447
 448 Returns true if this was a motion event and no mouse buttons were pressed.
 449 If any mouse button is held pressed, then this method returns \false and
 450 \helpref{Dragging}{wxmouseeventdragging} returns \true.
 451
 452
 453 \membersection{wxMouseEvent::RightDClick}
 454
 455 \constfunc{bool}{RightDClick}{\void}
 456
 457 Returns true if the event was a right double click.
 458
 459
 460 \membersection{wxMouseEvent::RightDown}
 461
 462 \constfunc{bool}{RightDown}{\void}
 463
 464 Returns true if the right mouse button changed to down.
 465
 466
 467 \membersection{wxMouseEvent::RightIsDown}\label{wxmouseeventrightisdown}
 468
 469 \constfunc{bool}{RightIsDown}{\void}
 470
 471 Returns true if the right mouse button is currently down, independent
 472 of the current event type.
 473
 474
 475 \membersection{wxMouseEvent::RightUp}
 476
 477 \constfunc{bool}{RightUp}{\void}
 478
 479 Returns true if the right mouse button changed to up.
 480
 481
 482 \membersection{wxMouseEvent::ShiftDown}
 483
 484 \constfunc{bool}{ShiftDown}{\void}
 485
 486 Returns true if the shift key was down at the time of the event.
 487