QGestureEvent Class
The QGestureEvent class provides the description of triggered gestures. More...
| Header: | #include <QGestureEvent> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Widgets) target_link_libraries(mytarget PRIVATE Qt6::Widgets) |
| qmake: | QT += widgets |
| Inherits: | QEvent |
- List of all members, including inherited members
- QGestureEvent is part of Event Classes.
Public Functions
| QGestureEvent(const QList<QGesture *> &gestures) | |
| virtual | ~QGestureEvent() |
| void | accept(QGesture *gesture) |
| void | accept(Qt::GestureType gestureType) |
| QList<QGesture *> | activeGestures() const |
| QList<QGesture *> | canceledGestures() const |
| QGesture * | gesture(Qt::GestureType type) const |
| QList<QGesture *> | gestures() const |
| void | ignore(QGesture *gesture) |
| void | ignore(Qt::GestureType gestureType) |
| bool | isAccepted(QGesture *gesture) const |
| bool | isAccepted(Qt::GestureType gestureType) const |
| QPointF | mapToGraphicsScene(const QPointF &gesturePoint) const |
| void | setAccepted(QGesture *gesture, bool value) |
| void | setAccepted(Qt::GestureType gestureType, bool value) |
| QWidget * | widget() const |
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 QEvent::accept() function, all individual QGesture object that were not accepted and in the Qt::GestureStarted state will be propagated up the parent widget chain until a widget accepts them individually, by calling QGestureEvent::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.
See also QGesture, QGestureRecognizer, QWidget::grabGesture(), and QGraphicsObject::grabGesture().
Member Function Documentation
[explicit] QGestureEvent::QGestureEvent(const QList<QGesture *> &gestures)
Creates new QGestureEvent containing a list of gestures.
[virtual noexcept] QGestureEvent::~QGestureEvent()
Destroys QGestureEvent.
void QGestureEvent::accept(QGesture *gesture)
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 QGestureEvent::ignore().
void QGestureEvent::accept(Qt::GestureType 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 QGestureEvent::ignore().
QList<QGesture *> QGestureEvent::activeGestures() const
Returns a list of active (not canceled) gestures.
QList<QGesture *> QGestureEvent::canceledGestures() const
Returns a list of canceled gestures.
QGesture *QGestureEvent::gesture(Qt::GestureType type) const
Returns a gesture object by type.
QList<QGesture *> QGestureEvent::gestures() const
Returns all gestures that are delivered in the event.
void QGestureEvent::ignore(QGesture *gesture)
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 QGestureEvent::accept().
void QGestureEvent::ignore(Qt::GestureType 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 QGestureEvent::accept().
bool QGestureEvent::isAccepted(QGesture *gesture) const
Returns true if the gesture is accepted; otherwise returns false.
bool QGestureEvent::isAccepted(Qt::GestureType gestureType) const
Returns true if the gesture of type gestureType is accepted; otherwise returns false.
QPointF QGestureEvent::mapToGraphicsScene(const QPointF &gesturePoint) const
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 QPointF::isNull().
void QGestureEvent::setAccepted(QGesture *gesture, bool value)
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 QEvent::Gesture are accepted, and gestures in QEvent::GestureOverride events are ignored.
For convenience, the accept flag can also be set with accept(gesture), and cleared with ignore(gesture).
See also isAccepted().
void QGestureEvent::setAccepted(Qt::GestureType gestureType, bool value)
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 QEvent::Gesture are accepted, and gestures in QEvent::GestureOverride events are ignored.
For convenience, the accept flag can also be set with accept(gestureType), and cleared with ignore(gestureType).
QWidget *QGestureEvent::widget() const
Returns the widget on which the event occurred.