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