wx.MouseEvent

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 MOUSE_BTN_LEFT for the left mouse button, MOUSE_BTN_MIDDLE for the middle one and MOUSE_BTN_RIGHT for the right one. And if the system supports more buttons, the MOUSE_BTN_AUX1 and MOUSE_BTN_AUX2 events can also be generated. Note that not all mice have even a middle button so a portable application should avoid relying on the events from it (but the right button click can be emulated using the left mouse button with the control key under Mac platforms with a single button mouse).

For the wxEVT_ENTER_WINDOW and wxEVT_LEAVE_WINDOW events purposes, the mouse is considered to be inside the window if it is in the window client area and not inside one of its children. In other words, the parent window receives wxEVT_LEAVE_WINDOW event not only when the mouse leaves the window entirely but also when it enters one of its children.

The position associated with a mouse event is expressed in the window coordinates of the window which generated the event, you can use wx.Window.ClientToScreen to convert it to screen coordinates and possibly call wx.Window.ScreenToClient next to convert it to window coordinates of another window.

Events Emitted by this Class

Handlers bound for the following event types will receive a wx.MouseEvent parameter.

• EVT_LEFT_DOWN: 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: Process a wxEVT_LEFT_UP event.

• EVT_LEFT_DCLICK: Process a wxEVT_LEFT_DCLICK event.

• EVT_MIDDLE_DOWN: Process a wxEVT_MIDDLE_DOWN event.

• EVT_MIDDLE_UP: Process a wxEVT_MIDDLE_UP event.

• EVT_MIDDLE_DCLICK: Process a wxEVT_MIDDLE_DCLICK event.

• EVT_RIGHT_DOWN: Process a wxEVT_RIGHT_DOWN event.

• EVT_RIGHT_UP: Process a wxEVT_RIGHT_UP event.

• EVT_RIGHT_DCLICK: Process a wxEVT_RIGHT_DCLICK event.

• EVT_MOUSE_AUX1_DOWN: Process a wxEVT_AUX1_DOWN event.

• EVT_MOUSE_AUX1_UP: Process a wxEVT_AUX1_UP event.

• EVT_MOUSE_AUX1_DCLICK: Process a wxEVT_AUX1_DCLICK event.

• EVT_MOUSE_AUX2_DOWN: Process a wxEVT_AUX2_DOWN event.

• EVT_MOUSE_AUX2_UP: Process a wxEVT_AUX2_UP event.

• EVT_MOUSE_AUX2_DCLICK: Process a wxEVT_AUX2_DCLICK event.

• EVT_MOTION: Process a wxEVT_MOTION event.

• EVT_ENTER_WINDOW: Process a wxEVT_ENTER_WINDOW event.

• EVT_LEAVE_WINDOW: Process a wxEVT_LEAVE_WINDOW event.

• EVT_MOUSEWHEEL: Process a wxEVT_MOUSEWHEEL event.

• EVT_MOUSE_EVENTS: Process all mouse events.

• EVT_MAGNIFY: Process a wxEVT_MAGNIFY event (new since wxWidgets 3.1.0).

Note

Note the difference between methods like wx.MouseEvent.LeftDown and the inherited wx.MouseState.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 wx.MouseEvent.LeftIsDown to test whether the left mouse button is (still) depressed. Also, by convention, if wx.MouseEvent.LeftDown returns True, wx.MouseEvent.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.

See also

wx.KeyEvent

Class Hierarchy

Inheritance diagram for class MouseEvent:

Methods Summary

