dd8438a5cf62819d871bbaa2d4b03e32191dc590
[WebKit-https.git] / Source / WebCore / dom / DataTransfer.h
1 /*
2  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
3  * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
4  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
5  * Copyright (C) 2003-2016 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #pragma once
25
26 #include "CachedResourceHandle.h"
27 #include "DragActions.h"
28 #include "DragImage.h"
29 #include <wtf/text/WTFString.h>
30
31 namespace WebCore {
32
33 class CachedImage;
34 class DataTransferItemList;
35 class DragData;
36 class DragImageLoader;
37 class Element;
38 class FileList;
39 class Pasteboard;
40
41 class DataTransfer : public RefCounted<DataTransfer> {
42 public:
43     // https://html.spec.whatwg.org/multipage/dnd.html#drag-data-store-mode
44     enum class StoreMode { Invalid, DragImageWritable, ReadWrite, Readonly, Protected };
45
46     static Ref<DataTransfer> createForCopyAndPaste(StoreMode);
47     static Ref<DataTransfer> createForInputEvent(const String& plainText, const String& htmlText);
48
49     WEBCORE_EXPORT ~DataTransfer();
50
51     String dropEffect() const;
52     void setDropEffect(const String&);
53
54     String effectAllowed() const;
55     void setEffectAllowed(const String&);
56
57     DataTransferItemList& items();
58     Vector<String> types() const;
59
60     FileList& files() const;
61
62     void clearData(const String& type = String());
63
64     String getData(const String& type) const;
65
66     void setData(const String& type, const String& data);
67
68     void setDragImage(Element*, int x, int y);
69
70     void makeInvalidForSecurity() { m_storeMode = StoreMode::Invalid; }
71     void makeDragImageWritable()
72     {
73         ASSERT(m_storeMode != StoreMode::Invalid);
74         m_storeMode = StoreMode::DragImageWritable;
75     }
76
77     bool canReadTypes() const;
78     bool canReadData() const;
79     bool canWriteData() const;
80
81     bool hasFileOfType(const String&);
82     bool hasStringOfType(const String&);
83
84     Pasteboard& pasteboard() { return *m_pasteboard; }
85
86 #if ENABLE(DRAG_SUPPORT)
87     static Ref<DataTransfer> createForDrag();
88     static Ref<DataTransfer> createForDrop(StoreMode, const DragData&);
89
90     bool dropEffectIsUninitialized() const { return m_dropEffect == "uninitialized"; }
91
92     DragOperation sourceOperation() const;
93     DragOperation destinationOperation() const;
94     void setSourceOperation(DragOperation);
95     void setDestinationOperation(DragOperation);
96
97     void setDragHasStarted() { m_shouldUpdateDragImage = true; }
98     DragImageRef createDragImage(IntPoint& dragLocation) const;
99     void updateDragImage();
100 #endif
101
102 private:
103     enum class Type { CopyAndPaste, DragAndDropData, DragAndDropFiles, InputEvent };
104     DataTransfer(StoreMode, std::unique_ptr<Pasteboard>, Type = Type::CopyAndPaste);
105
106 #if ENABLE(DRAG_SUPPORT)
107     bool canSetDragImage() const;
108 #endif
109
110     StoreMode m_storeMode;
111     std::unique_ptr<Pasteboard> m_pasteboard;
112     std::unique_ptr<DataTransferItemList> m_itemList;
113
114     mutable RefPtr<FileList> m_fileList;
115
116 #if ENABLE(DRAG_SUPPORT)
117     bool m_forDrag;
118     bool m_forFileDrag;
119     String m_dropEffect;
120     String m_effectAllowed;
121     bool m_shouldUpdateDragImage;
122     IntPoint m_dragLocation;
123     CachedResourceHandle<CachedImage> m_dragImage;
124     RefPtr<Element> m_dragImageElement;
125     std::unique_ptr<DragImageLoader> m_dragImageLoader;
126 #endif
127 };
128
129 } // namespace WebCore