## wxMouseEvent

This event class contains information about the events generated by the mouse: they include mouse buttons press and release events and mouse move events.

All mouse events involving the buttons use `wxMOUSE_BTN_LEFT` for the left mouse button, `wxMOUSE_BTN_MIDDLE` for the middle one and `wxMOUSE_BTN_RIGHT` for the right one. Note that not all mice have a middle button so a portable application should avoid relying on the events from it.

NB: Note that under Windows CE mouse enter and leave events are not natively supported by the system but are generated by wxWidgets itself. This has several drawbacks: the LEAVE_WINDOW event might be received some time after the mouse left the window and the state variables for it may have changed during this time.

NB: Note the difference between methods like LeftDown and LeftIsDown: the former returns `true` when the event corresponds to the left mouse button click while the latter returns `true` if the left mouse button is currently being pressed. For example, when the user is dragging the mouse you can use LeftIsDown to test whether the left mouse button is (still) depressed. Also, by convention, if LeftDown returns `true`, LeftIsDown will also return `true` in wxWidgets whatever the underlying GUI behaviour is (which is platform-dependent). The same applies, of course, to other mouse buttons as well.

Derived from

wxEvent

Include files

<wx/event.h>

Event table macros

To process a mouse event, use these event handler macros to direct input to member functions that take a wxMouseEvent argument.

EVT_LEFT_DOWN(func) | Process a wxEVT_LEFT_DOWN event. The handler of this event should normally call event.Skip() to allow the default processing to take place as otherwise the window under mouse wouldn't get the focus.
EVT_LEFT_UP(func) | Process a wxEVT_LEFT_UP event.
EVT_LEFT_DCLICK(func) | Process a wxEVT_LEFT_DCLICK event.
EVT_MIDDLE_DOWN(func) | Process a wxEVT_MIDDLE_DOWN event.
EVT_MIDDLE_UP(func) | Process a wxEVT_MIDDLE_UP event.
EVT_MIDDLE_DCLICK(func) | Process a wxEVT_MIDDLE_DCLICK event.
EVT_RIGHT_DOWN(func) | Process a wxEVT_RIGHT_DOWN event.
EVT_RIGHT_UP(func) | Process a wxEVT_RIGHT_UP event.
EVT_RIGHT_DCLICK(func) | Process a wxEVT_RIGHT_DCLICK event.
EVT_MOTION(func) | Process a wxEVT_MOTION event.
EVT_ENTER_WINDOW(func) | Process a wxEVT_ENTER_WINDOW event.
EVT_LEAVE_WINDOW(func) | Process a wxEVT_LEAVE_WINDOW event.
EVT_MOUSEWHEEL(func) | Process a wxEVT_MOUSEWHEEL event.
EVT_MOUSE_EVENTS(func) | Process all mouse events.

Members

wxMouseEvent::m_altDown
wxMouseEvent::m_controlDown
wxMouseEvent::m_leftDown
wxMouseEvent::m_middleDown
wxMouseEvent::m_rightDown
wxMouseEvent::m_metaDown
wxMouseEvent::m_shiftDown
wxMouseEvent::m_x
wxMouseEvent::m_y
wxMouseEvent::m_wheelRotation
wxMouseEvent::m_wheelDelta
wxMouseEvent::m_linesPerAction
wxMouseEvent::wxMouseEvent
wxMouseEvent::AltDown
wxMouseEvent::Button
wxMouseEvent::ButtonDClick
wxMouseEvent::ButtonDown
wxMouseEvent::ButtonUp
wxMouseEvent::CmdDown
wxMouseEvent::ControlDown
wxMouseEvent::Dragging
wxMouseEvent::Entering
wxMouseEvent::GetButton
wxMouseEvent::GetPosition
wxMouseEvent::GetLogicalPosition
wxMouseEvent::GetLinesPerAction
wxMouseEvent::GetWheelRotation
wxMouseEvent::GetWheelDelta
wxMouseEvent::GetX
wxMouseEvent::GetY
wxMouseEvent::IsButton
wxMouseEvent::IsPageScroll
wxMouseEvent::Leaving
wxMouseEvent::LeftDClick
wxMouseEvent::LeftDown
wxMouseEvent::LeftIsDown
wxMouseEvent::LeftUp
wxMouseEvent::MetaDown
wxMouseEvent::MiddleDClick
wxMouseEvent::MiddleDown
wxMouseEvent::MiddleIsDown
wxMouseEvent::MiddleUp
wxMouseEvent::Moving
wxMouseEvent::RightDClick
wxMouseEvent::RightDown
wxMouseEvent::RightIsDown
wxMouseEvent::RightUp
wxMouseEvent::ShiftDown

### wxMouseEvent::m_altDown

bool m_altDown

true if the Alt key is pressed down.

### wxMouseEvent::m_controlDown

bool m_controlDown

true if control key is pressed down.

### wxMouseEvent::m_leftDown

bool m_leftDown

true if the left mouse button is currently pressed down.

### wxMouseEvent::m_middleDown

bool m_middleDown

true if the middle mouse button is currently pressed down.

### wxMouseEvent::m_rightDown

bool m_rightDown

true if the right mouse button is currently pressed down.

### wxMouseEvent::m_metaDown

bool m_metaDown

true if the Meta key is pressed down.

### wxMouseEvent::m_shiftDown

bool m_shiftDown

true if shift is pressed down.

### wxMouseEvent::m_x

long m_x

X-coordinate of the event.

### wxMouseEvent::m_y

long m_y

Y-coordinate of the event.

### wxMouseEvent::m_wheelRotation

int m_wheelRotation

The distance the mouse wheel is rotated.

### wxMouseEvent::m_wheelDelta

int m_wheelDelta

The wheel delta, normally 120.

### wxMouseEvent::m_linesPerAction

int m_linesPerAction

The configured number of lines (or whatever) to be scrolled per wheel action.

### wxMouseEvent::wxMouseEvent

wxMouseEvent(WXTYPE mouseEventType = 0)

Constructor. Valid event types are:

- wxEVT_ENTER_WINDOW
- wxEVT_LEAVE_WINDOW
- wxEVT_LEFT_DOWN
- wxEVT_LEFT_UP
- wxEVT_LEFT_DCLICK
- wxEVT_MIDDLE_DOWN
- wxEVT_MIDDLE_UP
- wxEVT_MIDDLE_DCLICK
- wxEVT_RIGHT_DOWN
- wxEVT_RIGHT_UP
- wxEVT_RIGHT_DCLICK
- wxEVT_MOTION
- wxEVT_MOUSEWHEEL

### wxMouseEvent::AltDown

bool AltDown()

Returns true if the Alt key was down at the time of the event.

### wxMouseEvent::Button

bool Button(int button)

Returns true if the identified mouse button is changing state. Valid values of button are:

`wxMOUSE_BTN_LEFT` | check if left button was pressed
`wxMOUSE_BTN_MIDDLE` | check if middle button was pressed
`wxMOUSE_BTN_RIGHT` | check if right button was pressed
`wxMOUSE_BTN_ANY` | check if any button was pressed

### wxMouseEvent::ButtonDClick

bool ButtonDClick(int but = wxMOUSE_BTN_ANY)

If the argument is omitted, this returns true if the event was a mouse double click event. Otherwise the argument specifies which double click event was generated (see Button for the possible values).

### wxMouseEvent::ButtonDown

bool ButtonDown(int but = -1)

If the argument is omitted, this returns true if the event was a mouse button down event. Otherwise the argument specifies which button-down event was generated (see Button for the possible values).

### wxMouseEvent::ButtonUp

bool ButtonUp(int but = -1)

If the argument is omitted, this returns true if the event was a mouse button up event. Otherwise the argument specifies which button-up event was generated (see Button for the possible values).

### wxMouseEvent::CmdDown

bool CmdDown() const

Same as MetaDown under Mac, same as ControlDown elsewhere.

See also

wxKeyEvent::CmdDown

### wxMouseEvent::ControlDown

bool ControlDown()

Returns true if the control key was down at the time of the event.

### wxMouseEvent::Dragging

bool Dragging()

Returns true if this was a dragging event (motion while a button is depressed).

See also

Moving

### wxMouseEvent::Entering

bool Entering()

Returns true if the mouse was entering the window.

See also wxMouseEvent::Leaving.

### wxMouseEvent::GetButton

int GetButton() const

Returns the mouse button which generated this event or `wxMOUSE_BTN_NONE` if no button is involved (for mouse move, enter or leave event, for example). Otherwise `wxMOUSE_BTN_LEFT` is returned for the left button down, up and double click events, `wxMOUSE_BTN_MIDDLE` and `wxMOUSE_BTN_RIGHT` for the same events for the middle and the right buttons respectively.

