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 "ClipboardAccessPolicy.h"
  30 #include "Color.h"
  31 #include "DragActions.h"
  32 #include "IntPoint.h"
  33
  34 #include <wtf/Forward.h>
  35 #include <wtf/Vector.h>
  36
  37 #if PLATFORM(MAC)
  38 #ifdef __OBJC__
  39 #import <Foundation/Foundation.h>
  40 #import <AppKit/NSDragging.h>
  41 typedef id <NSDraggingInfo> DragDataRef;
  42 #else
  43 typedef void* DragDataRef;
  44 #endif
  45 #elif PLATFORM(QT)
  46 QT_BEGIN_NAMESPACE
  47 class QMimeData;
  48 QT_END_NAMESPACE
  49 typedef const QMimeData* DragDataRef;
  50 #elif PLATFORM(WIN)
  51 typedef struct IDataObject* DragDataRef;
  52 #elif PLATFORM(WX)
  53 typedef class wxDataObject* DragDataRef;
  54 #elif PLATFORM(GTK)
  55 // FIXME: this should probably be something gdk-specific
  56 typedef void* DragDataRef;
  57 #elif PLATFORM(CHROMIUM)
  58 #include "DragDataRef.h"
  59 #endif
  60
  61
  62 namespace WebCore {
  63
  64     class Clipboard;
  65     class Document;
  66     class DocumentFragment;
  67     class KURL;
  68
  69 #if PLATFORM(MAC)
  70     class PasteboardHelper;
  71 #endif
  72
  73
  74     class DragData {
  75     public:
  76 #if PLATFORM(MAC)
  77         //FIXME: In the future the WebKit functions provided by the helper class should be moved into WebCore,
  78         //after which this constructor should be removed
  79         DragData(DragDataRef data, const IntPoint& clientPosition, const IntPoint& globalPosition,
  80                  DragOperation operation, PasteboardHelper*);
  81 #else
  82         //clientPosition is taken to be the position of the drag event within the target window, with (0,0) at the top left
  83         DragData(DragDataRef data, const IntPoint& clientPosition, const IntPoint& globalPosition, DragOperation operation);
  84 #endif
  85         const IntPoint& clientPosition() const { return m_clientPosition; }
  86         const IntPoint& globalPosition() const { return m_globalPosition; }
  87         DragDataRef platformData() const { return m_platformDragData; }
  88         DragOperation draggingSourceOperationMask() const { return m_draggingSourceOperationMask; }
  89         PassRefPtr<Clipboard> createClipboard(ClipboardAccessPolicy) const;
  90         bool containsURL() const;
  91         bool containsPlainText() const;
  92         bool containsCompatibleContent() const;
  93         String asURL(String* title = 0) const;
  94         String asPlainText() const;
  95         void asFilenames(Vector<String>&) const;
  96         Color asColor() const;
  97         PassRefPtr<DocumentFragment> asFragment(Document*) const;
  98         bool canSmartReplace() const;
  99         bool containsColor() const;
 100         bool containsFiles() const;
 101     private:
 102         IntPoint m_clientPosition;
 103         IntPoint m_globalPosition;
 104         DragDataRef m_platformDragData;
 105         DragOperation m_draggingSourceOperationMask;
 106 #if PLATFORM(MAC)
 107         PasteboardHelper* m_pasteboardHelper;
 108 #endif
 109 };
 110
 111 } //namespace WebCore
 112
 113 #endif //!DragData_h
 114