Unreviewed, rolling out r126169.
[WebKit-https.git] / Source / WebCore / platform / DragData.h
1 /*
2  * Copyright (C) 2007 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 DragData_h
27 #define DragData_h
28
29 #include "Color.h"
30 #include "DragActions.h"
31 #include "IntPoint.h"
32
33 #include <wtf/Forward.h>
34 #include <wtf/HashMap.h>
35 #include <wtf/Vector.h>
36
37 #if PLATFORM(MAC)
38 #include <wtf/RetainPtr.h>
39 #include <wtf/text/WTFString.h>
40
41 #ifdef __OBJC__ 
42 #import <Foundation/Foundation.h>
43 #import <AppKit/NSDragging.h>
44 typedef id <NSDraggingInfo> DragDataRef;
45 #else
46 typedef void* DragDataRef;
47 #endif
48
49 #elif PLATFORM(QT)
50 QT_BEGIN_NAMESPACE
51 class QMimeData;
52 QT_END_NAMESPACE
53 typedef const QMimeData* DragDataRef;
54 #elif PLATFORM(WIN)
55 typedef struct IDataObject* DragDataRef;
56 #include <wtf/text/WTFString.h>
57 #elif PLATFORM(WX)
58 typedef class wxDataObject* DragDataRef;
59 #elif PLATFORM(GTK)
60 namespace WebCore {
61 class DataObjectGtk;
62 }
63 typedef WebCore::DataObjectGtk* DragDataRef;
64 #elif PLATFORM(CHROMIUM)
65 #include "DragDataRef.h"
66 #elif PLATFORM(EFL) || PLATFORM(BLACKBERRY)
67 typedef void* DragDataRef;
68 #endif
69
70
71 namespace WebCore {
72
73 class Frame;
74 class DocumentFragment;
75 class KURL;
76 class Range;
77
78 enum DragApplicationFlags {
79     DragApplicationNone = 0,
80     DragApplicationIsModal = 1,
81     DragApplicationIsSource = 2,
82     DragApplicationHasAttachedSheet = 4,
83     DragApplicationIsCopyKeyDown = 8
84 };
85
86 #if PLATFORM(WIN)
87 typedef HashMap<UINT, Vector<String> > DragDataMap;
88 #endif
89
90 class DragData {
91 public:
92     enum FilenameConversionPolicy { DoNotConvertFilenames, ConvertFilenames };
93
94     // clientPosition is taken to be the position of the drag event within the target window, with (0,0) at the top left
95     DragData(DragDataRef, const IntPoint& clientPosition, const IntPoint& globalPosition, DragOperation, DragApplicationFlags = DragApplicationNone);
96     DragData(const String& dragStorageName, const IntPoint& clientPosition, const IntPoint& globalPosition, DragOperation, DragApplicationFlags = DragApplicationNone);
97 #if PLATFORM(WIN)
98     DragData(const DragDataMap&, const IntPoint& clientPosition, const IntPoint& globalPosition, DragOperation sourceOperationMask, DragApplicationFlags = DragApplicationNone);
99     const DragDataMap& dragDataMap();
100     void getDragFileDescriptorData(int& size, String& pathname);
101     void getDragFileContentData(int size, void* dataBlob);
102 #endif
103     const IntPoint& clientPosition() const { return m_clientPosition; }
104     const IntPoint& globalPosition() const { return m_globalPosition; }
105     DragApplicationFlags flags() const { return m_applicationFlags; }
106     DragDataRef platformData() const { return m_platformDragData; }
107     DragOperation draggingSourceOperationMask() const { return m_draggingSourceOperationMask; }
108     bool containsURL(Frame*, FilenameConversionPolicy filenamePolicy = ConvertFilenames) const;
109     bool containsPlainText() const;
110     bool containsCompatibleContent() const;
111     String asURL(Frame*, FilenameConversionPolicy filenamePolicy = ConvertFilenames, String* title = 0) const;
112     String asPlainText(Frame*) const;
113     void asFilenames(Vector<String>&) const;
114     Color asColor() const;
115     PassRefPtr<DocumentFragment> asFragment(Frame*, PassRefPtr<Range> context,
116                                             bool allowPlainText, bool& chosePlainText) const;
117     bool canSmartReplace() const;
118     bool containsColor() const;
119     bool containsFiles() const;
120     unsigned numberOfFiles() const;
121     int modifierKeyState() const;
122 #if PLATFORM(MAC)
123     const String& pasteboardName() { return m_pasteboardName; }
124 #endif
125
126 #if ENABLE(FILE_SYSTEM)
127     String droppedFileSystemId() const;
128 #endif
129
130 #if PLATFORM(QT) || PLATFORM(GTK)
131     // This constructor should used only by WebKit2 IPC because DragData
132     // is initialized by the decoder and not in the constructor.
133     DragData() { }
134
135     DragData& operator =(const DragData& data)
136     {
137         m_clientPosition = data.m_clientPosition;
138         m_globalPosition = data.m_globalPosition;
139         m_platformDragData = data.m_platformDragData;
140         m_draggingSourceOperationMask = data.m_draggingSourceOperationMask;
141         m_applicationFlags = data.m_applicationFlags;
142         return *this;
143     }
144 #endif
145
146 private:
147     IntPoint m_clientPosition;
148     IntPoint m_globalPosition;
149     DragDataRef m_platformDragData;
150     DragOperation m_draggingSourceOperationMask;
151     DragApplicationFlags m_applicationFlags;
152 #if PLATFORM(MAC)
153     String m_pasteboardName;
154 #endif
155 #if PLATFORM(WIN)
156     DragDataMap m_dragDataMap;
157 #endif
158 };
159     
160 }
161
162 #endif // !DragData_h