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