Source/WebCore/page/DragController.h

   1 /*
   2  * Copyright (C) 2007, 2009 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 DragController_h
  27 #define DragController_h
  28
  29 #include "DragActions.h"
  30 #include "DragImage.h"
  31 #include "IntPoint.h"
  32 #include "KURL.h"
  33 #if ENABLE(TIZEN_DRAG_SUPPORT)
  34 #include "PlatformMouseEvent.h"
  35 #endif
  36
  37 namespace WebCore {
  38
  39     class Clipboard;
  40     class Document;
  41     class DragClient;
  42     class DragData;
  43     struct DragSession;
  44     struct DragState;
  45     class Element;
  46     class Frame;
  47     class FrameSelection;
  48     class HTMLInputElement;
  49     class Image;
  50     class IntRect;
  51     class Node;
  52     class Page;
  53     class PlatformMouseEvent;
  54     class Range;
  55
  56     class DragController {
  57         WTF_MAKE_NONCOPYABLE(DragController); WTF_MAKE_FAST_ALLOCATED;
  58     public:
  59         ~DragController();
  60
  61         static PassOwnPtr<DragController> create(Page*, DragClient*);
  62
  63         DragClient* client() const { return m_client; }
  64
  65         DragSession dragEntered(DragData*);
  66         void dragExited(DragData*);
  67         DragSession dragUpdated(DragData*);
  68         bool performDrag(DragData*);
  69
  70         // FIXME: It should be possible to remove a number of these accessors once all
  71         // drag logic is in WebCore.
  72         void setDidInitiateDrag(bool initiated) { m_didInitiateDrag = initiated; }
  73         bool didInitiateDrag() const { return m_didInitiateDrag; }
  74         void setIsHandlingDrag(bool handling) { m_isHandlingDrag = handling; }
  75         bool isHandlingDrag() const { return m_isHandlingDrag; }
  76         DragOperation sourceDragOperation() const { return m_sourceDragOperation; }
  77         const KURL& draggingImageURL() const { return m_draggingImageURL; }
  78         void setDragOffset(const IntPoint& offset) { m_dragOffset = offset; }
  79         const IntPoint& dragOffset() const { return m_dragOffset; }
  80         DragSourceAction dragSourceAction() const { return m_dragSourceAction; }
  81
  82         Document* documentUnderMouse() const { return m_documentUnderMouse.get(); }
  83         DragDestinationAction dragDestinationAction() const { return m_dragDestinationAction; }
  84         DragSourceAction delegateDragSourceAction(const IntPoint& rootViewPoint);
  85
  86         Node* draggableNode(const Frame*, Node*, const IntPoint&, DragState&) const;
  87         void dragEnded();
  88
  89         void placeDragCaret(const IntPoint&);
  90
  91         bool startDrag(Frame* src, const DragState&, DragOperation srcOp, const PlatformMouseEvent& dragEvent, const IntPoint& dragOrigin);
  92         static const IntSize& maxDragImageSize();
  93
  94         static const int LinkDragBorderInset;
  95         static const int MaxOriginalImageArea;
  96         static const int DragIconRightInset;
  97         static const int DragIconBottomInset;
  98         static const float DragImageAlpha;
  99 #if ENABLE(TIZEN_DRAG_SUPPORT)
 100         void setDragState(bool state) { m_dragState = state; }
 101         void setPosition(const PlatformMouseEvent event) { m_positionEvent = event; }
 102
 103         bool dragState() { return m_dragState; }
 104         const PlatformMouseEvent& dragPositionEvent() { return m_positionEvent; }
 105 #endif
 106
 107     private:
 108         DragController(Page*, DragClient*);
 109
 110         bool dispatchTextInputEventFor(Frame*, DragData*);
 111         bool canProcessDrag(DragData*);
 112         bool concludeEditDrag(DragData*);
 113         DragSession dragEnteredOrUpdated(DragData*);
 114         DragOperation operationForLoad(DragData*);
 115         bool tryDocumentDrag(DragData*, DragDestinationAction, DragSession&);
 116         bool tryDHTMLDrag(DragData*, DragOperation&);
 117         DragOperation dragOperation(DragData*);
 118         void cancelDrag();
 119         bool dragIsMove(FrameSelection*, DragData*);
 120         bool isCopyKeyDown(DragData*);
 121
 122         void mouseMovedIntoDocument(Document*);
 123
 124         IntRect selectionDraggingRect(Frame*);
 125         bool doDrag(Frame* src, Clipboard* clipboard, DragImageRef dragImage, const KURL& linkURL, const KURL& imageURL, Node* node, IntPoint& dragLoc, IntPoint& dragImageOffset);
 126         void doImageDrag(Element*, const IntPoint&, const IntRect&, Clipboard*, Frame*, IntPoint&);
 127         void doSystemDrag(DragImageRef, const IntPoint&, const IntPoint&, Clipboard*, Frame*, bool forLink);
 128         void cleanupAfterSystemDrag();
 129
 130         Page* m_page;
 131         DragClient* m_client;
 132
 133         RefPtr<Document> m_documentUnderMouse; // The document the mouse was last dragged over.
 134         RefPtr<Document> m_dragInitiator; // The Document (if any) that initiated the drag.
 135         RefPtr<HTMLInputElement> m_fileInputElementUnderMouse;
 136
 137         DragDestinationAction m_dragDestinationAction;
 138         DragSourceAction m_dragSourceAction;
 139         bool m_didInitiateDrag;
 140         bool m_isHandlingDrag;
 141         DragOperation m_sourceDragOperation; // Set in startDrag when a drag starts from a mouse down within WebKit
 142         IntPoint m_dragOffset;
 143         KURL m_draggingImageURL;
 144 #if ENABLE(TIZEN_DRAG_SUPPORT)
 145         bool m_dragState;
 146         PlatformMouseEvent m_positionEvent;
 147 #endif
 148     };
 149
 150 }
 151
 152 #endif