QNativeGestureEvent Class

The QNativeGestureEvent class contains parameters that describe a gesture event. \inmodule QtGui \ingroup events. More...

Header: #include <QNativeGestureEvent>
Inherits: QSinglePointEvent

Public Functions

QNativeGestureEvent(Qt::NativeGestureType type, const QPointingDevice *device, const QPointF &localPos, const QPointF &scenePos, const QPointF &globalPos, qreal realValue, quint64 sequenceId, quint64 intValue)
QNativeGestureEvent(Qt::NativeGestureType type, const QPointingDevice *device, int fingerCount, const QPointF &localPos, const QPointF &scenePos, const QPointF &globalPos, qreal value, const QPointF &delta, quint64 sequenceId = ...)
QPointF delta() const
int fingerCount() const
Qt::NativeGestureType gestureType() const
const QPoint globalPos() const
QPointF localPos() const
const QPoint pos() const
QPointF screenPos() const
qreal value() const
QPointF windowPos() const

Detailed Description

\since5.2

Native gesture events are generated by the operating system, typically by interpreting trackpad touch events. Gesture events are high-level events such as zoom, rotate or pan. Several types hold incremental values: that is, value() and delta() provide the difference from the previous event to the current event.

Event TypeDescriptionTouch sequence
Qt::ZoomNativeGestureMagnification delta in percent.macOS and Wayland: Two-finger pinch.
Qt::SmartZoomNativeGestureBoolean magnification state.macOS: Two-finger douple tap (trackpad) / One-finger douple tap (magic mouse).
Qt::RotateNativeGestureRotation delta in degrees.macOS and Wayland: Two-finger rotate.
Qt::SwipeNativeGestureSwipe angle in degrees.macOS: Configurable in trackpad settings.
Qt::PanNativeGestureDisplacement delta in pixels.Wayland: Three or more fingers moving as a group, in any direction.

In addition, BeginNativeGesture and EndNativeGesture are sent before and after gesture event streams:

BeginNativeGesture ZoomNativeGesture ZoomNativeGesture ZoomNativeGesture EndNativeGesture

The event stream may include interleaved gestures of different types: for example the two-finger pinch gesture generates a stream of Zoom and Rotate events, and PanNativeGesture may sometimes be interleaved with those, depending on the platform.

Other types are standalone events: SmartZoomNativeGesture and SwipeNativeGesture occur only once each time the gesture is detected.

Note: On a touchpad, moving two fingers as a group (the two-finger flick gesture) is usually reserved for scrolling; in that case, Qt generates QWheelEvents. This is the reason that three or more fingers are needed to generate a PanNativeGesture.

See also Qt::NativeGestureType, QGestureEvent, and QWheelEvent.

Member Function Documentation

QNativeGestureEvent::QNativeGestureEvent(Qt::NativeGestureType type, const QPointingDevice *device, const QPointF &localPos, const QPointF &scenePos, const QPointF &globalPos, qreal realValue, quint64 sequenceId, quint64 intValue)

\deprecated[6.2] Use the other constructor, because intValue is no longer stored separately.

Constructs a native gesture event of type type originating from device.

The points localPos, scenePos and globalPos specify the gesture position relative to the receiving widget or item, window, and screen or desktop, respectively.

realValue is the macOS event parameter, sequenceId and intValue are the Windows event parameters. \since 5.10

Note: It's not possible to store realValue and intValue simultaneously: one or the other must be zero. If realValue == 0 and intValue != 0, it is stored in the same variable, such that value() returns the value given as intValue.

QNativeGestureEvent::QNativeGestureEvent(Qt::NativeGestureType type, const QPointingDevice *device, int fingerCount, const QPointF &localPos, const QPointF &scenePos, const QPointF &globalPos, qreal value, const QPointF &delta, quint64 sequenceId = ...)

Constructs a native gesture event of type type originating from device describing a gesture at scenePos in which fingerCount fingers are involved.

The points localPos, scenePos and globalPos specify the gesture position relative to the receiving widget or item, window, and screen or desktop, respectively.

value has a gesture-dependent interpretation: for RotateNativeGesture or SwipeNativeGesture, it's an angle in degrees. For ZoomNativeGesture, value is an incremental scaling factor, usually much less than 1, indicating that the target item should have its scale adjusted like this: item.scale = item.scale * (1 + event.value)

For PanNativeGesture, delta gives the distance in pixels that the viewport, widget or item should be moved or panned.

Note: The delta is stored in single precision (QVector2D), so delta() may return slightly different values in some cases. This is subject to change in future versions of Qt.

\since6.2

QPointF QNativeGestureEvent::delta() const

\since6.2

Returns the distance moved since the previous event, in pixels. A Pan gesture provides the distance in pixels by which the target widget, item or viewport contents should be moved.

See also QPanGesture::delta().

int QNativeGestureEvent::fingerCount() const

\since6.2

Returns the number of fingers participating in the gesture, if known. When gestureType() is Qt::BeginNativeGesture or Qt::EndNativeGesture, often this information is unknown, and fingerCount() returns 0.

Qt::NativeGestureType QNativeGestureEvent::gestureType() const

\since5.2

Returns the gesture type.

const QPoint QNativeGestureEvent::globalPos() const

\since5.2 \deprecated [6.0] Use globalPosition().toPoint() instead.

Returns the position of the gesture as a QPointF in screen coordinates

QPointF QNativeGestureEvent::localPos() const

\since5.2 \deprecated [6.0] Use position() instead.

Returns the position of the gesture as a QPointF, relative to the widget or item that received the event.

const QPoint QNativeGestureEvent::pos() const

\since5.2 \deprecated [6.0] Use position().toPoint() instead.

Returns the position of the mouse cursor, relative to the widget or item that received the event.

QPointF QNativeGestureEvent::screenPos() const

\since5.2 \deprecated [6.0] Use globalPosition() instead.

Returns the position of the gesture as a QPointF in screen coordinates.

qreal QNativeGestureEvent::value() const

\since5.2

Returns the gesture value. The value should be interpreted based on the gesture type. For example, a Zoom gesture provides a scale factor delta while a Rotate gesture provides a rotation delta.

See also QNativeGestureEvent and gestureType().

QPointF QNativeGestureEvent::windowPos() const

\since5.2 \deprecated [6.0] Use scenePosition() instead.

Returns the position of the gesture as a QPointF, relative to the window that received the event.