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:
Public Member Functions | |
| None | __init__ (self, int horizontal, int vertical, int x=0, int y=0) |
| Create a new scroll wheel event. More... | |
| int | horizontal (self) |
| How far the scroll wheel was scrolled horizontally, in eighths of a degree. More... | |
| int | vertical (self) |
| How far the scroll wheel was scrolled vertically, in eighths of a degree. More... | |
 Public Member Functions inherited from UM.Event.MouseEvent | |
| 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... | |
| int | lastX (self) |
| The X coordinate of the previous event. More... | |
| 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... | |
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
◆ __init__()
| None UM.Event.WheelEvent.__init__ | ( | self, | |
| int | horizontal, | ||
| int | vertical, | ||
| int | x = 0, |
||
| int | y = 0 |
||
| ) |
Create a new scroll wheel event.
- Parameters
-
horizontal How far the scroll wheel scrolled horizontally, in eighths of a degree. To the right is positive. To the left is negative. vertical How far the scroll wheel scrolled vertically, in eighths of a degree. Up is positive. Down is negative.
Member Function Documentation
◆ horizontal()
| int UM.Event.WheelEvent.horizontal | ( | self | ) |
How far the scroll wheel was scrolled horizontally, in eighths of a degree.
To the right is positive. To the left is negative.
◆ vertical()
| int UM.Event.WheelEvent.vertical | ( | self | ) |
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:
- UM/Event.py
