Uranium
Application Framework
UM.Event.MouseEvent Class Reference

Mouse Event class. More...

Inheritance diagram for UM.Event.MouseEvent:
UM.Event.WheelEvent

Public Member Functions

None __init__ (self, int event_type, int x=0, int y=0, int last_x=None, int last_y=None, List buttons=None)
 Raise a new mouse event. More...
 
int x (self)
 The X coordinate of the event. More...
 
int y (self)
 The Y coordinate of the event. More...
 
Optional[int] lastX (self)
 The X coordinate of the previous event. More...
 
Optional[int] lastY (self)
 The Y coordinate of the previous event. More...
 
int deltaX (self)
 The change in X position between this event and the previous event. More...
 
int deltaY (self)
 The change in Y position between this event and the previous event. More...
 
List buttons (self)
 The list of buttons associated with this event. More...
 

Static Public Attributes

string LeftButton = "left"
 Left mouse button. More...
 
string RightButton = "right"
 
string MiddleButton = "middle"
 

Detailed Description

Mouse Event class.

This class represents a mouse event. It has properties corresponding to important mouse event properties and constants for mouse buttons.

Constructor & Destructor Documentation

◆ __init__()

None UM.Event.MouseEvent.__init__ (   self,
int  event_type,
int   x = 0,
int   y = 0,
int   last_x = None,
int   last_y = None,
List   buttons = None 
)

Raise a new mouse event.

Parameters
typeThe type of event.
See also
Event
Parameters
xThe X coordinate of the event.
yThe Y coordinate of the event.
last_xThe X coordinate of the previous mouse event. Can be None. It is used to calculate deltaX.
last_yThe Y coordinate of the previous mouse event. Cam be None. It is used to calculate deltaY.
buttonsThe buttons that are associated with this event.

Member Function Documentation

◆ buttons()

List UM.Event.MouseEvent.buttons (   self)

The list of buttons associated with this event.

◆ deltaX()

int UM.Event.MouseEvent.deltaX (   self)

The change in X position between this event and the previous event.

◆ deltaY()

int UM.Event.MouseEvent.deltaY (   self)

The change in Y position between this event and the previous event.

◆ lastX()

Optional[int] UM.Event.MouseEvent.lastX (   self)

The X coordinate of the previous event.

◆ lastY()

Optional[int] UM.Event.MouseEvent.lastY (   self)

The Y coordinate of the previous event.

◆ x()

int UM.Event.MouseEvent.x (   self)

The X coordinate of the event.

◆ y()

int UM.Event.MouseEvent.y (   self)

The Y coordinate of the event.

Member Data Documentation

◆ LeftButton

string UM.Event.MouseEvent.LeftButton = "left"
static

Left mouse button.


The documentation for this class was generated from the following file: