2008-10-10 Darin Fisher <darin@chromium.org>
[WebKit-https.git] / WebCore / platform / Cursor.h
1 /*
2  * Copyright (C) 2004, 2006, 2008 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 Cursor_h
27 #define Cursor_h
28
29 #include <wtf/Platform.h>
30
31 #if PLATFORM(WIN)
32 typedef struct HICON__* HICON;
33 typedef HICON HCURSOR;
34 #include <wtf/PassRefPtr.h>
35 #include <wtf/RefCounted.h>
36 #include <wtf/RefPtr.h>
37 #elif PLATFORM(GTK)
38 typedef struct _GdkCursor GdkCursor;
39 #elif PLATFORM(QT)
40 #include <QCursor>
41 #elif PLATFORM(CHROMIUM)
42 #include "PlatformCursor.h"
43 #endif
44
45 #if PLATFORM(MAC)
46 #ifdef __OBJC__
47 @class NSCursor;
48 #else
49 class NSCursor;
50 #endif
51 #endif
52
53 #if PLATFORM(WX)
54 class wxCursor;
55 #endif
56
57 namespace WebCore {
58
59     class Image;
60     class IntPoint;
61
62 #if PLATFORM(WIN)
63     class SharedCursor : public RefCounted<SharedCursor> {
64     public:
65         static PassRefPtr<SharedCursor> create(HCURSOR nativeCursor) { return adoptRef(new SharedCursor(nativeCursor)); }
66         ~SharedCursor() { DestroyIcon(m_nativeCursor); }
67         HCURSOR nativeCursor() const { return m_nativeCursor; }
68     private:
69         SharedCursor(HCURSOR nativeCursor) : m_nativeCursor(nativeCursor) { }
70         HCURSOR m_nativeCursor;
71     };
72     typedef RefPtr<SharedCursor> PlatformCursor;
73 #elif PLATFORM(MAC)
74     typedef NSCursor* PlatformCursor;
75 #elif PLATFORM(GTK)
76     typedef GdkCursor* PlatformCursor;
77 #elif PLATFORM(QT) && !defined(QT_NO_CURSOR)
78     typedef QCursor PlatformCursor;
79 #elif PLATFORM(WX)
80     typedef wxCursor* PlatformCursor;
81 #elif PLATFORM(CHROMIUM)
82     // See PlatformCursor.h
83 #else
84     typedef void* PlatformCursor;
85 #endif
86
87     class Cursor {
88     public:
89         Cursor()
90 #if !PLATFORM(QT)
91         : m_impl(0)
92 #endif
93         { }
94
95         Cursor(Image*, const IntPoint& hotspot);
96         Cursor(const Cursor&);
97         ~Cursor();
98         Cursor& operator=(const Cursor&);
99
100         Cursor(PlatformCursor);
101         PlatformCursor impl() const { return m_impl; }
102
103      private:
104         PlatformCursor m_impl;
105     };
106
107     const Cursor& pointerCursor();
108     const Cursor& crossCursor();
109     const Cursor& handCursor();
110     const Cursor& moveCursor();
111     const Cursor& iBeamCursor();
112     const Cursor& waitCursor();
113     const Cursor& helpCursor();
114     const Cursor& eastResizeCursor();
115     const Cursor& northResizeCursor();
116     const Cursor& northEastResizeCursor();
117     const Cursor& northWestResizeCursor();
118     const Cursor& southResizeCursor();
119     const Cursor& southEastResizeCursor();
120     const Cursor& southWestResizeCursor();
121     const Cursor& westResizeCursor();
122     const Cursor& northSouthResizeCursor();
123     const Cursor& eastWestResizeCursor();
124     const Cursor& northEastSouthWestResizeCursor();
125     const Cursor& northWestSouthEastResizeCursor();
126     const Cursor& columnResizeCursor();
127     const Cursor& rowResizeCursor();
128     const Cursor& middlePanningCursor();
129     const Cursor& eastPanningCursor();
130     const Cursor& northPanningCursor();
131     const Cursor& northEastPanningCursor();
132     const Cursor& northWestPanningCursor();
133     const Cursor& southPanningCursor();
134     const Cursor& southEastPanningCursor();
135     const Cursor& southWestPanningCursor();
136     const Cursor& westPanningCursor();
137     const Cursor& verticalTextCursor();
138     const Cursor& cellCursor();
139     const Cursor& contextMenuCursor();
140     const Cursor& noDropCursor();
141     const Cursor& notAllowedCursor();
142     const Cursor& progressCursor();
143     const Cursor& aliasCursor();
144     const Cursor& zoomInCursor();
145     const Cursor& zoomOutCursor();
146     const Cursor& copyCursor();
147     const Cursor& noneCursor();
148
149 } // namespace WebCore
150
151 #endif // Cursor_h