__init__	Constructor.
Aux1DClick	Returns True if the event was a first extra button double click.
Aux1Down	Returns True if the first extra button mouse button changed to down.
Aux1Up	Returns True if the first extra button mouse button changed to up.
Aux2DClick	Returns True if the event was a second extra button double click.
Aux2Down	Returns True if the second extra button mouse button changed to down.
Aux2Up	Returns True if the second extra button mouse button changed to up.
Button	Returns True if the event was generated by the specified button.
ButtonDClick	If the argument is omitted, this returns True if the event was a mouse double click event.
ButtonDown	If the argument is omitted, this returns True if the event was a mouse button down event.
ButtonUp	If the argument is omitted, this returns True if the event was a mouse button up event.
Dragging	Returns True if this was a dragging event (motion while a button is depressed).
Entering	Returns True if the mouse was entering the window.
GetButton	Returns the mouse button which generated this event or MOUSE_BTN_NONE if no button is involved (for mouse move, enter or leave event, for example).
GetClickCount	Returns the number of mouse clicks for this event: 1 for a simple click, 2 for a double-click, 3 for a triple-click and so on.
GetColumnsPerAction	Returns the configured number of columns (or whatever) to be scrolled per wheel action.
GetLinesPerAction	Returns the configured number of lines (or whatever) to be scrolled per wheel action.
GetLogicalPosition	Returns the logical mouse position in pixels (i.e. translated according to the translation set for the DC, which usually indicates that the window has been scrolled).
GetMagnification	For magnify (pinch to zoom) events: returns the change in magnification.
GetWheelAxis	Gets the axis the wheel operation concerns.
GetWheelDelta	Get wheel delta, normally 120.
GetWheelRotation	Get wheel rotation, positive or negative indicates direction of rotation.
IsButton	Returns True if the event was a mouse button event (not necessarily a button down event - that may be tested using ButtonDown ).
IsPageScroll	Returns True if the system has been setup to do page scrolling with the mouse wheel instead of line scrolling.
IsWheelInverted	On Mac, has the user selected “Natural” scrolling in their System Preferences? Currently False on all other OS’s.
Leaving	Returns True if the mouse was leaving the window.
LeftDClick	Returns True if the event was a left double click.
LeftDown	Returns True if the left mouse button changed to down.
LeftUp	Returns True if the left mouse button changed to up.
Magnify	Returns True if the event is a magnify (i.e. pinch to zoom) event.
MetaDown	Returns True if the Meta key was down at the time of the event.
MiddleDClick	Returns True if the event was a middle double click.
MiddleDown	Returns True if the middle mouse button changed to down.
MiddleUp	Returns True if the middle mouse button changed to up.
Moving	Returns True if this was a motion event and no mouse buttons were pressed.
RightDClick	Returns True if the event was a right double click.
RightDown	Returns True if the right mouse button changed to down.
RightUp	Returns True if the right mouse button changed to up.
SetColumnsPerAction
SetLinesPerAction
SetWheelAxis
SetWheelDelta
SetWheelRotation

Properties Summary

ColumnsPerAction	See GetColumnsPerAction and SetColumnsPerAction
LinesPerAction	See GetLinesPerAction and SetLinesPerAction
WheelAxis	See GetWheelAxis and SetWheelAxis
WheelDelta	See GetWheelDelta and SetWheelDelta
WheelRotation	See GetWheelRotation and SetWheelRotation

Class API

class wx.MouseEvent(Event, MouseState)

Possible constructors:

MouseEvent(mouseEventType=wxEVT_NULL) -> None

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

Methods

__init__(self, mouseEventType=wxEVT_NULL)

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_AUX1_DOWN

• wxEVT_AUX1_UP

• wxEVT_AUX1_DCLICK

• wxEVT_AUX2_DOWN

• wxEVT_AUX2_UP

• wxEVT_AUX2_DCLICK

• wxEVT_MOTION

• wxEVT_MOUSEWHEEL

• wxEVT_MAGNIFY

Parameters:

mouseEventType (wx.EventType)

Return type:

None

---

Aux1DClick(self)

Returns True if the event was a first extra button double click.

Return type:

bool

---

Aux1Down(self)

Returns True if the first extra button mouse button changed to down.

Return type:

bool

---

Aux1Up(self)

Returns True if the first extra button mouse button changed to up.

Return type:

bool

---

Aux2DClick(self)

Returns True if the event was a second extra button double click.

Return type:

bool

---

Aux2Down(self)

Returns True if the second extra button mouse button changed to down.

Return type:

bool

---

Aux2Up(self)

Returns True if the second extra button mouse button changed to up.

Return type:

bool

---

Button(self, but)

Returns True if the event was generated by the specified button.

Parameters:

but (MouseButton)

Return type:

bool

See also

MouseState.ButtoinIsDown()

---

ButtonDClick(self, but=MOUSE_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 wx.Button for the possible values).

Parameters:

but (MouseButton)

Return type:

bool

---

ButtonDown(self, but=MOUSE_BTN_ANY)

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 wx.Button for the possible values).

Parameters:

but (MouseButton)

Return type:

bool

---

ButtonUp(self, but=MOUSE_BTN_ANY)

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 wx.Button for the possible values).

Parameters:

but (MouseButton)

Return type:

bool

---

Dragging(self)

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

Return type:

bool

See also

Moving

---

Entering(self)

Returns True if the mouse was entering the window.

Return type:

bool

See also

Leaving

---

GetButton(self)

Returns the mouse button which generated this event or MOUSE_BTN_NONE if no button is involved (for mouse move, enter or leave event, for example).

