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.
 
int y (self)
 The Y coordinate of the event.
 
Optional[int] lastX (self)
 The X coordinate of the previous event.
 
Optional[int] lastY (self)
 The Y coordinate of the previous event.
 
int deltaX (self)
 The change in X position between this event and the previous event.
 
int deltaY (self)
 The change in Y position between this event and the previous event.
 
List buttons (self)
 The list of buttons associated with this event.
 

Static Public Attributes

string LeftButton = "left"
 Left mouse button.
 
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.

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