WebCore/DragImage.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 #ifndef DragImage_h
  27 #define DragImage_h
  28
  29 #include "IntSize.h"
  30 #include "FloatSize.h"
  31
  32 #if PLATFORM(MAC)
  33 #include <wtf/RetainPtr.h>
  34 #ifdef __OBJC__
  35 @class NSImage;
  36 #else
  37 class NSImage;
  38 #endif
  39 #elif PLATFORM(QT)
  40 QT_BEGIN_NAMESPACE
  41 class QPixmap;
  42 QT_END_NAMESPACE
  43 #elif PLATFORM(WIN)
  44 typedef struct HBITMAP__* HBITMAP;
  45 #elif PLATFORM(WX)
  46 class wxDragImage;
  47 #elif PLATFORM(CHROMIUM)
  48 #include "DragImageRef.h"
  49 #endif
  50
  51 //We need to #define YOffset as it needs to be shared with WebKit
  52 #define DragLabelBorderYOffset 2
  53
  54 namespace WebCore {
  55
  56     class CachedImage;
  57     class Frame;
  58     class Image;
  59     class KURL;
  60     class Range;
  61     class String;
  62
  63 #if PLATFORM(MAC)
  64     typedef RetainPtr<NSImage> DragImageRef;
  65 #elif PLATFORM(QT)
  66     typedef QPixmap* DragImageRef;
  67 #elif PLATFORM(WIN)
  68     typedef HBITMAP DragImageRef;
  69 #elif PLATFORM(WX)
  70     typedef wxDragImage* DragImageRef;
  71 #elif PLATFORM(GTK)
  72     typedef void* DragImageRef;
  73 #endif
  74
  75     IntSize dragImageSize(DragImageRef);
  76
  77     //These functions should be memory neutral, eg. if they return a newly allocated image,
  78     //they should release the input image.  As a corollary these methods don't guarantee
  79     //the input image ref will still be valid after they have been called
  80     DragImageRef fitDragImageToMaxSize(DragImageRef image, const IntSize& srcSize, const IntSize& size);
  81     DragImageRef scaleDragImage(DragImageRef, FloatSize scale);
  82     DragImageRef dissolveDragImageToFraction(DragImageRef image, float delta);
  83
  84     DragImageRef createDragImageFromImage(Image*);
  85     DragImageRef createDragImageForSelection(Frame*);
  86     DragImageRef createDragImageIconForCachedImage(CachedImage*);
  87     void deleteDragImage(DragImageRef);
  88 }
  89
  90 #endif //!DragImage_h