80be871310ee6d625ce3f051b010a301e648ee6d
[WebKit-https.git] / WebCore / platform / Widget.h
1 /*
2  * Copyright (C) 2004, 2005, 2006 Apple Computer, 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 Widget_h
27 #define Widget_h
28
29 #include <wtf/Platform.h>
30
31 #if PLATFORM(MAC)
32 #ifdef __OBJC__
33 @class NSView;
34 #else
35 class NSView;
36 #endif
37 #endif
38
39 #if PLATFORM(WIN)
40 typedef struct HWND__* HWND;
41 #endif
42
43 #if PLATFORM(GDK)
44 typedef struct _GdkDrawable GdkDrawable;
45 #endif
46
47 #if PLATFORM(QT)
48 class QWidget;
49 #endif
50
51 namespace WebCore {
52
53     class Cursor;
54     class Event;
55     class Font;
56     class GraphicsContext;
57     class IntPoint;
58     class IntRect;
59     class IntSize;
60     class PlatformMouseEvent;
61     class ScrollView;
62     class WidgetClient;
63     class WidgetPrivate;
64
65     class Widget {
66     public:
67         Widget();
68         virtual ~Widget();
69
70         virtual void setEnabled(bool);
71         virtual bool isEnabled() const;
72
73         int x() const;
74         int y() const;
75         int width() const;
76         int height() const;
77         IntSize size() const;
78         void resize(int, int);
79         void resize(const IntSize&);
80         IntPoint pos() const;
81         void move(int, int);
82         void move(const IntPoint&);
83
84         virtual void paint(GraphicsContext*, const IntRect&);
85         virtual void invalidate();
86         virtual void invalidateRect(const IntRect&);
87
88         virtual void setFrameGeometry(const IntRect&);
89         virtual IntRect frameGeometry() const;
90
91         virtual void setFocus();
92
93         void setCursor(const Cursor&);
94         Cursor cursor();
95
96         virtual void show();
97         virtual void hide();
98
99         void setIsSelected(bool);
100
101         void setClient(WidgetClient*);
102         WidgetClient* client() const;
103
104         virtual bool isFrameView() const;
105
106         virtual void removeFromParent();
107
108         // This method is used by plugins on all platforms to obtain a clip rect that includes clips set by WebCore,
109         // e.g., in overflow:auto sections.  The clip rects coordinates are in the containing window's coordinate space.
110         // This clip includes any clips that the widget itself sets up for its children.
111         virtual IntRect windowClipRect() const;
112
113         virtual void handleEvent(Event*) { }
114
115 #if PLATFORM(WIN)
116         void setContainingWindow(HWND);
117         HWND containingWindow() const;
118
119         void setParent(ScrollView*);
120         ScrollView* parent() const;
121
122         virtual void geometryChanged() const {};
123
124         bool capturingMouse() const;
125         void setCapturingMouse(bool);
126         Widget* capturingTarget();
127         Widget* capturingChild();
128         void setCapturingChild(Widget*);
129         
130         IntRect convertToContainingWindow(const IntRect&) const;
131         IntPoint convertToContainingWindow(const IntPoint&) const;
132         IntPoint convertFromContainingWindow(const IntPoint&) const;
133
134         virtual IntPoint convertChildToSelf(const Widget*, const IntPoint&) const;
135         virtual IntPoint convertSelfToChild(const Widget*, const IntPoint&) const;
136
137         bool suppressInvalidation() const;
138         void setSuppressInvalidation(bool);
139
140         // These methods will be called on a widget while it is capturing the mouse. 
141         virtual bool handleMouseMoveEvent(const PlatformMouseEvent&) { return false; } 
142         virtual bool handleMouseReleaseEvent(const PlatformMouseEvent&) { return false; }
143 #endif
144
145 #if PLATFORM(GDK)
146         Widget(GdkDrawable*);
147         virtual void setDrawable(GdkDrawable*);
148         GdkDrawable* drawable() const;
149 #endif
150
151 #if PLATFORM(QT)
152         QWidget* qwidget();
153         void setQWidget(QWidget*);
154 #endif
155
156 #if PLATFORM(MAC)
157         Widget(NSView*);
158
159         NSView* getView() const;
160         NSView* getOuterView() const;
161         void setView(NSView*);
162         
163         void sendConsumedMouseUp();
164         
165         static void beforeMouseDown(NSView*, Widget*);
166         static void afterMouseDown(NSView*, Widget*);
167
168         void addToSuperview(NSView* superview);
169         void removeFromSuperview();
170 #endif
171
172         // To be deleted.
173         enum FocusPolicy { NoFocus, TabFocus, ClickFocus, StrongFocus, WheelFocus };
174         GraphicsContext* lockDrawingFocus();
175         const Font& font() const;
176         virtual FocusPolicy focusPolicy() const;
177         virtual bool hasFocus() const;
178         virtual void clearFocus();
179         virtual void setFont(const Font&);
180         void disableFlushDrawing();
181         void enableFlushDrawing();
182         void unlockDrawingFocus(GraphicsContext*);
183
184     private:
185         WidgetPrivate* data;
186     };
187
188 } // namespace WebCore
189
190 #endif // Widget_h