QGestureRecognizer

The QGestureRecognizer class provides the infrastructure for gesture recognition. More…

New in version 4.6.

Synopsis

Virtual functions

• def create (target)

• def recognize (state, watched, event)

• def reset (state)

Static functions

• def registerRecognizer (recognizer)

• def unregisterRecognizer (type)

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Gesture recognizers are responsible for creating and managing QGesture objects and monitoring input events sent to QWidget and QGraphicsObject subclasses. QGestureRecognizer is the base class for implementing custom gestures.

Developers that only need to provide gesture recognition for standard gestures do not need to use this class directly. Instances will be created behind the scenes by the framework.

For an overview of gesture handling in Qt and information on using gestures in your applications, see the Gestures in Widgets and Graphics View document.

Recognizing Gestures

The process of recognizing gestures involves filtering input events sent to specific objects, and modifying the associated QGesture objects to include relevant information about the user’s input.

Gestures are created when the framework calls create() to handle user input for a particular instance of a QWidget or QGraphicsObject subclass. A QGesture object is created for each widget or item that is configured to use gestures.

Once a QGesture has been created for a target object, the gesture recognizer will receive events for it in its recognize() handler function.

When a gesture is canceled, the reset() function is called, giving the recognizer the chance to update the appropriate properties in the corresponding QGesture object.

Supporting New Gestures

To add support for new gestures, you need to derive from QGestureRecognizer to create a custom recognizer class, construct an instance of this class, and register it with the application by calling registerRecognizer() . You can also subclass QGesture to create a custom gesture class, or rely on dynamic properties to express specific details of the gesture you want to handle.

Your custom QGestureRecognizer subclass needs to reimplement the recognize() function to handle and filter the incoming input events for QWidget and QGraphicsObject subclasses. Although the logic for gesture recognition is implemented in this function, you can store persistent information about the state of the recognition process in the QGesture object supplied. The recognize() function must return a value of Result that indicates the state of recognition for a given gesture and target object. This determines whether or not a gesture event will be delivered to a target object.

If you choose to represent a gesture by a custom QGesture subclass, you will need to reimplement the create() function to construct instances of your gesture class. Similarly, you may need to reimplement the reset() function if your custom gesture objects need to be specially handled when a gesture is canceled.

See also

QGesture

class PySide6.QtWidgets.QGestureRecognizer

Constructs a new gesture recognizer object.

PySide6.QtWidgets.QGestureRecognizer.ResultFlag

(inherits enum.Flag) This enum describes the result of the current event filtering step in a gesture recognizer state machine.

The result consists of a state value (one of Ignore, MayBeGesture, TriggerGesture, FinishGesture, CancelGesture) and an optional hint (ConsumeEventHint).

Constant	Description
QGestureRecognizer.Ignore	The event does not change the state of the recognizer.
QGestureRecognizer.MayBeGesture	The event changed the internal state of the recognizer, but it isn’t clear yet if it is a gesture or not. The recognizer needs to filter more events to decide. Gesture recognizers in the MayBeGesture state may be reset automatically if they take too long to recognize gestures.
QGestureRecognizer.TriggerGesture	The gesture has been triggered and the appropriate QGesture object will be delivered to the target as a part of a QGestureEvent .
QGestureRecognizer.FinishGesture	The gesture has been finished successfully and the appropriate QGesture object will be delivered to the target as a part of a QGestureEvent .
QGestureRecognizer.CancelGesture	The event made it clear that it is not a gesture. If the gesture recognizer was in GestureTriggered state before, then the gesture is canceled and the appropriate QGesture object will be delivered to the target as a part of a QGestureEvent .
QGestureRecognizer.ConsumeEventHint	This hint specifies that the gesture framework should consume the filtered event and not deliver it to the receiver.

See also

recognize()

PySide6.QtWidgets.QGestureRecognizer.create(target)

Parameters:

target – PySide6.QtCore.QObject

Return type:

PySide6.QtWidgets.QGesture

This function is called by Qt to create a new QGesture object for the given target ( QWidget or QGraphicsObject ).

Reimplement this function to create a custom QGesture -derived gesture object if necessary.

The application takes ownership of the created gesture object.

abstract PySide6.QtWidgets.QGestureRecognizer.recognize(state, watched, event)

Parameters:

• state – PySide6.QtWidgets.QGesture

• watched – PySide6.QtCore.QObject

• event – PySide6.QtCore.QEvent

Return type:

Result

Handles the given event for the watched object, updating the state of the gesture object as required, and returns a suitable result for the current recognition step.

This function is called by the framework to allow the recognizer to filter input events dispatched to QWidget or QGraphicsObject instances that it is monitoring.

The result reflects how much of the gesture has been recognized. The state of the gesture object is set depending on the result.

See also

Result

static PySide6.QtWidgets.QGestureRecognizer.registerRecognizer(recognizer)

Parameters:

recognizer – PySide6.QtWidgets.QGestureRecognizer

Return type:

GestureType

Registers the given recognizer in the gesture framework and returns a gesture ID for it.

The application takes ownership of the recognizer and returns the gesture type ID associated with it. For gesture recognizers which handle custom QGesture objects (i.e., those which return CustomGesture in a gestureType() function) the return value is a generated gesture ID with the CustomGesture flag set.

See also

unregisterRecognizer() create() QGesture

PySide6.QtWidgets.QGestureRecognizer.reset(state)

Parameters:

state – PySide6.QtWidgets.QGesture

This function is called by the framework to reset a given gesture.

Reimplement this function to implement additional requirements for custom QGesture objects. This may be necessary if you implement a custom QGesture whose properties need special handling when the gesture is reset.

static PySide6.QtWidgets.QGestureRecognizer.unregisterRecognizer(type)

Parameters:

type – GestureType

Unregisters all gesture recognizers of the specified type.

See also

registerRecognizer()