2302bf13a5eaf8c5a8643a9dc347d336c5bcf6a4
[WebKit-https.git] / Source / WebCore / page / ChromeClient.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 Apple, Inc. All rights reserved.
3  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4  * Copyright (C) 2012 Samsung Electronics. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #ifndef ChromeClient_h
23 #define ChromeClient_h
24
25 #include "AXObjectCache.h"
26 #include "ConsoleAPITypes.h"
27 #include "ConsoleTypes.h"
28 #include "Cursor.h"
29 #include "FocusDirection.h"
30 #include "FrameLoader.h"
31 #include "GraphicsContext.h"
32 #include "HostWindow.h"
33 #include "PopupMenu.h"
34 #include "PopupMenuClient.h"
35 #include "RenderEmbeddedObject.h"
36 #include "ScrollTypes.h"
37 #include "SearchPopupMenu.h"
38 #include "WebCoreKeyboardUIMode.h"
39 #include <wtf/Forward.h>
40 #include <wtf/PassOwnPtr.h>
41 #include <wtf/UnusedParam.h>
42 #include <wtf/Vector.h>
43
44 #if ENABLE(SQL_DATABASE)
45 #include "DatabaseDetails.h"
46 #endif
47
48 #ifndef __OBJC__
49 class NSMenu;
50 class NSResponder;
51 #endif
52
53 namespace WebCore {
54
55 class AccessibilityObject;
56 class ColorChooser;
57 class ColorChooserClient;
58 class DateTimeChooser;
59 class DateTimeChooserClient;
60 class Element;
61 class FileChooser;
62 class FileIconLoader;
63 class FloatRect;
64 class Frame;
65 class Geolocation;
66 class GraphicsContext3D;
67 class GraphicsLayer;
68 class GraphicsLayerFactory;
69 class HitTestResult;
70 class HTMLInputElement;
71 class IntRect;
72 class NavigationAction;
73 class Node;
74 class Page;
75 class PagePopup;
76 class PagePopupClient;
77 class PagePopupDriver;
78 class PopupMenuClient;
79 class SecurityOrigin;
80 class Widget;
81
82 struct DateTimeChooserParameters;
83 struct FrameLoadRequest;
84 struct GraphicsDeviceAdapter;
85 struct ViewportArguments;
86 struct WindowFeatures;
87
88 class ChromeClient {
89 public:
90     virtual void chromeDestroyed() = 0;
91
92     virtual void setWindowRect(const FloatRect&) = 0;
93     virtual FloatRect windowRect() = 0;
94
95     virtual FloatRect pageRect() = 0;
96
97     virtual void focus() = 0;
98     virtual void unfocus() = 0;
99
100     virtual bool canTakeFocus(FocusDirection) = 0;
101     virtual void takeFocus(FocusDirection) = 0;
102
103     virtual void focusedNodeChanged(Node*) = 0;
104     virtual void focusedFrameChanged(Frame*) = 0;
105
106     // The Frame pointer provides the ChromeClient with context about which
107     // Frame wants to create the new Page. Also, the newly created window
108     // should not be shown to the user until the ChromeClient of the newly
109     // created Page has its show method called.
110     // The FrameLoadRequest parameter is only for ChromeClient to check if the
111     // request could be fulfilled. The ChromeClient should not load the request.
112     virtual Page* createWindow(Frame*, const FrameLoadRequest&, const WindowFeatures&, const NavigationAction&) = 0;
113     virtual void show() = 0;
114
115     virtual bool canRunModal() = 0;
116     virtual void runModal() = 0;
117
118     virtual void setToolbarsVisible(bool) = 0;
119     virtual bool toolbarsVisible() = 0;
120
121     virtual void setStatusbarVisible(bool) = 0;
122     virtual bool statusbarVisible() = 0;
123
124     virtual void setScrollbarsVisible(bool) = 0;
125     virtual bool scrollbarsVisible() = 0;
126
127     virtual void setMenubarVisible(bool) = 0;
128     virtual bool menubarVisible() = 0;
129
130     virtual void setResizable(bool) = 0;
131
132     virtual void addMessageToConsole(MessageSource, MessageLevel, const String& message, unsigned lineNumber, const String& sourceID) = 0;
133     // FIXME: Remove this MessageType variant once all the clients are updated.
134     virtual void addMessageToConsole(MessageSource source, MessageType, MessageLevel level, const String& message, unsigned lineNumber, const String& sourceID)
135     {
136         addMessageToConsole(source, level, message, lineNumber, sourceID);
137     }
138
139     virtual bool canRunBeforeUnloadConfirmPanel() = 0;
140     virtual bool runBeforeUnloadConfirmPanel(const String& message, Frame*) = 0;
141
142     virtual void closeWindowSoon() = 0;
143
144     virtual void runJavaScriptAlert(Frame*, const String&) = 0;
145     virtual bool runJavaScriptConfirm(Frame*, const String&) = 0;
146     virtual bool runJavaScriptPrompt(Frame*, const String& message, const String& defaultValue, String& result) = 0;
147     virtual void setStatusbarText(const String&) = 0;
148     virtual bool shouldInterruptJavaScript() = 0;
149     virtual KeyboardUIMode keyboardUIMode() = 0;
150
151     virtual void* webView() const = 0;
152
153     virtual IntRect windowResizerRect() const = 0;
154
155     // Methods used by HostWindow.
156     virtual bool supportsImmediateInvalidation() { return false; }
157     virtual void invalidateRootView(const IntRect&, bool immediate) = 0;
158     virtual void invalidateContentsAndRootView(const IntRect&, bool immediate) = 0;
159     virtual void invalidateContentsForSlowScroll(const IntRect&, bool immediate) = 0;
160     virtual void scroll(const IntSize&, const IntRect&, const IntRect&) = 0;
161 #if USE(TILED_BACKING_STORE)
162     virtual void delegatedScrollRequested(const IntPoint&) = 0;
163 #endif
164     virtual IntPoint screenToRootView(const IntPoint&) const = 0;
165     virtual IntRect rootViewToScreen(const IntRect&) const = 0;
166     virtual PlatformPageClient platformPageClient() const = 0;
167     virtual void scrollbarsModeDidChange() const = 0;
168     virtual void setCursor(const Cursor&) = 0;
169     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
170 #if ENABLE(REQUEST_ANIMATION_FRAME) && !USE(REQUEST_ANIMATION_FRAME_TIMER)
171     virtual void scheduleAnimation() = 0;
172 #endif
173     // End methods used by HostWindow.
174
175     virtual void dispatchViewportPropertiesDidChange(const ViewportArguments&) const { }
176
177     virtual void contentsSizeChanged(Frame*, const IntSize&) const = 0;
178     virtual void layoutUpdated(Frame*) const { }
179     virtual void scrollRectIntoView(const IntRect&) const { }; // Currently only Mac has a non empty implementation.
180
181     virtual bool shouldUnavailablePluginMessageBeButton(RenderEmbeddedObject::PluginUnavailabilityReason) const { return false; }
182     virtual void unavailablePluginButtonClicked(Element*, RenderEmbeddedObject::PluginUnavailabilityReason) const { }
183     virtual void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags) = 0;
184
185     virtual void setToolTip(const String&, TextDirection) = 0;
186
187     virtual void print(Frame*) = 0;
188     virtual bool shouldRubberBandInDirection(ScrollDirection) const = 0;
189
190     virtual Color underlayColor() const { return Color(); }
191
192 #if ENABLE(SQL_DATABASE)
193     virtual void exceededDatabaseQuota(Frame*, const String& databaseName, DatabaseDetails) = 0;
194 #endif
195
196     // Callback invoked when the application cache fails to save a cache object
197     // because storing it would grow the database file past its defined maximum
198     // size or past the amount of free space on the device. 
199     // The chrome client would need to take some action such as evicting some
200     // old caches.
201     virtual void reachedMaxAppCacheSize(int64_t spaceNeeded) = 0;
202
203     // Callback invoked when the application cache origin quota is reached. This
204     // means that the resources attempting to be cached via the manifest are
205     // more than allowed on this origin. This callback allows the chrome client
206     // to take action, such as prompting the user to ask to increase the quota
207     // for this origin. The totalSpaceNeeded parameter is the total amount of
208     // storage, in bytes, needed to store the new cache along with all of the
209     // other existing caches for the origin that would not be replaced by
210     // the new cache.
211     virtual void reachedApplicationCacheOriginQuota(SecurityOrigin*, int64_t totalSpaceNeeded) = 0;
212
213 #if ENABLE(DASHBOARD_SUPPORT) || ENABLE(DRAGGABLE_REGION)
214     virtual void annotatedRegionsChanged();
215 #endif
216
217     virtual void populateVisitedLinks();
218
219     virtual FloatRect customHighlightRect(Node*, const AtomicString& type, const FloatRect& lineRect);
220     virtual void paintCustomHighlight(Node*, const AtomicString& type, const FloatRect& boxRect, const FloatRect& lineRect, bool behindText, bool entireLine);
221             
222     virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename);
223     virtual String generateReplacementFile(const String& path);
224
225     virtual bool paintCustomOverhangArea(GraphicsContext*, const IntRect&, const IntRect&, const IntRect&);
226
227 #if ENABLE(INPUT_TYPE_COLOR)
228     virtual PassOwnPtr<ColorChooser> createColorChooser(ColorChooserClient*, const Color&) = 0;
229 #endif
230
231 #if ENABLE(DATE_AND_TIME_INPUT_TYPES)
232     // This function is used for:
233     //  - Mandatory date/time choosers if !ENABLE(INPUT_MULTIPLE_FIELDS_UI)
234     //  - Date/time choosers for types for which RenderTheme::supportsCalendarPicker
235     //    returns true, if ENABLE(INPUT_MULTIPLE_FIELDS_UI)
236     //  - <datalist> UI for date/time input types regardless of
237     //    ENABLE(INPUT_MULTIPLE_FIELDS_UI)
238     virtual PassRefPtr<DateTimeChooser> openDateTimeChooser(DateTimeChooserClient*, const DateTimeChooserParameters&) = 0;
239 #endif
240
241     virtual void runOpenPanel(Frame*, PassRefPtr<FileChooser>) = 0;
242     // Asynchronous request to load an icon for specified filenames.
243     virtual void loadIconForFiles(const Vector<String>&, FileIconLoader*) = 0;
244
245 #if ENABLE(DIRECTORY_UPLOAD)
246     // Asychronous request to enumerate all files in a directory chosen by the user.
247     virtual void enumerateChosenDirectory(FileChooser*) = 0;
248 #endif
249
250     // Notification that the given form element has changed. This function
251     // will be called frequently, so handling should be very fast.
252     virtual void formStateDidChange(const Node*) = 0;
253         
254     virtual void elementDidFocus(const Node*) { };
255     virtual void elementDidBlur(const Node*) { };
256
257 #if USE(ACCELERATED_COMPOSITING)
258     // Allows ports to customize the type of graphics layers created by this page.
259     virtual GraphicsLayerFactory* graphicsLayerFactory() const { return 0; }
260
261     // Pass 0 as the GraphicsLayer to detatch the root layer.
262     virtual void attachRootGraphicsLayer(Frame*, GraphicsLayer*) = 0;
263     // Sets a flag to specify that the next time content is drawn to the window,
264     // the changes appear on the screen in synchrony with updates to GraphicsLayers.
265     virtual void setNeedsOneShotDrawingSynchronization() = 0;
266     // Sets a flag to specify that the view needs to be updated, so we need
267     // to do an eager layout before the drawing.
268     virtual void scheduleCompositingLayerFlush() = 0;
269     // Returns whether or not the client can render the composited layer,
270     // regardless of the settings.
271     virtual bool allowsAcceleratedCompositing() const { return true; }
272
273     enum CompositingTrigger {
274         ThreeDTransformTrigger = 1 << 0,
275         VideoTrigger = 1 << 1,
276         PluginTrigger = 1 << 2,
277         CanvasTrigger = 1 << 3,
278         AnimationTrigger = 1 << 4,
279         FilterTrigger = 1 << 5,
280         ScrollableInnerFrameTrigger = 1 << 6,
281         AllTriggers = 0xFFFFFFFF
282     };
283     typedef unsigned CompositingTriggerFlags;
284
285     // Returns a bitfield indicating conditions that can trigger the compositor.
286     virtual CompositingTriggerFlags allowedCompositingTriggers() const { return static_cast<CompositingTriggerFlags>(AllTriggers); }
287 #endif
288
289 #if PLATFORM(WIN) && USE(AVFOUNDATION)
290     virtual GraphicsDeviceAdapter* graphicsDeviceAdapter() const { return 0; }
291 #endif
292
293     virtual bool supportsFullscreenForNode(const Node*) { return false; }
294     virtual void enterFullscreenForNode(Node*) { }
295     virtual void exitFullscreenForNode(Node*) { }
296     virtual bool requiresFullscreenForVideoPlayback() { return false; } 
297
298 #if ENABLE(FULLSCREEN_API)
299     virtual bool supportsFullScreenForElement(const Element*, bool) { return false; }
300     virtual void enterFullScreenForElement(Element*) { }
301     virtual void exitFullScreenForElement(Element*) { }
302     virtual void fullScreenRendererChanged(RenderBox*) { }
303     virtual void setRootFullScreenLayer(GraphicsLayer*) { }
304 #endif
305
306 #if USE(TILED_BACKING_STORE)
307     virtual IntRect visibleRectForTiledBackingStore() const { return IntRect(); }
308 #endif
309
310 #if PLATFORM(MAC)
311     virtual NSResponder *firstResponder() { return 0; }
312     virtual void makeFirstResponder(NSResponder *) { }
313     // Focuses on the containing view associated with this page.
314     virtual void makeFirstResponder() { }
315     virtual void willPopUpMenu(NSMenu *) { }
316 #endif
317
318 #if PLATFORM(WIN)
319     virtual void setLastSetCursorToCurrentCursor() = 0;
320 #endif
321
322 #if ENABLE(TOUCH_EVENTS)
323     virtual void needTouchEvents(bool) = 0;
324 #endif
325
326     virtual bool selectItemWritingDirectionIsNatural() = 0;
327     virtual bool selectItemAlignmentFollowsMenuWritingDirection() = 0;
328     // Checks if there is an opened popup, called by RenderMenuList::showPopup().
329     virtual bool hasOpenedPopup() const = 0;
330     virtual PassRefPtr<PopupMenu> createPopupMenu(PopupMenuClient*) const = 0;
331     virtual PassRefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient*) const = 0;
332 #if ENABLE(PAGE_POPUP)
333     // Creates a PagePopup object, and shows it beside originBoundsInRootView.
334     // The return value can be 0.
335     virtual PagePopup* openPagePopup(PagePopupClient*, const IntRect& originBoundsInRootView) = 0;
336     virtual void closePagePopup(PagePopup*) = 0;
337     // For testing.
338     virtual void setPagePopupDriver(PagePopupDriver*) = 0;
339     virtual void resetPagePopupDriver() = 0;
340 #endif
341     // This function is called whenever a text field <input> is created. The
342     // implementation should return true if it wants to do something in
343     // addTextFieldDecorationsTo().
344     // The argument is always non-0.
345     virtual bool willAddTextFieldDecorationsTo(HTMLInputElement*) { return false; }
346     // The argument is always non-0.
347     virtual void addTextFieldDecorationsTo(HTMLInputElement*) { }
348
349     virtual void postAccessibilityNotification(AccessibilityObject*, AXObjectCache::AXNotification) { }
350
351     virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { }
352     virtual void recommendedScrollbarStyleDidChange(int /*newStyle*/) { }
353
354     enum DialogType {
355         AlertDialog = 0,
356         ConfirmDialog = 1,
357         PromptDialog = 2,
358         HTMLDialog = 3
359     };
360     virtual bool shouldRunModalDialogDuringPageDismissal(const DialogType&, const String& dialogMessage, FrameLoader::PageDismissalType) const { UNUSED_PARAM(dialogMessage); return true; }
361
362     virtual void numWheelEventHandlersChanged(unsigned) = 0;
363         
364     virtual bool isSVGImageChromeClient() const { return false; }
365
366 #if ENABLE(POINTER_LOCK)
367     virtual bool requestPointerLock() { return false; }
368     virtual void requestPointerUnlock() { }
369     virtual bool isPointerLocked() { return false; }
370 #endif
371
372     virtual void logDiagnosticMessage(const String& message, const String& description, const String& status) { UNUSED_PARAM(message); UNUSED_PARAM(description); UNUSED_PARAM(status); }
373
374     virtual FloatSize minimumWindowSize() const { return FloatSize(100, 100); };
375
376     virtual bool isEmptyChromeClient() const { return false; }
377
378     virtual String plugInStartLabelTitle() const { return String(); }
379     virtual String plugInStartLabelSubtitle() const { return String(); }
380     virtual String plugInExtraStyleSheet() const { return String(); }
381
382     // FIXME: Port should return true using heuristic based on scrollable(RenderBox).
383     virtual bool shouldAutoscrollForDragAndDrop(RenderBox*) const { return false; }
384
385 protected:
386     virtual ~ChromeClient() { }
387 };
388
389 }
390 #endif // ChromeClient_h