QGestureEvent#

The QGestureEvent class provides the description of triggered gestures. More…

Inheritance diagram of PySide6.QtWidgets.QGestureEvent

New in version 4.6.

Synopsis#

Functions#

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#

The QGestureEvent class contains a list of gestures, which can be obtained using the gestures() function.

The gestures are either active or canceled. A list of those that are currently being executed can be obtained using the activeGestures() function. A list of those which were previously active and have been canceled can be accessed using the canceledGestures() function. A gesture might be canceled if the current window loses focus, for example, or because of a timeout, or for other reasons.

If the event handler does not accept the event by calling the generic accept() function, all individual QGesture object that were not accepted and in the GestureStarted state will be propagated up the parent widget chain until a widget accepts them individually, by calling accept() for each of them, or an event filter consumes the event.

Further Reading#

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.

class PySide6.QtWidgets.QGestureEvent(gestures)#
Parameters:

gestures –

Creates new QGestureEvent containing a list of gestures.

PySide6.QtWidgets.QGestureEvent.accept(arg__1)#
Parameters:

arg__1 – PySide6.QtWidgets.QGesture

Sets the accept flag of the given gesture object, the equivalent of calling setAccepted(gesture, true) .

Setting the accept flag indicates that the event receiver wants the gesture. Unwanted gestures may be propagated to the parent widget.

See also

ignore()

PySide6.QtWidgets.QGestureEvent.accept(arg__1)
Parameters:

arg__1 – GestureType

Sets the accept flag of the given gestureType, the equivalent of calling setAccepted(gestureType, true) .

Setting the accept flag indicates that the event receiver wants the gesture. Unwanted gestures may be propagated to the parent widget.

See also

ignore()

PySide6.QtWidgets.QGestureEvent.activeGestures()#
Return type:

Returns a list of active (not canceled) gestures.

PySide6.QtWidgets.QGestureEvent.canceledGestures()#
Return type:

Returns a list of canceled gestures.

PySide6.QtWidgets.QGestureEvent.gesture(type)#
Parameters:

type – GestureType

Return type:

PySide6.QtWidgets.QGesture

Returns a gesture object by type.

PySide6.QtWidgets.QGestureEvent.gestures()#
Return type:

Returns all gestures that are delivered in the event.

PySide6.QtWidgets.QGestureEvent.ignore(arg__1)#
Parameters:

arg__1 – PySide6.QtWidgets.QGesture

Clears the accept flag parameter of the given gesture object, the equivalent of calling setAccepted(gesture, false) .

Clearing the accept flag indicates that the event receiver does not want the gesture. Unwanted gestures may be propagated to the parent widget.

See also

accept()

PySide6.QtWidgets.QGestureEvent.ignore(arg__1)
Parameters:

arg__1 – GestureType

Clears the accept flag parameter of the given gestureType, the equivalent of calling setAccepted(gesture, false) .

Clearing the accept flag indicates that the event receiver does not want the gesture. Unwanted gestures may be propagated to the parent widget.

See also

accept()

PySide6.QtWidgets.QGestureEvent.isAccepted(arg__1)#
Parameters:

arg__1 – PySide6.QtWidgets.QGesture

Return type:

bool

Returns true if the gesture is accepted; otherwise returns false.

PySide6.QtWidgets.QGestureEvent.isAccepted(arg__1)
Parameters:

arg__1 – GestureType

Return type:

bool

Returns true if the gesture of type gestureType is accepted; otherwise returns false.

PySide6.QtWidgets.QGestureEvent.mapToGraphicsScene(gesturePoint)#
Parameters:

gesturePoint – PySide6.QtCore.QPointF

Return type:

PySide6.QtCore.QPointF

Returns the scene-local coordinates if the gesturePoint is inside a graphics view.

This functional might be useful when the gesture event is delivered to a QGraphicsObject to translate a point in screen coordinates to scene-local coordinates.

See also

isNull()

PySide6.QtWidgets.QGestureEvent.setAccepted(arg__1, arg__2)#
Parameters:

Sets the accept flag of the given gesture object to the specified value.

Setting the accept flag indicates that the event receiver wants the gesture. Unwanted gestures may be propagated to the parent widget.

By default, gestures in events of type Gesture are accepted, and gestures in GestureOverride events are ignored.

For convenience, the accept flag can also be set with accept(gesture) , and cleared with ignore(gesture) .

See also

isAccepted()

PySide6.QtWidgets.QGestureEvent.setAccepted(arg__1, arg__2)
Parameters:

Sets the accept flag of the given gestureType object to the specified value.

Setting the accept flag indicates that the event receiver wants to receive gestures of the specified type, gestureType. Unwanted gestures may be propagated to the parent widget.

By default, gestures in events of type Gesture are accepted, and gestures in GestureOverride events are ignored.

For convenience, the accept flag can also be set with accept(gestureType) , and cleared with ignore(gestureType) .

PySide6.QtWidgets.QGestureEvent.setWidget(widget)#
Parameters:

widget – PySide6.QtWidgets.QWidget

PySide6.QtWidgets.QGestureEvent.widget()#
Return type:

PySide6.QtWidgets.QWidget

Returns the widget on which the event occurred.