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 QtGui 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 QSIMPLEDRAG_P_H
41#define QSIMPLEDRAG_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtGui/private/qtguiglobal_p.h>
55#include <qpa/qplatformdrag.h>
56
57#include <QtCore/QObject>
58#include <QtCore/QPointer>
59#include <QtGui/QWindow>
60
61QT_REQUIRE_CONFIG(draganddrop);
62
63QT_BEGIN_NAMESPACE
64
65class QMouseEvent;
66class QEventLoop;
67class QDropData;
68class QShapedPixmapWindow;
69class QScreen;
70
71class Q_GUI_EXPORT QBasicDrag : public QPlatformDrag, public QObject
72{
73public:
74 ~QBasicDrag();
75
76 virtual Qt::DropAction drag(QDrag *drag) override;
77 void cancelDrag() override;
78
79 virtual bool eventFilter(QObject *o, QEvent *e) override;
80
81protected:
82 QBasicDrag();
83
84 virtual void startDrag();
85 virtual void cancel();
86 virtual void move(const QPoint &globalPos, Qt::MouseButtons b, Qt::KeyboardModifiers mods) = 0;
87 virtual void drop(const QPoint &globalPos, Qt::MouseButtons b, Qt::KeyboardModifiers mods) = 0;
88 virtual void endDrag();
89
90
91 void moveShapedPixmapWindow(const QPoint &deviceIndependentPosition);
92 QShapedPixmapWindow *shapedPixmapWindow() const { return m_drag_icon_window; }
93 void recreateShapedPixmapWindow(QScreen *screen, const QPoint &pos);
94 void updateCursor(Qt::DropAction action);
95
96 bool canDrop() const { return m_can_drop; }
97 void setCanDrop(bool c) { m_can_drop = c; }
98
99 bool useCompositing() const { return m_useCompositing; }
100 void setUseCompositing(bool on) { m_useCompositing = on; }
101
102 void setScreen(QScreen *screen) { m_screen = screen; }
103
104 Qt::DropAction executedDropAction() const { return m_executed_drop_action; }
105 void setExecutedDropAction(Qt::DropAction da) { m_executed_drop_action = da; }
106
107 QDrag *drag() const { return m_drag; }
108
109protected:
110 QWindow *m_sourceWindow = nullptr;
111 QPointer<QWindow> m_windowUnderCursor = nullptr;
112
113private:
114 void enableEventFilter();
115 void disableEventFilter();
116 void restoreCursor();
117 void exitDndEventLoop();
118
119#ifndef QT_NO_CURSOR
120 bool m_dndHasSetOverrideCursor = false;
121#endif
122 QEventLoop *m_eventLoop = nullptr;
123 Qt::DropAction m_executed_drop_action = Qt::IgnoreAction;
124 bool m_can_drop = false;
125 QDrag *m_drag = nullptr;
126 QShapedPixmapWindow *m_drag_icon_window = nullptr;
127 bool m_useCompositing = true;
128 QScreen *m_screen = nullptr;
129};
130
131class Q_GUI_EXPORT QSimpleDrag : public QBasicDrag
132{
133public:
134 QSimpleDrag();
135
136protected:
137 virtual void startDrag() override;
138 virtual void cancel() override;
139 virtual void move(const QPoint &globalPos, Qt::MouseButtons b, Qt::KeyboardModifiers mods) override;
140 virtual void drop(const QPoint &globalPos, Qt::MouseButtons b, Qt::KeyboardModifiers mods) override;
141};
142
143QT_END_NAMESPACE
144
145#endif
146