aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/items/qquickdroparea_p.h
blob: e9fff0afa051e552cc4525ef388f418f8336406f (plain)
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#ifndef QQUICKDROPAREA_P_H
#define QQUICKDROPAREA_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <private/qtquickglobal_p.h>

#include <QtQuick/qquickitem.h>

#include <QtGui/qevent.h>

QT_REQUIRE_CONFIG(quick_draganddrop);

QT_BEGIN_NAMESPACE

class QQuickDropAreaPrivate;
class QQuickDragEvent : public QObject
{
    Q_OBJECT
    Q_PROPERTY(qreal x READ x FINAL)
    Q_PROPERTY(qreal y READ y FINAL)
    Q_PROPERTY(QObject *source READ source FINAL)
    Q_PROPERTY(QStringList keys READ keys FINAL)
    Q_PROPERTY(Qt::DropActions supportedActions READ supportedActions FINAL)
    Q_PROPERTY(Qt::DropActions proposedAction READ proposedAction FINAL)
    Q_PROPERTY(Qt::DropAction action READ action WRITE setAction RESET resetAction FINAL)
    Q_PROPERTY(bool accepted READ accepted WRITE setAccepted FINAL)
    Q_PROPERTY(bool hasColor READ hasColor FINAL)
    Q_PROPERTY(bool hasHtml READ hasHtml FINAL)
    Q_PROPERTY(bool hasText READ hasText FINAL)
    Q_PROPERTY(bool hasUrls READ hasUrls FINAL)
    Q_PROPERTY(QVariant colorData READ colorData FINAL)
    Q_PROPERTY(QString html READ html FINAL)
    Q_PROPERTY(QString text READ text FINAL)
    Q_PROPERTY(QList<QUrl> urls READ urls FINAL)
    Q_PROPERTY(QStringList formats READ formats FINAL)
    QML_NAMED_ELEMENT(DragEvent)
    QML_UNCREATABLE("DragEvent is only meant to be created by DropArea")
    QML_ADDED_IN_VERSION(2, 0)
public:
    QQuickDragEvent(QQuickDropAreaPrivate *d, QDropEvent *event) : d(d), event(event) {}

    qreal x() const { return event->position().x(); }
    qreal y() const { return event->position().y(); }

    QObject *source() const;

    Qt::DropActions supportedActions() const { return event->possibleActions(); }
    Qt::DropActions proposedAction() const { return event->proposedAction(); }
    Qt::DropAction action() const { return event->dropAction(); }
    void setAction(Qt::DropAction action) { event->setDropAction(action); }
    void resetAction() { event->setDropAction(event->proposedAction()); }

    QStringList keys() const;

    bool accepted() const { return event->isAccepted(); }
    void setAccepted(bool accepted) { event->setAccepted(accepted); }

    bool hasColor() const;
    bool hasHtml() const;
    bool hasText() const;
    bool hasUrls() const;
    QVariant colorData() const;
    QString html() const;
    QString text() const;
    QList<QUrl> urls() const;
    QStringList formats() const;

    Q_INVOKABLE QString getDataAsString(const QString &format) const;
    Q_INVOKABLE QByteArray getDataAsArrayBuffer(const QString &format) const;
    Q_INVOKABLE void acceptProposedAction();
    Q_INVOKABLE void accept();
    Q_INVOKABLE void accept(Qt::DropAction action);

private:
    QQuickDropAreaPrivate *d;
    QDropEvent *event;
};

class QQuickDropAreaDrag : public QObject
{
    Q_OBJECT
    Q_PROPERTY(qreal x READ x NOTIFY positionChanged FINAL)
    Q_PROPERTY(qreal y READ y NOTIFY positionChanged FINAL)
    Q_PROPERTY(QObject *source READ source NOTIFY sourceChanged FINAL)
    QML_ANONYMOUS
    QML_ADDED_IN_VERSION(2, 0)
public:
    QQuickDropAreaDrag(QQuickDropAreaPrivate *d, QObject *parent = nullptr);
    ~QQuickDropAreaDrag();

    qreal x() const;
    qreal y() const;
    QObject *source() const;

Q_SIGNALS:
    void positionChanged();
    void sourceChanged();

private:
    QQuickDropAreaPrivate *d;

    friend class QQuickDropArea;
    friend class QQuickDropAreaPrivate;
};

class QQuickDropAreaPrivate;
class Q_QUICK_EXPORT QQuickDropArea : public QQuickItem
{
    Q_OBJECT
    Q_PROPERTY(bool containsDrag READ containsDrag NOTIFY containsDragChanged)
    Q_PROPERTY(QStringList keys READ keys WRITE setKeys NOTIFY keysChanged)
    Q_PROPERTY(QQuickDropAreaDrag *drag READ drag CONSTANT)
    QML_NAMED_ELEMENT(DropArea)
    QML_ADDED_IN_VERSION(2, 0)

public:
    QQuickDropArea(QQuickItem *parent=0);
    ~QQuickDropArea();

    bool containsDrag() const;
    void setContainsDrag(bool drag);

    QStringList keys() const;
    void setKeys(const QStringList &keys);

    QQuickDropAreaDrag *drag();

Q_SIGNALS:
    void containsDragChanged();
    void keysChanged();
    void sourceChanged();

    void entered(QQuickDragEvent *drag);
    void exited();
    void positionChanged(QQuickDragEvent *drag);
    void dropped(QQuickDragEvent *drop);

protected:
    void dragMoveEvent(QDragMoveEvent *event) override;
    void dragEnterEvent(QDragEnterEvent *event) override;
    void dragLeaveEvent(QDragLeaveEvent *event) override;
    void dropEvent(QDropEvent *event) override;

private:
    Q_DISABLE_COPY(QQuickDropArea)
    Q_DECLARE_PRIVATE(QQuickDropArea)
};

QT_END_NAMESPACE

#endif // QQUICKDROPAREA_P_H