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 
34 namespace WebCore {
35 
36     class Clipboard;
37     class Document;
38     class DragClient;
39     class DragData;
40     class Element;
41     class Frame;
42     class Image;
43     class IntRect;
44     class Node;
45     class Page;
46     class PlatformMouseEvent;
47     class Range;
48     class SelectionController;
49 
50     class DragController {
51         WTF_MAKE_NONCOPYABLE(DragController); WTF_MAKE_FAST_ALLOCATED;
52     public:
53         DragController(Page*, DragClient*);
54         ~DragController();
client()55         DragClient* client() const { return m_client; }
56 
57         DragOperation dragEntered(DragData*);
58         void dragExited(DragData*);
59         DragOperation dragUpdated(DragData*);
60         bool performDrag(DragData*);
61 
62         // FIXME: It should be possible to remove a number of these accessors once all
63         // drag logic is in WebCore.
setDidInitiateDrag(bool initiated)64         void setDidInitiateDrag(bool initiated) { m_didInitiateDrag = initiated; }
didInitiateDrag()65         bool didInitiateDrag() const { return m_didInitiateDrag; }
setIsHandlingDrag(bool handling)66         void setIsHandlingDrag(bool handling) { m_isHandlingDrag = handling; }
isHandlingDrag()67         bool isHandlingDrag() const { return m_isHandlingDrag; }
sourceDragOperation()68         DragOperation sourceDragOperation() const { return m_sourceDragOperation; }
draggingImageURL()69         const KURL& draggingImageURL() const { return m_draggingImageURL; }
setDragOffset(const IntPoint & offset)70         void setDragOffset(const IntPoint& offset) { m_dragOffset = offset; }
dragOffset()71         const IntPoint& dragOffset() const { return m_dragOffset; }
dragSourceAction()72         DragSourceAction dragSourceAction() const { return m_dragSourceAction; }
73 
documentUnderMouse()74         Document* documentUnderMouse() const { return m_documentUnderMouse.get(); }
dragDestinationAction()75         DragDestinationAction dragDestinationAction() const { return m_dragDestinationAction; }
76         DragSourceAction delegateDragSourceAction(const IntPoint& pagePoint);
77 
78         bool mayStartDragAtEventLocation(const Frame*, const IntPoint& framePos, Node*);
79         void dragEnded();
80 
81         void placeDragCaret(const IntPoint&);
82 
83         bool startDrag(Frame* src, Clipboard*, DragOperation srcOp, const PlatformMouseEvent& dragEvent, const IntPoint& dragOrigin, bool isDHTMLDrag);
84         static const IntSize& maxDragImageSize();
85 
86         static const int LinkDragBorderInset;
87         static const int MaxOriginalImageArea;
88         static const int DragIconRightInset;
89         static const int DragIconBottomInset;
90         static const float DragImageAlpha;
91 
92     private:
93         bool dispatchTextInputEventFor(Frame*, DragData*);
94         bool canProcessDrag(DragData*);
95         bool concludeEditDrag(DragData*);
96         DragOperation dragEnteredOrUpdated(DragData*);
97         DragOperation operationForLoad(DragData*);
98         bool tryDocumentDrag(DragData*, DragDestinationAction, DragOperation&);
99         bool tryDHTMLDrag(DragData*, DragOperation&);
100         DragOperation dragOperation(DragData*);
101         void cancelDrag();
102         bool dragIsMove(SelectionController*, DragData*);
103         bool isCopyKeyDown(DragData*);
104 
105         void mouseMovedIntoDocument(Document*);
106 
107         IntRect selectionDraggingRect(Frame*);
108         bool doDrag(Frame* src, Clipboard* clipboard, DragImageRef dragImage, const KURL& linkURL, const KURL& imageURL, Node* node, IntPoint& dragLoc, IntPoint& dragImageOffset);
109         void doImageDrag(Element*, const IntPoint&, const IntRect&, Clipboard*, Frame*, IntPoint&);
110         void doSystemDrag(DragImageRef, const IntPoint&, const IntPoint&, Clipboard*, Frame*, bool forLink);
111         void cleanupAfterSystemDrag();
112 
113         Page* m_page;
114         DragClient* m_client;
115 
116         RefPtr<Document> m_documentUnderMouse; // The document the mouse was last dragged over.
117         RefPtr<Document> m_dragInitiator; // The Document (if any) that initiated the drag.
118 
119         DragDestinationAction m_dragDestinationAction;
120         DragSourceAction m_dragSourceAction;
121         bool m_didInitiateDrag;
122         bool m_isHandlingDrag;
123         DragOperation m_sourceDragOperation; // Set in startDrag when a drag starts from a mouse down within WebKit
124         IntPoint m_dragOffset;
125         KURL m_draggingImageURL;
126     };
127 
128 }
129 
130 #endif
131