Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qquickdeliveryagent_p_p.h
Go to the documentation of this file.
1// Copyright (C) 2021 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3// Qt-Security score:significant reason:default
4
5#ifndef QQUICKDELIVERYAGENT_P_P_H
6#define QQUICKDELIVERYAGENT_P_P_H
7
8//
9// W A R N I N G
10// -------------
11//
12// This file is not part of the Qt API. It exists purely as an
13// implementation detail. This header file may change from version to
14// version without notice, or even be removed.
15//
16// We mean it.
17//
18
19#include <QtQuick/private/qquickdeliveryagent_p.h>
20#include <QtGui/qevent.h>
21#include <QtCore/qelapsedtimer.h>
22#include <QtCore/qstack.h>
23#include <QtCore/qxpfunctional.h>
24
25#include <private/qevent_p.h>
26#include <private/qpointingdevice_p.h>
27
28#include <QtCore/qpointer.h>
29#include <private/qobject_p.h>
30
31#include <memory>
32
33QT_BEGIN_NAMESPACE
34
35class QQuickDragGrabber;
36class QQuickItem;
37class QQuickPointerHandler;
38class QQuickWindow;
39
40/*! \internal
41 Extra device-specific data to be stored in QInputDevicePrivate::qqExtra.
42
43 \c deliveryTargets is a list of objects that have already been visited
44 during event delivery:
45 - QQuickPointerHandlerPrivate::deviceDeliveryTargets() returns the whole
46 list by reference
47 - QQuickPointerHandler::handlePointerEvent() appends to it
48 - QQuickItemPrivate::handlePointerEvent() checks it to prevent delivery to
49 the same handler multiple times
50*/
54
55class Q_QUICK_EXPORT QQuickDeliveryAgentPrivate : public QObjectPrivate
56{
57public:
58 Q_DECLARE_PUBLIC(QQuickDeliveryAgent)
59 QQuickDeliveryAgentPrivate(QQuickItem *root);
60 ~QQuickDeliveryAgentPrivate();
61
62 QQuickItem *rootItem = nullptr;
63
64 QQuickItem *activeFocusItem = nullptr;
65
66 void deliverKeyEvent(QKeyEvent *e);
67
68 enum FocusOption {
69 DontChangeFocusProperty = 0x01,
70 DontChangeSubFocusItem = 0x02
71 };
72 Q_DECLARE_FLAGS(FocusOptions, FocusOption)
73
74 void setFocusInScope(QQuickItem *scope, QQuickItem *item, Qt::FocusReason reason, FocusOptions = { });
75 void clearFocusInScope(QQuickItem *scope, QQuickItem *item, Qt::FocusReason reason, FocusOptions = { });
76 static void notifyFocusChangesRecur(QQuickItem **item, int remaining, Qt::FocusReason reason);
77 void clearFocusObject();
78 void updateFocusItemTransform();
79
80 QQuickItem *focusTargetItem() const;
81
82 // Keeps track of the item currently receiving mouse events
83#if QT_CONFIG(quick_draganddrop)
84 QQuickDragGrabber *dragGrabber = nullptr;
85#endif
86 QQuickItem *lastUngrabbed = nullptr;
87 QStack<QPointerEvent *> eventsInDelivery;
88 struct HoverItemState {
89 QPointer<QQuickItem> item;
90 uint hoverId = 0;
91 };
92 using HoverItems = QList<HoverItemState>;
93 HoverItems hoverItems;
94 QList<QQuickItem *> hasFiltered; // during event delivery to a single receiver, the filtering parents for which childMouseEventFilter was already called
95 QList<QQuickItem *> skipDelivery; // during delivery of one event to all receivers, Items to which we know delivery is no longer necessary
96
97 std::unique_ptr<QMutableTouchEvent> delayedTouch;
98 QList<const QPointingDevice *> knownPointingDevices;
99
100 uint currentHoverId = 0;
101#if QT_CONFIG(wheelevent)
102 uint lastWheelEventAccepted = 0;
103#endif
104 uchar compressedTouchCount = 0;
105 bool allowChildEventFiltering = true;
106 bool hoveredLeafItemFound = false;
107
108 bool isSubsceneAgent = false;
109 static bool subsceneAgentsExist;
110 // QQuickDeliveryAgent::event() sets this to the one that's currently (trying to) handle the event
111 static QQuickDeliveryAgent *currentEventDeliveryAgent;
112 static QQuickDeliveryAgent *currentOrItemDeliveryAgent(const QQuickItem *item);
113 inline static quint64 frameSynchronousHover_counter = 0;
114
115 int frameSynchronousHoverInterval = 100; // milliseconds
116 QElapsedTimer frameSynchronousHoverTimer; // avoid calling deliverHoverEvent/updateCursor too often
117 QBasicTimer frameSynchronousDelayTimer; // call deliverHoverEvent/updateCursor after a delay
118
119 Qt::FocusReason lastFocusReason = Qt::OtherFocusReason;
120 int pointerEventRecursionGuard = 0;
121
122 int touchMouseId = -1; // only for obsolete stuff like QQuickItem::grabMouse()
123 // TODO get rid of these
124 const QPointingDevice *touchMouseDevice = nullptr;
125 ulong touchMousePressTimestamp = 0;
126 QPoint touchMousePressPos; // in screen coordinates
127
128 QQuickDeliveryAgent::Transform *sceneTransform = nullptr;
129
130 bool isDeliveringTouchAsMouse() const { return touchMouseId != -1 && touchMouseDevice; }
131 void cancelTouchMouseSynthesis();
132
133 bool checkIfDoubleTapped(ulong newPressEventTimestamp, const QPoint &newPressPos);
134 void resetIfDoubleTapPrevented(const QEventPoint &pressedPoint);
135 QPointingDevicePrivate::EventPointData *mousePointData();
136 QPointerEvent *eventInDelivery() const;
137
138 // Mouse positions are saved in widget coordinates
139 QPointF lastMousePosition;
140 bool deliverTouchAsMouse(QQuickItem *item, QTouchEvent *pointerEvent);
141 static void translateTouchEvent(QTouchEvent *touchEvent);
142 void removeGrabber(QQuickItem *grabber, bool mouse = true, bool touch = true, bool cancel = false);
143 void clearGrabbers(QPointerEvent *pointerEvent);
144 void onGrabChanged(QObject *grabber, QPointingDevice::GrabTransition transition, const QPointerEvent *event, const QEventPoint &point);
145 static QPointerEvent *clonePointerEvent(QPointerEvent *event, std::optional<QPointF> transformedLocalPos = std::nullopt);
146 void deliverToPassiveGrabbers(const QList<QPointer<QObject> > &passiveGrabbers, QPointerEvent *pointerEvent);
147 bool sendFilteredMouseEvent(QEvent *event, QQuickItem *receiver, QQuickItem *filteringParent);
148 bool sendFilteredPointerEvent(QPointerEvent *event, QQuickItem *receiver, QQuickItem *filteringParent = nullptr);
149 bool sendFilteredPointerEventImpl(QPointerEvent *event, QQuickItem *receiver, QQuickItem *filteringParent);
150 bool deliverSinglePointEventUntilAccepted(QPointerEvent *);
151
152 // entry point of events to the window
153 void handleTouchEvent(QTouchEvent *);
154 void handleMouseEvent(QMouseEvent *);
155 bool compressTouchEvent(QTouchEvent *);
156 void flushFrameSynchronousEvents(QQuickWindow *win);
157 void deliverDelayedTouchEvent();
158 void handleWindowDeactivate(QQuickWindow *win);
159 void handleWindowHidden(QQuickWindow *win);
160
161 // utility functions that used to be in QQuickPointerEvent et al.
162 bool allUpdatedPointsAccepted(const QPointerEvent *ev);
163 static void localizePointerEvent(QPointerEvent *ev, const QQuickItem *dest);
164 QList<QObject *> exclusiveGrabbers(QPointerEvent *ev);
165 static bool anyPointGrabbed(const QPointerEvent *ev);
166 static bool allPointsGrabbed(const QPointerEvent *ev);
167 static bool isMouseEvent(const QPointerEvent *ev);
168 static bool isMouseOrWheelEvent(const QPointerEvent *ev);
169 static bool isHoverEvent(const QPointerEvent *ev);
170 static bool isHoveringMoveEvent(const QPointerEvent *ev);
171 static bool isTouchEvent(const QPointerEvent *ev);
172 static bool isTabletEvent(const QPointerEvent *ev);
173 static bool isEventFromMouseOrTouchpad(const QPointerEvent *ev);
174 static bool isSynthMouse(const QPointerEvent *ev);
175 static bool isWithinDoubleClickInterval(ulong timeInterval);
176 static bool isWithinDoubleTapDistance(const QPoint &distanceBetweenPresses);
177 static bool isSinglePointDevice(const QInputDevice *dev);
178 static QQuickPointingDeviceExtra *deviceExtra(const QInputDevice *device);
179
180 // delivery of pointer events:
181 void touchToMouseEvent(QEvent::Type type, const QEventPoint &p, const QTouchEvent *touchEvent, QMutableSinglePointEvent *mouseEvent);
182 void ensureDeviceConnected(const QPointingDevice *dev);
183 void deliverPointerEvent(QPointerEvent *);
184 bool deliverTouchCancelEvent(QTouchEvent *);
185 bool deliverPressOrReleaseEvent(QPointerEvent *, bool handlersOnly = false);
186 void deliverUpdatedPoints(QPointerEvent *event);
187 void deliverMatchingPointsToItem(QQuickItem *item, bool isGrabber, QPointerEvent *pointerEvent, bool handlersOnly = false);
188
189 QList<QQuickItem *> eventTargets(QQuickItem *, const QEvent *event, int pointId, QPointF localPos, QPointF scenePos,
190 qxp::function_ref<std::optional<bool> (QQuickItem *, const QEvent *)> predicate) const;
191 QList<QQuickItem *> pointerTargets(QQuickItem *, const QPointerEvent *event, const QEventPoint &point,
192 bool checkMouseButtons, bool checkAcceptsTouch) const;
193 QList<QQuickItem *> mergePointerTargets(const QList<QQuickItem *> &list1, const QList<QQuickItem *> &list2) const;
194
195 // hover delivery
196 enum class HoverChange : uint8_t {
197 Clear,
198 Set,
199 };
200 bool deliverHoverEvent(const QPointF &scenePos, const QPointF &lastScenePos, Qt::KeyboardModifiers modifiers, ulong timestamp);
201 bool deliverHoverEventRecursive(QQuickItem *, const QPointF &localPos,
202 const QPointF &scenePos, const QPointF &lastScenePos,
203 const QPointF &globalPos, Qt::KeyboardModifiers modifiers, ulong timestamp);
204 bool deliverHoverEventToItem(QQuickItem *item, const QPointF &localPos, const QPointF &scenePos,
205 const QPointF &lastScenePos, const QPointF &globalPos,
206 Qt::KeyboardModifiers modifiers, ulong timestamp,
207 HoverChange hoverChange);
208 bool sendHoverEvent(QEvent::Type, QQuickItem *, const QPointF &localPos, const QPointF &scenePos,
209 const QPointF &lastScenePos, const QPointF &globalPos,
210 Qt::KeyboardModifiers modifiers, ulong timestamp);
211 bool clearHover(ulong timestamp = 0);
212
213#if QT_CONFIG(quick_draganddrop)
214 void deliverDragEvent(QQuickDragGrabber *, QEvent *);
215 bool deliverDragEvent(QQuickDragGrabber *, QQuickItem *, QDragMoveEvent *,
216 QVarLengthArray<QQuickItem *, 64> *currentGrabItems = nullptr,
217 QObject *formerTarget = nullptr);
218#endif
219
220 static bool dragOverThreshold(qreal d, Qt::Axis axis, QMouseEvent *event, int startDragThreshold = -1);
221
222 static bool dragOverThreshold(qreal d, Qt::Axis axis, const QEventPoint &tp, int startDragThreshold = -1);
223
224 static bool dragOverThreshold(QVector2D delta);
225
226 // context menu events
227 QList<QQuickItem *> contextMenuTargets(QQuickItem *item, const QContextMenuEvent *event) const;
228 void deliverContextMenuEvent(QContextMenuEvent *event);
229};
230Q_DECLARE_TYPEINFO(QQuickDeliveryAgentPrivate::HoverItemState, Q_RELOCATABLE_TYPE);
231
232Q_DECLARE_OPERATORS_FOR_FLAGS(QQuickDeliveryAgentPrivate::FocusOptions)
233
234QT_END_NAMESPACE
235
236#endif // QQUICKDELIVERYAGENT_P_P_H