Clipboard::getData should return an empty string instead of undefined
[WebKit-https.git] / Source / WebCore / platform / win / ClipboardWin.h
1 /*
2  * Copyright (C) 2006, 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 ClipboardWin_h
27 #define ClipboardWin_h
28
29 #include "COMPtr.h"
30 #include "CachedImage.h"
31 #include "Clipboard.h"
32 #include "DragData.h"
33
34 struct IDataObject;
35
36 namespace WebCore {
37
38 class CachedImage;
39 class Frame;
40 class IntPoint;
41 class WCDataObject;
42
43 // State available during IE's events for drag and drop and copy/paste
44 class ClipboardWin : public Clipboard, public CachedImageClient {
45     WTF_MAKE_FAST_ALLOCATED;
46 public:
47     static PassRefPtr<ClipboardWin> create(ClipboardType clipboardType, IDataObject* dataObject, ClipboardAccessPolicy policy, Frame* frame)
48     {
49         return adoptRef(new ClipboardWin(clipboardType, dataObject, policy, frame));
50     }
51     static PassRefPtr<ClipboardWin> create(ClipboardType clipboardType, WCDataObject* dataObject, ClipboardAccessPolicy policy, Frame* frame)
52     {
53         return adoptRef(new ClipboardWin(clipboardType, dataObject, policy, frame));
54     }
55     static PassRefPtr<ClipboardWin> create(ClipboardType clipboardType, const DragDataMap& dataMap, ClipboardAccessPolicy policy, Frame* frame)
56     {
57         return adoptRef(new ClipboardWin(clipboardType, dataMap, policy, frame));
58     }
59     ~ClipboardWin();
60
61     void clearData(const String& type);
62     void clearAllData();
63     String getData(const String& type) const;
64     bool setData(const String& type, const String& data);
65
66     // extensions beyond IE's API
67     virtual PassRefPtr<DOMStringList> types() const;
68     virtual PassRefPtr<FileList> files() const;
69
70     void setDragImage(CachedImage*, const IntPoint&);
71     void setDragImageElement(Node*, const IntPoint&);
72
73     virtual DragImageRef createDragImage(IntPoint& dragLoc) const;
74     virtual void declareAndWriteDragImage(Element*, const KURL&, const String& title, Frame*);
75     virtual void writeURL(const KURL&, const String&, Frame*);
76     virtual void writeRange(Range*, Frame*);
77     virtual void writePlainText(const String&);
78
79     virtual bool hasData();
80
81     COMPtr<IDataObject> dataObject() { return m_dataObject; }
82
83     void setExternalDataObject(IDataObject *dataObject);
84
85 private:
86     ClipboardWin(ClipboardType, IDataObject*, ClipboardAccessPolicy, Frame*);
87     ClipboardWin(ClipboardType, WCDataObject*, ClipboardAccessPolicy, Frame*);
88     ClipboardWin(ClipboardType, const DragDataMap&, ClipboardAccessPolicy, Frame*);
89
90     void resetFromClipboard();
91     void setDragImage(CachedImage*, Node*, const IntPoint&);
92
93     COMPtr<IDataObject> m_dataObject;
94     COMPtr<WCDataObject> m_writableDataObject;
95     DragDataMap m_dragDataMap;
96     Frame* m_frame;
97 };
98
99 } // namespace WebCore
100
101 #endif // ClipboardWin_h