WebCore/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 #ifdef __OBJC__
  36 @class DOMElement;
  37 @class NSURL;
  38 @class NSString;
  39 @class NSPasteboard;
  40 #else
  41 class DOMElement;
  42 class NSURL;
  43 class NSString;
  44 class NSPasteboard;
  45 #endif
  46 #endif
  47
  48 namespace WebCore {
  49
  50     class Clipboard;
  51     class DragData;
  52     class Frame;
  53     class Image;
  54     class HTMLImageElement;
  55
  56     class DragClient {
  57     public:
  58         virtual void willPerformDragDestinationAction(DragDestinationAction, DragData*) = 0;
  59         virtual void willPerformDragSourceAction(DragSourceAction, const IntPoint&, Clipboard*) = 0;
  60         virtual DragDestinationAction actionMaskForDrag(DragData*) = 0;
  61         //We work in window rather than view coordinates here
  62         virtual DragSourceAction dragSourceActionMaskForPoint(const IntPoint& windowPoint) = 0;
  63
  64         virtual void startDrag(DragImageRef dragImage, const IntPoint& dragImageOrigin, const IntPoint& eventPos, Clipboard*, Frame*, bool linkDrag = false) = 0;
  65         virtual DragImageRef createDragImageForLink(KURL&, const String& label, Frame*) = 0;
  66
  67         virtual void dragControllerDestroyed() = 0;
  68 #if PLATFORM(MAC)
  69         //Mac specific helper functions to allow access to functionality in webkit -- such as
  70         //web archives and NSPasteboard extras
  71         //not abstract as that would require another #if PLATFORM(MAC) for the SVGImage client empty impl
  72         virtual void declareAndWriteDragImage(NSPasteboard*, DOMElement*, NSURL*, NSString*, Frame*) {};
  73 #endif
  74
  75         virtual ~DragClient() {};
  76     };
  77
  78 }
  79
  80 #endif // !DragClient_h
  81