Otherwise MOUSE_BTN_LEFT is returned for the left button down, up and double click events, MOUSE_BTN_MIDDLE and MOUSE_BTN_RIGHT for the same events for the middle and the right buttons respectively.

Return type:

int

---

GetClickCount(self)

Returns the number of mouse clicks for this event: 1 for a simple click, 2 for a double-click, 3 for a triple-click and so on.

Currently this function is implemented only in Mac and returns -1 for the other platforms (you can still distinguish simple clicks from double-clicks as they generate different kinds of events however).

Return type:

int

Added in version 2.9.0.

---

GetColumnsPerAction(self)

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

Default value under most platforms is three.

Return type:

int

Added in version 2.9.5.

See also

GetLinesPerAction

---

GetLinesPerAction(self)

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

Default value under most platforms is three.

Return type:

int

See also

GetColumnsPerAction

---

GetLogicalPosition(self, dc)

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

Parameters:

dc (wx.DC)

Return type:

wx.Point

---

GetMagnification(self)

For magnify (pinch to zoom) events: returns the change in magnification.

A value of 0 means no change, a positive value means we should enlarge (or zoom in), a negative value means we should shrink (or zoom out).

This method is only valid to call for wxEVT_MAGNIFY events which are currently only generated under macOS.

Return type:

float

Added in version 4.1/wxWidgets-3.1.0.

See also

Magnify

---

GetWheelAxis(self)

Gets the axis the wheel operation concerns.

Usually the mouse wheel is used to scroll vertically so MOUSE_WHEEL_VERTICAL is returned but some mice (and most trackpads) also allow to use the wheel to scroll horizontally in which case MOUSE_WHEEL_HORIZONTAL is returned.

Notice that before wxWidgets 2.9.4 this method returned int .

Return type:

wx.MouseWheelAxis

---

GetWheelDelta(self)

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.

Return type:

int

---

GetWheelRotation(self)

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.

Return type:

int

---

IsButton(self)

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

Return type:

bool

---

IsPageScroll(self)

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

Return type:

bool

---

IsWheelInverted(self)

On Mac, has the user selected “Natural” scrolling in their System Preferences? Currently False on all other OS’s.

“Natural” scrolling means that content scrolling happens in the opposite direction, and if you are indeed scrolling content then you don’t need to use this function because macOS has already inverted the scroll direction. But there can be special situations where you want the mouse wheel action to work always in the same direction and in that case you will need this function.

Return type:

bool

Added in version 4.1/wxWidgets-3.1.3.

---

Leaving(self)

Returns True if the mouse was leaving the window.

Return type:

bool

See also

Entering .

---

LeftDClick(self)

Returns True if the event was a left double click.

Return type:

bool

---

LeftDown(self)

Returns True if the left mouse button changed to down.

Return type:

bool

---

LeftUp(self)

Returns True if the left mouse button changed to up.

Return type:

bool

---

Magnify(self)

Returns True if the event is a magnify (i.e. pinch to zoom) event.

Such events are currently generated only under macOS.

Return type:

bool

Added in version 4.1/wxWidgets-3.1.0.

See also

GetMagnification

---

MetaDown(self)

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

Return type:

bool

---

MiddleDClick(self)

Returns True if the event was a middle double click.

Return type:

bool

---

MiddleDown(self)

Returns True if the middle mouse button changed to down.

Return type:

bool

---

MiddleUp(self)

Returns True if the middle mouse button changed to up.

Return type:

bool

---

Moving(self)

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.

Return type:

bool

---

RightDClick(self)

Returns True if the event was a right double click.

Return type:

bool

---

RightDown(self)

Returns True if the right mouse button changed to down.

Return type:

bool

---

RightUp(self)

Returns True if the right mouse button changed to up.

Return type:

bool

---

SetColumnsPerAction(self, columnsPerAction)

Return type:

None

---

SetLinesPerAction(self, linesPerAction)

Return type:

None

---

SetWheelAxis(self, wheelAxis)

Return type:

None

---

SetWheelDelta(self, wheelDelta)

Return type:

None

---

SetWheelRotation(self, wheelRotation)

Return type:

None

Properties

ColumnsPerAction

See GetColumnsPerAction and SetColumnsPerAction

---

LinesPerAction

See GetLinesPerAction and SetLinesPerAction

---

WheelAxis

See GetWheelAxis and SetWheelAxis

---

WheelDelta

See GetWheelDelta and SetWheelDelta

---

WheelRotation

See GetWheelRotation and SetWheelRotation