dd970d293692e99389abfd1a3fff874c4650a83a
[WebKit-https.git] / Source / WebCore / platform / 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 "ImageOrientation.h"
30 #include "IntSize.h"
31 #include "FloatSize.h"
32 #include <wtf/Forward.h>
33
34 #if PLATFORM(MAC)
35 #include <wtf/RetainPtr.h>
36 OBJC_CLASS NSImage;
37 #elif PLATFORM(QT)
38 QT_BEGIN_NAMESPACE
39 class QPixmap;
40 QT_END_NAMESPACE
41 #elif PLATFORM(WIN)
42 typedef struct HBITMAP__* HBITMAP;
43 #elif PLATFORM(WX)
44 class wxDragImage;
45 #elif PLATFORM(CHROMIUM)
46 #include "DragImageRef.h"
47 #elif PLATFORM(GTK)
48 typedef struct _cairo_surface cairo_surface_t;
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
62 #if PLATFORM(MAC)
63     typedef RetainPtr<NSImage> DragImageRef;
64 #elif PLATFORM(QT)
65     typedef QPixmap* DragImageRef;
66 #elif PLATFORM(WIN)
67     typedef HBITMAP DragImageRef;
68 #elif PLATFORM(WX)
69     typedef wxDragImage* DragImageRef;
70 #elif PLATFORM(GTK)
71     typedef cairo_surface_t* DragImageRef;
72 #elif PLATFORM(EFL) || PLATFORM(BLACKBERRY)
73     typedef void* DragImageRef;
74 #endif
75     
76     IntSize dragImageSize(DragImageRef);
77     
78     //These functions should be memory neutral, eg. if they return a newly allocated image, 
79     //they should release the input image.  As a corollary these methods don't guarantee
80     //the input image ref will still be valid after they have been called
81     DragImageRef fitDragImageToMaxSize(DragImageRef image, const IntSize& srcSize, const IntSize& size);
82     DragImageRef scaleDragImage(DragImageRef, FloatSize scale);
83     DragImageRef dissolveDragImageToFraction(DragImageRef image, float delta);
84     
85     DragImageRef createDragImageFromImage(Image*, RespectImageOrientationEnum = DoNotRespectImageOrientation);
86     DragImageRef createDragImageForSelection(Frame*);    
87     DragImageRef createDragImageIconForCachedImage(CachedImage*);
88     DragImageRef createDragImageForLink(KURL&, const String& label, Frame*);
89     void deleteDragImage(DragImageRef);
90 }
91
92
93 #endif //!DragImage_h