UM.Event.MouseEvent Class Reference

Mouse Event class. More...

Inherits UM.Event.Event.

Public Member Functions
def	__init__
	Raise a new mouse event. More...
def	x (self)
	The X coordinate of the event. More...
def	y (self)
	The Y coordinate of the event. More...
def	lastX (self)
	The X coordinate of the previous event. More...
def	lastY (self)
	The Y coordinate of the previous event. More...
def	deltaX (self)
	The change in X position between this event and the previous event. More...
def	deltaY (self)
	The change in Y position between this event and the previous event. More...
def	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__()

def UM.Event.MouseEvent.__init__	(		self,
			event_type
	)

Raise a new mouse event.

Parameters

type	The type of event.

See also

Event

Parameters

x	The X coordinate of the event.
y	The Y coordinate of the event.
last_x	The X coordinate of the previous mouse event. Can be None. It is used to calculate deltaX.
last_y	The Y coordinate of the previous mouse event. Cam be None. It is used to calculate deltaY.
buttons	The buttons that are associated with this event.

Member Function Documentation

buttons()

def UM.Event.MouseEvent.buttons	(		self,
			List
	)

The list of buttons associated with this event.

deltaX()

def UM.Event.MouseEvent.deltaX	(		self,
			int
	)

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

deltaY()

def UM.Event.MouseEvent.deltaY	(		self,
			int
	)

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

lastX()

def UM.Event.MouseEvent.lastX	(		self,
			int
	)

The X coordinate of the previous event.

lastY()

def UM.Event.MouseEvent.lastY	(		self,
			int
	)

The Y coordinate of the previous event.

x()

def UM.Event.MouseEvent.x	(		self,
			int
	)

The X coordinate of the event.

y()

def UM.Event.MouseEvent.y	(		self,
			int
	)

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:

• UM/Event.py