1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the Qt Quick Extras module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef MOUSETHIEF_H
41 #define MOUSETHIEF_H
42 
43 #include <QObject>
44 #include <QPointer>
45 #include <QtQuick/QQuickItem>
46 
47 class QQuickMouseThief : public QObject
48 {
49     Q_OBJECT
50     Q_PROPERTY(bool receivedPressEvent READ receivedPressEvent
51         WRITE setReceivedPressEvent NOTIFY receivedPressEventChanged)
52 public:
53     explicit QQuickMouseThief(QObject *parent = 0);
54 
55     bool receivedPressEvent() const;
56     void setReceivedPressEvent(bool receivedPressEvent);
57 
58     Q_INVOKABLE void grabMouse(QQuickItem *item);
59     Q_INVOKABLE void ungrabMouse();
60     Q_INVOKABLE void acceptCurrentEvent();
61 signals:
62     /*!
63         Coordinates are relative to the window of mItem.
64     */
65     void pressed(int mouseX, int mouseY);
66 
67     void released(int mouseX, int mouseY);
68 
69     void clicked(int mouseX, int mouseY);
70 
71     void touchUpdate(int mouseX, int mouseY);
72 
73     void receivedPressEventChanged();
74 
75     void handledEventChanged();
76 protected:
77     bool eventFilter(QObject *obj, QEvent *event) override;
78 private slots:
79     void itemWindowChanged(QQuickWindow *window);
80 private:
81     void emitPressed(const QPointF &pos);
82     void emitReleased(const QPointF &pos);
83     void emitClicked(const QPointF &pos);
84 
85     QPointer<QQuickItem> mItem;
86     bool mReceivedPressEvent;
87     bool mAcceptCurrentEvent;
88 };
89 
90 #endif // MOUSETHIEF_H
91