New in version 4.6.
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
Gesture recognizers are responsible for creating and managing
QGesture objects and monitoring input events sent to
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.
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
QGraphicsObject subclass. A
QGesture object is created for each widget or item that is configured to use gestures.
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.
QGestureRecognizer subclass needs to reimplement the
recognize() function to handle and filter the incoming input events for
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.
- class PySide6.QtWidgets.QGestureRecognizer#
Constructs a new gesture recognizer object.
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).
The event does not change the state of the recognizer.
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.
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
QGestureobject will be delivered to the target as a part of a
This hint specifies that the gesture framework should consume the filtered event and not deliver it to the receiver.
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)#
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.
The result reflects how much of the gesture has been recognized. The state of the
gesture object is set depending on the result.
- static PySide6.QtWidgets.QGestureRecognizer.registerRecognizer(recognizer)#
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 Qt::CustomGesture in a
gestureType() function) the return value is a generated gesture ID with the Qt::CustomGesture flag set.
This function is called by the framework to reset a given
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)#
Unregisters all gesture recognizers of the specified