src/third_party/WebKit/Source/core/page/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 "core/page/DragActions.h"
  30 #include "platform/geometry/IntPoint.h"
  31 #include "platform/heap/Handle.h"
  32 #include "wtf/Forward.h"
  33 #include "wtf/HashMap.h"
  34 #include "wtf/Vector.h"
  35
  36 namespace WebCore {
  37
  38 class DataObject;
  39 class DocumentFragment;
  40 class LocalFrame;
  41 class KURL;
  42 class Range;
  43
  44 enum DragApplicationFlags {
  45     DragApplicationNone = 0,
  46     DragApplicationIsModal = 1,
  47     DragApplicationIsSource = 2,
  48     DragApplicationHasAttachedSheet = 4,
  49     DragApplicationIsCopyKeyDown = 8
  50 };
  51
  52 class DragData {
  53 public:
  54     enum FilenameConversionPolicy { DoNotConvertFilenames, ConvertFilenames };
  55
  56     // clientPosition is taken to be the position of the drag event within the target window, with (0,0) at the top left
  57     DragData(DataObject*, const IntPoint& clientPosition, const IntPoint& globalPosition, DragOperation, DragApplicationFlags = DragApplicationNone);
  58     DragData(const String& dragStorageName, const IntPoint& clientPosition, const IntPoint& globalPosition, DragOperation, DragApplicationFlags = DragApplicationNone);
  59     const IntPoint& clientPosition() const { return m_clientPosition; }
  60     const IntPoint& globalPosition() const { return m_globalPosition; }
  61     DragApplicationFlags flags() const { return m_applicationFlags; }
  62     DataObject* platformData() const { return m_platformDragData; }
  63     DragOperation draggingSourceOperationMask() const { return m_draggingSourceOperationMask; }
  64     bool containsURL(FilenameConversionPolicy filenamePolicy = ConvertFilenames) const;
  65     bool containsPlainText() const;
  66     bool containsCompatibleContent() const;
  67     String asURL(FilenameConversionPolicy filenamePolicy = ConvertFilenames, String* title = 0) const;
  68     String asPlainText() const;
  69     void asFilenames(Vector<String>&) const;
  70     PassRefPtr<DocumentFragment> asFragment(LocalFrame*, PassRefPtrWillBeRawPtr<Range> context, bool allowPlainText, bool& chosePlainText) const;
  71     bool canSmartReplace() const;
  72     bool containsFiles() const;
  73     unsigned numberOfFiles() const;
  74     int modifierKeyState() const;
  75
  76     String droppedFileSystemId() const;
  77
  78 private:
  79     IntPoint m_clientPosition;
  80     IntPoint m_globalPosition;
  81     DataObject* m_platformDragData;
  82     DragOperation m_draggingSourceOperationMask;
  83     DragApplicationFlags m_applicationFlags;
  84 };
  85
  86 }
  87
  88 #endif // !DragData_h