Source/WebCore/page/DragClient.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
  27 #ifndef DragClient_h
  28 #define DragClient_h
  29
  30 #include "DragActions.h"
  31 #include "DragImage.h"
  32 #include "IntPoint.h"
  33
  34 #if PLATFORM(MAC)
  35 OBJC_CLASS DOMElement;
  36 OBJC_CLASS NSURL;
  37 OBJC_CLASS NSString;
  38 #endif
  39
  40 namespace WebCore {
  41
  42     class Clipboard;
  43     class DragData;
  44     class Frame;
  45     class Image;
  46     class HTMLImageElement;
  47
  48     class DragClient {
  49     public:
  50         virtual void willPerformDragDestinationAction(DragDestinationAction, DragData*) = 0;
  51         virtual void willPerformDragSourceAction(DragSourceAction, const IntPoint&, Clipboard*) = 0;
  52         virtual DragDestinationAction actionMaskForDrag(DragData*) = 0;
  53
  54         virtual DragSourceAction dragSourceActionMaskForPoint(const IntPoint& rootViewPoint) = 0;
  55
  56         virtual void startDrag(DragImageRef dragImage, const IntPoint& dragImageOrigin, const IntPoint& eventPos, Clipboard*, Frame*, bool linkDrag = false) = 0;
  57
  58         virtual void dragControllerDestroyed() = 0;
  59
  60 #if PLATFORM(MAC)
  61         // Mac-specific helper function to allow access to web archives and NSPasteboard extras in WebKit.
  62         // This is not abstract as that would require another #if PLATFORM(MAC) for the SVGImage client empty implentation.
  63         virtual void declareAndWriteDragImage(const String&, DOMElement*, NSURL *, NSString *, Frame*) { }
  64 #endif
  65
  66         virtual void dragEnded() { }
  67
  68         virtual ~DragClient() { }
  69     };
  70
  71 }
  72
  73 #endif // !DragClient_h
  74