fcc8770fdb19dbe816f5a86b825ac14981328543
[WebKit-https.git] / WebCore / page / ChromeClient.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 Apple, Inc. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #ifndef ChromeClient_h
21 #define ChromeClient_h
22
23 #include "Console.h"
24 #include "Cursor.h"
25 #include "FocusDirection.h"
26 #include "GraphicsContext.h"
27 #include "HTMLParserQuirks.h"
28 #include "HostWindow.h"
29 #include "ScrollTypes.h"
30 #include <wtf/Forward.h>
31 #include <wtf/PassOwnPtr.h>
32 #include <wtf/Vector.h>
33
34 #if PLATFORM(MAC)
35 #include "WebCoreKeyboardUIMode.h"
36 #endif
37
38 #ifndef __OBJC__
39 class NSMenu;
40 class NSResponder;
41 #endif
42
43 namespace WebCore {
44
45     class AtomicString;
46     class FileChooser;
47     class FloatRect;
48     class Frame;
49     class Geolocation;
50     class HTMLParserQuirks;
51     class HitTestResult;
52     class IntRect;
53     class Node;
54     class Page;
55     class String;
56     class Widget;
57
58     struct FrameLoadRequest;
59     struct WindowFeatures;
60
61 #if USE(ACCELERATED_COMPOSITING)
62     class GraphicsLayer;
63 #endif
64
65 #if ENABLE(NOTIFICATIONS)
66     class NotificationPresenter;
67 #endif
68
69     class ChromeClient {
70     public:
71         virtual void chromeDestroyed() = 0;
72         
73         virtual void setWindowRect(const FloatRect&) = 0;
74         virtual FloatRect windowRect() = 0;
75         
76         virtual FloatRect pageRect() = 0;
77         
78         virtual float scaleFactor() = 0;
79     
80         virtual void focus() = 0;
81         virtual void unfocus() = 0;
82
83         virtual bool canTakeFocus(FocusDirection) = 0;
84         virtual void takeFocus(FocusDirection) = 0;
85
86         virtual void focusedNodeChanged(Node*) = 0;
87
88         // The Frame pointer provides the ChromeClient with context about which
89         // Frame wants to create the new Page.  Also, the newly created window
90         // should not be shown to the user until the ChromeClient of the newly
91         // created Page has its show method called.
92         virtual Page* createWindow(Frame*, const FrameLoadRequest&, const WindowFeatures&) = 0;
93         virtual void show() = 0;
94
95         virtual bool canRunModal() = 0;
96         virtual void runModal() = 0;
97
98         virtual void setToolbarsVisible(bool) = 0;
99         virtual bool toolbarsVisible() = 0;
100         
101         virtual void setStatusbarVisible(bool) = 0;
102         virtual bool statusbarVisible() = 0;
103         
104         virtual void setScrollbarsVisible(bool) = 0;
105         virtual bool scrollbarsVisible() = 0;
106         
107         virtual void setMenubarVisible(bool) = 0;
108         virtual bool menubarVisible() = 0;
109
110         virtual void setResizable(bool) = 0;
111         
112         virtual void addMessageToConsole(MessageSource, MessageType, MessageLevel, const String& message, unsigned int lineNumber, const String& sourceID) = 0;
113
114         virtual bool canRunBeforeUnloadConfirmPanel() = 0;
115         virtual bool runBeforeUnloadConfirmPanel(const String& message, Frame* frame) = 0;
116
117         virtual void closeWindowSoon() = 0;
118         
119         virtual void runJavaScriptAlert(Frame*, const String&) = 0;
120         virtual bool runJavaScriptConfirm(Frame*, const String&) = 0;
121         virtual bool runJavaScriptPrompt(Frame*, const String& message, const String& defaultValue, String& result) = 0;
122         virtual void setStatusbarText(const String&) = 0;
123         virtual bool shouldInterruptJavaScript() = 0;
124         virtual bool tabsToLinks() const = 0;
125
126         virtual void registerProtocolHandler(const String&, const String&, const String&, const String&) { }
127         virtual void registerContentHandler(const String&, const String&, const String&, const String&) { }
128
129         virtual IntRect windowResizerRect() const = 0;
130
131         // Methods used by HostWindow.
132         virtual void invalidateContents(const IntRect&, bool) = 0;
133         virtual void invalidateWindow(const IntRect&, bool) = 0;
134         virtual void invalidateContentsAndWindow(const IntRect&, bool) = 0;
135         virtual void invalidateContentsForSlowScroll(const IntRect&, bool) = 0;
136         virtual void scroll(const IntSize&, const IntRect&, const IntRect&) = 0;
137         virtual IntPoint screenToWindow(const IntPoint&) const = 0;
138         virtual IntRect windowToScreen(const IntRect&) const = 0;
139         virtual PlatformPageClient platformPageClient() const = 0;
140         virtual void contentsSizeChanged(Frame*, const IntSize&) const = 0;
141         virtual void scrollRectIntoView(const IntRect&, const ScrollView*) const = 0; // Currently only Mac has a non empty implementation.
142         // End methods used by HostWindow.
143
144         virtual void scrollbarsModeDidChange() const = 0;
145         virtual void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags) = 0;
146
147         virtual void setToolTip(const String&, TextDirection) = 0;
148
149         virtual void print(Frame*) = 0;
150
151 #if ENABLE(DATABASE)
152         virtual void exceededDatabaseQuota(Frame*, const String& databaseName) = 0;
153 #endif
154
155 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
156         // Callback invoked when the application cache fails to save a cache object
157         // because storing it would grow the database file past its defined maximum
158         // size or past the amount of free space on the device. 
159         // The chrome client would need to take some action such as evicting some
160         // old caches.
161         virtual void reachedMaxAppCacheSize(int64_t spaceNeeded) = 0;
162 #endif
163
164 #if ENABLE(DASHBOARD_SUPPORT)
165         virtual void dashboardRegionsChanged();
166 #endif
167
168 #if ENABLE(NOTIFICATIONS)
169         virtual NotificationPresenter* notificationPresenter() const = 0;
170 #endif
171
172         virtual void populateVisitedLinks();
173
174         virtual FloatRect customHighlightRect(Node*, const AtomicString& type, const FloatRect& lineRect);
175         virtual void paintCustomHighlight(Node*, const AtomicString& type, const FloatRect& boxRect, const FloatRect& lineRect,
176             bool behindText, bool entireLine);
177             
178         virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename);
179         virtual String generateReplacementFile(const String& path);
180
181         virtual bool paintCustomScrollbar(GraphicsContext*, const FloatRect&, ScrollbarControlSize, 
182                                           ScrollbarControlState, ScrollbarPart pressedPart, bool vertical,
183                                           float value, float proportion, ScrollbarControlPartMask);
184         virtual bool paintCustomScrollCorner(GraphicsContext*, const FloatRect&);
185
186         // This can be either a synchronous or asynchronous call. The ChromeClient can display UI asking the user for permission
187         // to use Geolocation.
188         virtual void requestGeolocationPermissionForFrame(Frame*, Geolocation*) = 0;
189         virtual void cancelGeolocationPermissionRequestForFrame(Frame*) = 0;
190             
191         virtual void runOpenPanel(Frame*, PassRefPtr<FileChooser>) = 0;
192         // Asynchronous request to load an icon for specified filenames.
193         // This is called only if Icon::createIconForFiles() returns 0.
194         virtual void iconForFiles(const Vector<String>&, PassRefPtr<FileChooser>) = 0;
195
196         virtual bool setCursor(PlatformCursorHandle) = 0;
197
198         // Notification that the given form element has changed. This function
199         // will be called frequently, so handling should be very fast.
200         virtual void formStateDidChange(const Node*) = 0;
201         
202         virtual void formDidFocus(const Node*) { };
203         virtual void formDidBlur(const Node*) { };
204
205         virtual PassOwnPtr<HTMLParserQuirks> createHTMLParserQuirks() = 0;
206
207 #if USE(ACCELERATED_COMPOSITING)
208         // Pass 0 as the GraphicsLayer to detatch the root layer.
209         virtual void attachRootGraphicsLayer(Frame*, GraphicsLayer*) = 0;
210         // Sets a flag to specify that the next time content is drawn to the window,
211         // the changes appear on the screen in synchrony with updates to GraphicsLayers.
212         virtual void setNeedsOneShotDrawingSynchronization() = 0;
213         // Sets a flag to specify that the view needs to be updated, so we need
214         // to do an eager layout before the drawing.
215         virtual void scheduleCompositingLayerSync() = 0;
216 #endif
217
218         virtual bool supportsFullscreenForNode(const Node*) { return false; }
219         virtual void enterFullscreenForNode(Node*) { }
220         virtual void exitFullscreenForNode(Node*) { }
221         
222 #if PLATFORM(MAC)
223         virtual KeyboardUIMode keyboardUIMode() { return KeyboardAccessDefault; }
224
225         virtual NSResponder *firstResponder() { return 0; }
226         virtual void makeFirstResponder(NSResponder *) { }
227
228         virtual void willPopUpMenu(NSMenu *) { }
229 #endif
230
231 #if ENABLE(TOUCH_EVENTS)
232         virtual void needTouchEvents(bool) = 0;
233 #endif
234
235     protected:
236         virtual ~ChromeClient() { }
237     };
238
239 }
240
241 #endif // ChromeClient_h