QWheelEvent

The QWheelEvent class contains parameters that describe a wheel event. More

Inheritance diagram of PySide6.QtGui.QWheelEvent

Synopsis

Functions

Detailed Description

Wheel events are sent to the widget under the mouse cursor, but if that widget does not handle the event they are sent to the focus widget. Wheel events are generated for both mouse wheels and trackpad scroll gestures. There are two ways to read the wheel event delta: angleDelta() returns the deltas in wheel degrees. These values are always provided. pixelDelta() returns the deltas in screen pixels, and is available on platforms that have high-resolution trackpads, such as macOS. If that is the case, device() -> type() will return QInputDevice::DeviceType::Touchpad.

The functions position() and globalPosition() return the mouse cursor’s location at the time of the event.

A wheel event contains a special accept flag that indicates whether the receiver wants the event. You should call ignore() if you do not handle the wheel event; this ensures that it will be sent to the parent widget.

The setEnabled() function can be used to enable or disable mouse and keyboard events for a widget.

The event handler wheelEvent() receives wheel events.

See also

QMouseEvent grabMouse()

class PySide6.QtGui.QWheelEvent(pos, globalPos, pixelDelta, angleDelta, buttons, modifiers, phase, inverted[, source=Qt.MouseEventNotSynthesized[, device=QPointingDevice.primaryPointingDevice()]])

PySide6.QtGui.QWheelEvent(arg__1)

Parameters

Constructs a wheel event object.

The pos provides the location of the mouse cursor within the window. The position in global coordinates is specified by globalPos.

pixelDelta contains the scrolling distance in pixels on screen, while angleDelta contains the wheel rotation angle. pixelDelta is optional and can be null.

The mouse and keyboard states at the time of the event are specified by buttons and modifiers.

The scrolling phase of the event is specified by phase, and the source indicates whether this is a genuine or artificial (synthesized) event.

If the system is configured to invert the delta values delivered with the event (such as natural scrolling of the touchpad on macOS), inverted should be true. Otherwise, inverted is false

The device from which the wheel event originated is specified by device.

PySide6.QtGui.QWheelEvent.angleDelta()
Return type

PySide6.QtCore.QPoint

PySide6.QtGui.QWheelEvent.hasPixelDelta()
Return type

bool

PySide6.QtGui.QWheelEvent.inverted()
Return type

bool

PySide6.QtGui.QWheelEvent.isInverted()
Return type

bool

PySide6.QtGui.QWheelEvent.phase()
Return type

ScrollPhase

PySide6.QtGui.QWheelEvent.pixelDelta()
Return type

PySide6.QtCore.QPoint

PySide6.QtGui.QWheelEvent.source()
Return type

MouseEventSource

Use pointingDevice() instead.

Returns information about the wheel event source.

The source can be used to distinguish between events that come from a mouse with a physical wheel and events that are generated by some other means, such as a flick gesture on a touchpad. This enum tells you from where it was synthesized; but often it’s more useful to know from which device it was synthesized, so try to use pointingDevice() instead.

Note

Many platforms provide no such information. On such platforms MouseEventNotSynthesized is returned always.

See also

MouseEventSource