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