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