Consider replacing return type of Clipboard::types() from ListHashSet<String> to...
[WebKit-https.git] / Source / WebCore / platform / qt / ClipboardQt.h
1 /*
2  * Copyright (C) 2007, 2008 Apple Inc. 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef ClipboardQt_h
27 #define ClipboardQt_h
28
29 #include "CachedImageClient.h"
30 #include "Clipboard.h"
31
32 QT_BEGIN_NAMESPACE
33 class QMimeData;
34 QT_END_NAMESPACE
35
36 namespace WebCore {
37
38 class CachedImage;
39
40 // State available during IE's events for drag and drop and copy/paste
41 class ClipboardQt : public Clipboard, public CachedImageClient {
42     WTF_MAKE_FAST_ALLOCATED;
43 public:
44     static PassRefPtr<ClipboardQt> create(ClipboardAccessPolicy policy, const QMimeData* readableClipboard, Frame* frame)
45     {
46         return adoptRef(new ClipboardQt(policy, readableClipboard, frame));
47     }
48     static PassRefPtr<ClipboardQt> create(ClipboardAccessPolicy policy, Frame *frame, ClipboardType clipboardType = CopyAndPaste)
49     {
50         return adoptRef(new ClipboardQt(policy, clipboardType, frame));
51     }
52     virtual ~ClipboardQt();
53
54     void clearData(const String& type);
55     void clearAllData();
56     String getData(const String& type) const;
57     bool setData(const String& type, const String& data);
58
59     // extensions beyond IE's API
60     virtual Vector<String> types() const;
61     virtual PassRefPtr<FileList> files() const;
62
63     void setDragImage(CachedImage*, const IntPoint&);
64     void setDragImageElement(Node*, const IntPoint&);
65
66     virtual DragImageRef createDragImage(IntPoint& dragLoc) const;
67     virtual void declareAndWriteDragImage(Element*, const KURL&, const String& title, Frame*);
68     virtual void writeURL(const KURL&, const String&, Frame*);
69     virtual void writeRange(Range*, Frame*);
70     virtual void writePlainText(const String&);
71
72     virtual bool hasData();
73
74     QMimeData* clipboardData() const { return m_writableData; }
75     void invalidateWritableData() { m_writableData = 0; }
76
77 #if ENABLE(DATA_TRANSFER_ITEMS)
78     virtual PassRefPtr<DataTransferItemList> items();
79 #endif
80
81 private:
82     ClipboardQt(ClipboardAccessPolicy, const QMimeData* readableClipboard, Frame*);
83
84     // Clipboard is writable so it will create its own QMimeData object
85     ClipboardQt(ClipboardAccessPolicy, ClipboardType, Frame*);
86
87     void setDragImage(CachedImage*, Node*, const IntPoint& loc);
88
89     const QMimeData* m_readableData;
90     QMimeData* m_writableData;
91     Frame* m_frame;
92 };
93 }
94
95 #endif // ClipboardQt_h