### wxMouseEvent::GetPosition

wxPoint GetPosition() const

void GetPosition(wxCoord* x, wxCoord* y) const

void GetPosition(long* x, long* y) const

Sets *x and *y to the position at which the event occurred on the window.

Returns the physical mouse position on the window in pixels.

Note that if the mouse event has been artificially generated from a special keyboard combination (e.g. under Windows when the "menu'' key is pressed), the returned position is `wxDefaultPosition`.

### wxMouseEvent::GetLogicalPosition

wxPoint GetLogicalPosition(const wxDC& dc) const

Returns the logical mouse position on the window in pixels (i.e. translated according to the translation set for the DC, which usually indicates that the window has been scrolled).

### wxMouseEvent::GetLinesPerAction

int GetLinesPerAction() const

Returns the configured number of lines (or whatever) to be scrolled per wheel action. Defaults to three.

### wxMouseEvent::GetWheelRotation

int GetWheelRotation() const

Get wheel rotation, positive or negative indicates direction of rotation. Current devices all send an event when rotation is at least +/-WheelDelta, but finer resolution devices can be created in the future. Because of this you shouldn't assume that one event is equal to 1 line, but you should be able to either do partial line scrolling or wait until several events accumulate before scrolling.

### wxMouseEvent::GetWheelDelta

int GetWheelDelta() const

Get wheel delta, normally 120. This is the threshold for action to be taken, and one such action (for example, scrolling one increment) should occur for each delta.

### wxMouseEvent::GetX

long GetX() const

Returns the X coordinate of the physical mouse event position on the window.

### wxMouseEvent::GetY

long GetY()

Returns the Y coordinate of the physical mouse event position on the window.

### wxMouseEvent::IsButton

bool IsButton() const

Returns true if the event was a mouse button event (not necessarily a button down event - that may be tested using ButtonDown).

### wxMouseEvent::IsPageScroll

bool IsPageScroll() const

Returns true if the system has been setup to do page scrolling with the mouse wheel instead of line scrolling.

### wxMouseEvent::Leaving

bool Leaving() const

Returns true if the mouse was leaving the window.

See also wxMouseEvent::Entering.

### wxMouseEvent::LeftDClick

bool LeftDClick() const

Returns true if the event was a left double click.

### wxMouseEvent::LeftDown

bool LeftDown() const

Returns true if the left mouse button changed to down.

### wxMouseEvent::LeftIsDown

bool LeftIsDown() const

Returns true if the left mouse button is currently down, independent of the current event type.

Please notice that it is not the same as LeftDown which returns `true` if the event was generated by the left mouse button being pressed. Rather, it simply describes the state of the left mouse button at the time when the event was generated (so while it will be true for a left click event, it can also be true for a right click if it happened while the left mouse button was pressed).

This event is usually used in the mouse event handlers which process "move mouse" messages to determine whether the user is (still) dragging the mouse.

### wxMouseEvent::LeftUp

bool LeftUp() const

Returns true if the left mouse button changed to up.

### wxMouseEvent::MetaDown

bool MetaDown() const

Returns true if the Meta key was down at the time of the event.

### wxMouseEvent::MiddleDClick

bool MiddleDClick() const

Returns true if the event was a middle double click.

### wxMouseEvent::MiddleDown

bool MiddleDown() const

Returns true if the middle mouse button changed to down.

### wxMouseEvent::MiddleIsDown

bool MiddleIsDown() const

Returns true if the middle mouse button is currently down, independent of the current event type.

### wxMouseEvent::MiddleUp

bool MiddleUp() const

Returns true if the middle mouse button changed to up.

### wxMouseEvent::Moving

bool Moving() const

Returns true if this was a motion event and no mouse buttons were pressed. If any mouse button is held pressed, then this method returns `false` and Dragging returns `true`.

### wxMouseEvent::RightDClick

bool RightDClick() const

Returns true if the event was a right double click.

### wxMouseEvent::RightDown

bool RightDown() const

Returns true if the right mouse button changed to down.

### wxMouseEvent::RightIsDown

bool RightIsDown() const

Returns true if the right mouse button is currently down, independent of the current event type.

### wxMouseEvent::RightUp

bool RightUp() const

Returns true if the right mouse button changed to up.

### wxMouseEvent::ShiftDown

bool ShiftDown() const

Returns true if the shift key was down at the time of the event.