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 QDRAG_H
41 #define QDRAG_H
42 
43 #include <QtGui/qtguiglobal.h>
44 #include <QtCore/qobject.h>
45 
46 QT_REQUIRE_CONFIG(draganddrop);
47 
48 QT_BEGIN_NAMESPACE
49 
50 class QMimeData;
51 class QDragPrivate;
52 class QPixmap;
53 class QPoint;
54 class QDragManager;
55 
56 
57 class Q_GUI_EXPORT QDrag : public QObject
58 {
59     Q_OBJECT
60     Q_DECLARE_PRIVATE(QDrag)
61 public:
62     explicit QDrag(QObject *dragSource);
63     ~QDrag();
64 
65     void setMimeData(QMimeData *data);
66     QMimeData *mimeData() const;
67 
68     void setPixmap(const QPixmap &);
69     QPixmap pixmap() const;
70 
71     void setHotSpot(const QPoint &hotspot);
72     QPoint hotSpot() const;
73 
74     QObject *source() const;
75     QObject *target() const;
76 
77 #if QT_DEPRECATED_SINCE(5, 13)
78     QT_DEPRECATED_X("Use QDrag::exec() instead")
79     Qt::DropAction start(Qt::DropActions supportedActions = Qt::CopyAction);
80 #endif
81     Qt::DropAction exec(Qt::DropActions supportedActions = Qt::MoveAction);
82     Qt::DropAction exec(Qt::DropActions supportedActions, Qt::DropAction defaultAction);
83 
84     void setDragCursor(const QPixmap &cursor, Qt::DropAction action);
85     QPixmap dragCursor(Qt::DropAction action) const;
86 
87     Qt::DropActions supportedActions() const;
88     Qt::DropAction defaultAction() const;
89 
90     static void cancel();
91 
92 Q_SIGNALS:
93     void actionChanged(Qt::DropAction action);
94     void targetChanged(QObject *newTarget);
95 
96 private:
97     friend class QDragManager;
98     Q_DISABLE_COPY(QDrag)
99 };
100 
101 QT_END_NAMESPACE
102 
103 #endif // QDRAG_H
104