Add DataTransferItems support for drag-and-drop'ed files and texts
[WebKit-https.git] / Source / WebCore / platform / chromium / ClipboardChromium.h
1 // Copyright (c) 2008, Google Inc.
2 // All rights reserved.
3 // 
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 // 
8 //     * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 //     * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
13 // distribution.
14 //     * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
17 // 
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 #ifndef ClipboardChromium_h
31 #define ClipboardChromium_h
32
33 #include "CachedImage.h"
34 #include "ChromiumDataObject.h"
35 #include "Clipboard.h"
36
37 namespace WebCore {
38
39     class CachedImage;
40     class ChromiumDataObject;
41     class DataTransferItem;
42     class DataTransferItemListChromium;
43     class Frame;
44     class IntPoint;
45
46     class ClipboardChromium : public Clipboard, public CachedImageClient {
47         WTF_MAKE_FAST_ALLOCATED;
48     public:
49         ~ClipboardChromium();
50
51         static PassRefPtr<ClipboardChromium> create(
52             ClipboardType, PassRefPtr<ChromiumDataObject>, ClipboardAccessPolicy, Frame*);
53
54         // Returns the file name (not including the extension). This removes any
55         // invalid file system characters as well as making sure the
56         // path + extension is not bigger than allowed by the file system.
57         // This may change the file extension in dataObject.
58         static String validateFileName(const String& title, ChromiumDataObject* dataObject);
59
60         virtual void clearData(const String& type);
61         void clearAllData();
62         String getData(const String& type, bool& success) const;
63         bool setData(const String& type, const String& data);
64         bool platformClipboardChanged() const;
65
66         // extensions beyond IE's API
67         virtual HashSet<String> types() const;
68         virtual PassRefPtr<FileList> files() const;
69
70         void setDragImage(CachedImage*, const IntPoint&);
71         void setDragImageElement(Node*, const IntPoint&);
72
73         PassRefPtr<ChromiumDataObject> dataObject()
74         {
75             return m_dataObject;
76         }
77
78         virtual DragImageRef createDragImage(IntPoint& dragLoc) const;
79         virtual void declareAndWriteDragImage(Element*, const KURL&, const String& title, Frame*);
80         virtual void writeURL(const KURL&, const String&, Frame*);
81         virtual void writeRange(Range*, Frame*);
82         virtual void writePlainText(const String&);
83
84         virtual bool hasData();
85
86 #if ENABLE(DATA_TRANSFER_ITEMS)
87         virtual PassRefPtr<DataTransferItemList> items();
88
89         // Internal routines to keep the list returned by items() (i.e. m_itemList) synchronized with the content of the clipboard data.
90         void mayUpdateItems(Vector<RefPtr<DataTransferItem> >& items);
91         bool storageHasUpdated() const;
92 #endif
93
94     private:
95         ClipboardChromium(ClipboardType, PassRefPtr<ChromiumDataObject>, ClipboardAccessPolicy, Frame*);
96
97         void resetFromClipboard();
98         void setDragImage(CachedImage*, Node*, const IntPoint&);
99         RefPtr<ChromiumDataObject> m_dataObject;
100         Frame* m_frame;
101
102 #if ENABLE(DATA_TRANSFER_ITEMS)
103         RefPtr<DataTransferItemListChromium> m_itemList;
104 #endif
105
106         uint64_t m_originalSequenceNumber;
107         bool m_dragStorageUpdated;
108     };
109
110 } // namespace WebCore
111
112 #endif // ClipboardChromium_h