8400d7a23d9367cd4e1108cf01b788ac4717aaa6
[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 File;
40 class Pasteboard;
41
42 class DataTransfer : public RefCounted<DataTransfer> {
43 public:
44     // https://html.spec.whatwg.org/multipage/dnd.html#drag-data-store-mode
45     enum class StoreMode { Invalid, ReadWrite, Readonly, Protected };
46
47     static Ref<DataTransfer> createForCopyAndPaste(StoreMode, std::unique_ptr<Pasteboard>&&);
48     static Ref<DataTransfer> createForInputEvent(const String& plainText, const String& htmlText);
49
50     WEBCORE_EXPORT ~DataTransfer();
51
52     String dropEffect() const;
53     void setDropEffect(const String&);
54
55     String effectAllowed() const;
56     void setEffectAllowed(const String&);
57
58     DataTransferItemList& items();
59     Vector<String> types() const;
60
61     FileList& files() const;
62
63     void clearData(const String& type = String());
64
65     String getData(const String& type) const;
66
67     void setData(const String& type, const String& data);
68     void setDataFromItemList(const String& type, const String& data);
69
70     void setDragImage(Element*, int x, int y);
71
72     void makeInvalidForSecurity() { m_storeMode = StoreMode::Invalid; }
73
74     bool canReadTypes() const;
75     bool canReadData() const;
76     bool canWriteData() const;
77
78     bool hasFileOfType(const String&);
79     bool hasStringOfType(const String&);
80
81     Pasteboard& pasteboard() { return *m_pasteboard; }
82
83 #if ENABLE(DRAG_SUPPORT)
84     static Ref<DataTransfer> createForDrag();
85     static Ref<DataTransfer> createForDragStartEvent();
86     static Ref<DataTransfer> createForDrop(StoreMode, const DragData&);
87
88     bool dropEffectIsUninitialized() const { return m_dropEffect == "uninitialized"; }
89
90     DragOperation sourceOperation() const;
91     DragOperation destinationOperation() const;
92     void setSourceOperation(DragOperation);
93     void setDestinationOperation(DragOperation);
94
95     void setDragHasStarted() { m_shouldUpdateDragImage = true; }
96     DragImageRef createDragImage(IntPoint& dragLocation) const;
97     void updateDragImage();
98     RefPtr<Element> dragImageElement() const;
99
100     void moveDragState(Ref<DataTransfer>&&);
101     bool hasDragImage() const;
102 #endif
103
104     void didAddFileToItemList();
105     void updateFileList();
106
107 private:
108     enum class Type { CopyAndPaste, DragAndDropData, DragAndDropFiles, InputEvent };
109     DataTransfer(StoreMode, std::unique_ptr<Pasteboard>, Type = Type::CopyAndPaste);
110
111 #if ENABLE(DRAG_SUPPORT)
112     bool forDrag() const { return m_type == Type::DragAndDropData || m_type == Type::DragAndDropFiles; }
113     bool forFileDrag() const { return m_type == Type::DragAndDropFiles; }
114 #else
115     bool forDrag() const { return false; }
116     bool forFileDrag() const { return false; }
117 #endif
118
119     Vector<Ref<File>> filesFromPasteboardAndItemList() const;
120
121     StoreMode m_storeMode;
122     std::unique_ptr<Pasteboard> m_pasteboard;
123     std::unique_ptr<DataTransferItemList> m_itemList;
124
125     mutable RefPtr<FileList> m_fileList;
126
127 #if ENABLE(DRAG_SUPPORT)
128     Type m_type;
129     String m_dropEffect;
130     String m_effectAllowed;
131     bool m_shouldUpdateDragImage;
132     IntPoint m_dragLocation;
133     CachedResourceHandle<CachedImage> m_dragImage;
134     RefPtr<Element> m_dragImageElement;
135     std::unique_ptr<DragImageLoader> m_dragImageLoader;
136 #endif
137 };
138
139 } // namespace WebCore