1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/*
SPDX-FileCopyrightText: 2021 David Edmundson <davidedmundson@kde.org>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#pragma once
#include <QGuiApplication>
#include <QQuickItem>
#include <QTimer>
#include <optional>
/**
* This class filters child mouse events that move from a current location towards a given edge.
*
* The primary use-case being where we have a list of actions that trigger on hover on one side
* adjacent to a large hit area where a user will want to interact with.
*
* Without this filter a user moving their mouse towards the target area will trigger other hover events
*
* This item distinguishes mouse moves towards an edge from attempts to select another item in the combo
* tree.
*
* See: https://bjk5.com/post/44698559168/breaking-down-amazons-mega-dropdown
*/
class TriangleMouseFilter : public QQuickItem
{
Q_OBJECT
/**
* Whether the filter is active. If false, all events will be passed through. True by default.
*/
Q_PROPERTY(bool active MEMBER m_active NOTIFY activeChanged)
/**
* The timeout in ms after which the filter is disabled and the current item is selected
* regardless.
*
* The default is 300
* Setting a negative value disables the timeout
*/
Q_PROPERTY(int filterTimeOut MEMBER m_filterTimeout NOTIFY filterTimoutChanged)
/**
* The edge that we want to filter mouse actions towards.
* i.e if we have a listview on the left with a submenu on the right, the value
* will be Qt.RightEdge
*
* RTL configurations must be handled explicitly by the caller
*/
Q_PROPERTY(Qt::Edge edge MEMBER m_edge NOTIFY edgeChanged)
/**
* The line (as two points) representing the geometry of the edge we want to filter mouse actions towards,
* relative to the filtered item. This property is a QVector of x1, y1, x2, y2 instead of a QLine
* for ease of use from QML which does not have a line basic type. If edgeLine is not set or is set to
* anything other than a vector of 4 ints, the edge of the applet will be used instead.
*/
Q_PROPERTY(QVector<int> edgeLine MEMBER m_edgeLine NOTIFY edgeLineChanged)
/**
* Whether the filter will block the first hover enter event. False by default.
*/
Q_PROPERTY(bool blockFirstEnter MEMBER m_blockFirstEnter NOTIFY blockFirstEnterChanged)
/**
* A secondary starting point (other than the interception point) to also check for mouse position.
* Not considered if it has the value (0, 0). Default value (0, 0)
*/
Q_PROPERTY(QPointF secondaryPoint MEMBER m_secondaryPoint NOTIFY secondaryPointChanged)
public:
TriangleMouseFilter(QQuickItem *parent = nullptr);
~TriangleMouseFilter() = default;
Q_SIGNALS:
void filterTimoutChanged();
void edgeChanged();
void edgeLineChanged();
void activeChanged();
void blockFirstEnterChanged();
void secondaryPointChanged();
protected:
bool childMouseEventFilter(QQuickItem *item, QEvent *event) override;
private:
bool filterContains(const QPointF &p) const;
QTimer m_resetTimer;
std::optional<QPointF> m_interceptionPos; // point where we started intercepting
QPointF m_lastCursorPosition;
QPointer<QQuickItem> m_interceptedHoverItem; // item newly entered but the enter event was intercepted
std::optional<QPointF> m_interceptedHoverEnterPosition; // position of intercepted enter events
Qt::Edge m_edge = Qt::RightEdge;
QVector<int> m_edgeLine;
int m_filterTimeout = 300;
bool m_active;
bool m_blockFirstEnter;
bool m_usingCustomEdgeLine;
QPointF m_secondaryPoint;
};
|
