Uranium
Application Framework
 All Classes Namespaces Files Functions Variables Pages
UM.Event.WheelEvent Class Reference

Event relating to what's happening with the scroll wheel of a mouse. More...

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

Public Member Functions

def __init__
 Create a new scroll wheel event. More...
 
def horizontal
 How far the scroll wheel was scrolled horizontally, in eighths of a degree. More...
 
def vertical
 How far the scroll wheel was scrolled vertically, in eighths of a degree. More...
 
- Public Member Functions inherited from UM.Event.MouseEvent
def __init__
 Raise a new mouse event. More...
 
def x
 The X coordinate of the event. More...
 
def y
 The Y coordinate of the event. More...
 
def lastX
 The X coordinate of the previous event. More...
 
def lastY
 The Y coordinate of the previous event. More...
 
def deltaX
 The change in X position between this event and the previous event. More...
 
def deltaY
 The change in Y position between this event and the previous event. More...
 
def buttons
 The list of buttons associated with this event. More...
 

Additional Inherited Members

- Static Public Attributes inherited from UM.Event.MouseEvent
string LeftButton = "left"
 Left mouse button. More...
 
string RightButton = "right"
 
string MiddleButton = "middle"
 

Detailed Description

Event relating to what's happening with the scroll wheel of a mouse.

Constructor & Destructor Documentation

def UM.Event.WheelEvent.__init__ (   self,
  horizontal 
)

Create a new scroll wheel event.

Parameters
horizontalHow far the scroll wheel scrolled horizontally, in eighths of a degree. To the right is positive. To the left is negative.
verticalHow far the scroll wheel scrolled vertically, in eighths of a degree. Up is positive. Down is negative.

Member Function Documentation

def UM.Event.WheelEvent.horizontal (   self,
  int 
)

How far the scroll wheel was scrolled horizontally, in eighths of a degree.

To the right is positive. To the left is negative.

def UM.Event.WheelEvent.vertical (   self,
  int 
)

How far the scroll wheel was scrolled vertically, in eighths of a degree.

Up is positive. Down is negative.


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