Dragging over an element with scrollbars should scroll the element when dragging...
[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 "RenderSnapshottedPlugIn.h"
37 #include "ScrollTypes.h"
38 #include "SearchPopupMenu.h"
39 #include "WebCoreKeyboardUIMode.h"
40 #include <wtf/Forward.h>
41 #include <wtf/PassOwnPtr.h>
42 #include <wtf/UnusedParam.h>
43 #include <wtf/Vector.h>
44
45 #if ENABLE(SQL_DATABASE)
46 #include "DatabaseDetails.h"
47 #endif
48
49 #ifndef __OBJC__
50 class NSMenu;
51 class NSResponder;
52 #endif
53
54 namespace WebCore {
55
56 class AccessibilityObject;
57 class ColorChooser;
58 class ColorChooserClient;
59 class DateTimeChooser;
60 class DateTimeChooserClient;
61 class Element;
62 class FileChooser;
63 class FileIconLoader;
64 class FloatRect;
65 class Frame;
66 class Geolocation;
67 class GraphicsContext3D;
68 class GraphicsLayer;
69 class GraphicsLayerFactory;
70 class HitTestResult;
71 class HTMLInputElement;
72 class IntRect;
73 class NavigationAction;
74 class Node;
75 class Page;
76 class PagePopup;
77 class PagePopupClient;
78 class PagePopupDriver;
79 class PopupMenuClient;
80 class SecurityOrigin;
81 class Widget;
82
83 struct DateTimeChooserParameters;
84 struct FrameLoadRequest;
85 struct GraphicsDeviceAdapter;
86 struct ViewportArguments;
87 struct WindowFeatures;
88
89 class ChromeClient {
90 public:
91     virtual void chromeDestroyed() = 0;
92
93     virtual void setWindowRect(const FloatRect&) = 0;
94     virtual FloatRect windowRect() = 0;
95
96     virtual FloatRect pageRect() = 0;
97
98     virtual void focus() = 0;
99     virtual void unfocus() = 0;
100
101     virtual bool canTakeFocus(FocusDirection) = 0;
102     virtual void takeFocus(FocusDirection) = 0;
103
104     virtual void focusedNodeChanged(Node*) = 0;
105     virtual void focusedFrameChanged(Frame*) = 0;
106
107     // The Frame pointer provides the ChromeClient with context about which
108     // Frame wants to create the new Page. Also, the newly created window
109     // should not be shown to the user until the ChromeClient of the newly
110     // created Page has its show method called.
111     // The FrameLoadRequest parameter is only for ChromeClient to check if the
112     // request could be fulfilled. The ChromeClient should not load the request.
113     virtual Page* createWindow(Frame*, const FrameLoadRequest&, const WindowFeatures&, const NavigationAction&) = 0;
114     virtual void show() = 0;
115
116     virtual bool canRunModal() = 0;
117     virtual void runModal() = 0;
118
119     virtual void setToolbarsVisible(bool) = 0;
120     virtual bool toolbarsVisible() = 0;
121
122     virtual void setStatusbarVisible(bool) = 0;
123     virtual bool statusbarVisible() = 0;
124
125     virtual void setScrollbarsVisible(bool) = 0;
126     virtual bool scrollbarsVisible() = 0;
127
128     virtual void setMenubarVisible(bool) = 0;
129     virtual bool menubarVisible() = 0;
130
131     virtual void setResizable(bool) = 0;
132
133     virtual void addMessageToConsole(MessageSource, MessageLevel, const String& message, unsigned lineNumber, const String& sourceID) = 0;
134     // FIXME: Remove this MessageType variant once all the clients are updated.
135     virtual void addMessageToConsole(MessageSource source, MessageType, MessageLevel level, const String& message, unsigned lineNumber, const String& sourceID)
136     {
137         addMessageToConsole(source, level, message, lineNumber, sourceID);
138     }
139
140     virtual bool canRunBeforeUnloadConfirmPanel() = 0;
141     virtual bool runBeforeUnloadConfirmPanel(const String& message, Frame*) = 0;
142
143     virtual void closeWindowSoon() = 0;
144
145     virtual void runJavaScriptAlert(Frame*, const String&) = 0;
146     virtual bool runJavaScriptConfirm(Frame*, const String&) = 0;
147     virtual bool runJavaScriptPrompt(Frame*, const String& message, const String& defaultValue, String& result) = 0;
148     virtual void setStatusbarText(const String&) = 0;
149     virtual bool shouldInterruptJavaScript() = 0;
150     virtual KeyboardUIMode keyboardUIMode() = 0;
151
152     virtual void* webView() const = 0;
153
154     virtual IntRect windowResizerRect() const = 0;
155
156     // Methods used by HostWindow.
157     virtual void invalidateRootView(const IntRect&, bool) = 0;
158     virtual void invalidateContentsAndRootView(const IntRect&, bool) = 0;
159     virtual void invalidateContentsForSlowScroll(const IntRect&, bool) = 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 #if ENABLE(SQL_DATABASE)
191     virtual void exceededDatabaseQuota(Frame*, const String& databaseName, DatabaseDetails) = 0;
192 #endif
193
194     // Callback invoked when the application cache fails to save a cache object
195     // because storing it would grow the database file past its defined maximum
196     // size or past the amount of free space on the device. 
197     // The chrome client would need to take some action such as evicting some
198     // old caches.
199     virtual void reachedMaxAppCacheSize(int64_t spaceNeeded) = 0;
200
201     // Callback invoked when the application cache origin quota is reached. This
202     // means that the resources attempting to be cached via the manifest are
203     // more than allowed on this origin. This callback allows the chrome client
204     // to take action, such as prompting the user to ask to increase the quota
205     // for this origin. The totalSpaceNeeded parameter is the total amount of
206     // storage, in bytes, needed to store the new cache along with all of the
207     // other existing caches for the origin that would not be replaced by
208     // the new cache.
209     virtual void reachedApplicationCacheOriginQuota(SecurityOrigin*, int64_t totalSpaceNeeded) = 0;
210
211 #if ENABLE(DASHBOARD_SUPPORT) || ENABLE(DRAGGABLE_REGION)
212     virtual void annotatedRegionsChanged();
213 #endif
214
215     virtual void populateVisitedLinks();
216
217     virtual FloatRect customHighlightRect(Node*, const AtomicString& type, const FloatRect& lineRect);
218     virtual void paintCustomHighlight(Node*, const AtomicString& type, const FloatRect& boxRect, const FloatRect& lineRect, bool behindText, bool entireLine);
219             
220     virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename);
221     virtual String generateReplacementFile(const String& path);
222
223     virtual bool paintCustomOverhangArea(GraphicsContext*, const IntRect&, const IntRect&, const IntRect&);
224
225 #if ENABLE(INPUT_TYPE_COLOR)
226     virtual PassOwnPtr<ColorChooser> createColorChooser(ColorChooserClient*, const Color&) = 0;
227 #endif
228
229 #if ENABLE(DATE_AND_TIME_INPUT_TYPES)
230     // This function is used for:
231     //  - Mandatory date/time choosers if !ENABLE(INPUT_MULTIPLE_FIELDS_UI)
232     //  - Date/time choosers for types for which RenderTheme::supportsCalendarPicker
233     //    returns true, if ENABLE(INPUT_MULTIPLE_FIELDS_UI)
234     //  - <datalist> UI for date/time input types regardless of
235     //    ENABLE(INPUT_MULTIPLE_FIELDS_UI)
236     virtual PassRefPtr<DateTimeChooser> openDateTimeChooser(DateTimeChooserClient*, const DateTimeChooserParameters&) = 0;
237 #endif
238
239     virtual void runOpenPanel(Frame*, PassRefPtr<FileChooser>) = 0;
240     // Asynchronous request to load an icon for specified filenames.
241     virtual void loadIconForFiles(const Vector<String>&, FileIconLoader*) = 0;
242
243 #if ENABLE(DIRECTORY_UPLOAD)
244     // Asychronous request to enumerate all files in a directory chosen by the user.
245     virtual void enumerateChosenDirectory(FileChooser*) = 0;
246 #endif
247
248     // Notification that the given form element has changed. This function
249     // will be called frequently, so handling should be very fast.
250     virtual void formStateDidChange(const Node*) = 0;
251         
252     virtual void elementDidFocus(const Node*) { };
253     virtual void elementDidBlur(const Node*) { };
254
255 #if USE(ACCELERATED_COMPOSITING)
256     // Allows ports to customize the type of graphics layers created by this page.
257     virtual GraphicsLayerFactory* graphicsLayerFactory() const { return 0; }
258
259     // Pass 0 as the GraphicsLayer to detatch the root layer.
260     virtual void attachRootGraphicsLayer(Frame*, GraphicsLayer*) = 0;
261     // Sets a flag to specify that the next time content is drawn to the window,
262     // the changes appear on the screen in synchrony with updates to GraphicsLayers.
263     virtual void setNeedsOneShotDrawingSynchronization() = 0;
264     // Sets a flag to specify that the view needs to be updated, so we need
265     // to do an eager layout before the drawing.
266     virtual void scheduleCompositingLayerFlush() = 0;
267     // Returns whether or not the client can render the composited layer,
268     // regardless of the settings.
269     virtual bool allowsAcceleratedCompositing() const { return true; }
270
271     enum CompositingTrigger {
272         ThreeDTransformTrigger = 1 << 0,
273         VideoTrigger = 1 << 1,
274         PluginTrigger = 1 << 2,
275         CanvasTrigger = 1 << 3,
276         AnimationTrigger = 1 << 4,
277         FilterTrigger = 1 << 5,
278         ScrollableInnerFrameTrigger = 1 << 6,
279         AllTriggers = 0xFFFFFFFF
280     };
281     typedef unsigned CompositingTriggerFlags;
282
283     // Returns a bitfield indicating conditions that can trigger the compositor.
284     virtual CompositingTriggerFlags allowedCompositingTriggers() const { return static_cast<CompositingTriggerFlags>(AllTriggers); }
285 #endif
286
287 #if PLATFORM(WIN) && USE(AVFOUNDATION)
288     virtual GraphicsDeviceAdapter* graphicsDeviceAdapter() const { return 0; }
289 #endif
290
291     virtual bool supportsFullscreenForNode(const Node*) { return false; }
292     virtual void enterFullscreenForNode(Node*) { }
293     virtual void exitFullscreenForNode(Node*) { }
294     virtual bool requiresFullscreenForVideoPlayback() { return false; } 
295
296 #if ENABLE(FULLSCREEN_API)
297     virtual bool supportsFullScreenForElement(const Element*, bool) { return false; }
298     virtual void enterFullScreenForElement(Element*) { }
299     virtual void exitFullScreenForElement(Element*) { }
300     virtual void fullScreenRendererChanged(RenderBox*) { }
301     virtual void setRootFullScreenLayer(GraphicsLayer*) { }
302 #endif
303
304 #if USE(TILED_BACKING_STORE)
305     virtual IntRect visibleRectForTiledBackingStore() const { return IntRect(); }
306 #endif
307
308 #if PLATFORM(MAC)
309     virtual NSResponder *firstResponder() { return 0; }
310     virtual void makeFirstResponder(NSResponder *) { }
311     // Focuses on the containing view associated with this page.
312     virtual void makeFirstResponder() { }
313     virtual void willPopUpMenu(NSMenu *) { }
314 #endif
315
316 #if PLATFORM(WIN)
317     virtual void setLastSetCursorToCurrentCursor() = 0;
318 #endif
319
320 #if ENABLE(TOUCH_EVENTS)
321     virtual void needTouchEvents(bool) = 0;
322 #endif
323
324     virtual bool selectItemWritingDirectionIsNatural() = 0;
325     virtual bool selectItemAlignmentFollowsMenuWritingDirection() = 0;
326     // Checks if there is an opened popup, called by RenderMenuList::showPopup().
327     virtual bool hasOpenedPopup() const = 0;
328     virtual PassRefPtr<PopupMenu> createPopupMenu(PopupMenuClient*) const = 0;
329     virtual PassRefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient*) const = 0;
330 #if ENABLE(PAGE_POPUP)
331     // Creates a PagePopup object, and shows it beside originBoundsInRootView.
332     // The return value can be 0.
333     virtual PagePopup* openPagePopup(PagePopupClient*, const IntRect& originBoundsInRootView) = 0;
334     virtual void closePagePopup(PagePopup*) = 0;
335     // For testing.
336     virtual void setPagePopupDriver(PagePopupDriver*) = 0;
337     virtual void resetPagePopupDriver() = 0;
338 #endif
339     // This function is called whenever a text field <input> is created. The
340     // implementation should return true if it wants to do something in
341     // addTextFieldDecorationsTo().
342     // The argument is always non-0.
343     virtual bool willAddTextFieldDecorationsTo(HTMLInputElement*) { return false; }
344     // The argument is always non-0.
345     virtual void addTextFieldDecorationsTo(HTMLInputElement*) { }
346
347     virtual void postAccessibilityNotification(AccessibilityObject*, AXObjectCache::AXNotification) { }
348
349     virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { }
350     virtual void recommendedScrollbarStyleDidChange(int /*newStyle*/) { }
351
352     enum DialogType {
353         AlertDialog = 0,
354         ConfirmDialog = 1,
355         PromptDialog = 2,
356         HTMLDialog = 3
357     };
358     virtual bool shouldRunModalDialogDuringPageDismissal(const DialogType&, const String& dialogMessage, FrameLoader::PageDismissalType) const { UNUSED_PARAM(dialogMessage); return true; }
359
360     virtual void numWheelEventHandlersChanged(unsigned) = 0;
361         
362     virtual bool isSVGImageChromeClient() const { return false; }
363
364 #if ENABLE(POINTER_LOCK)
365     virtual bool requestPointerLock() { return false; }
366     virtual void requestPointerUnlock() { }
367     virtual bool isPointerLocked() { return false; }
368 #endif
369
370     virtual void logDiagnosticMessage(const String& message, const String& description, const String& status) { UNUSED_PARAM(message); UNUSED_PARAM(description); UNUSED_PARAM(status); }
371
372     virtual FloatSize minimumWindowSize() const { return FloatSize(100, 100); };
373
374     virtual bool isEmptyChromeClient() const { return false; }
375
376     virtual PassRefPtr<Image> plugInStartLabelImage(RenderSnapshottedPlugIn::LabelSize) const { return 0; }
377
378     // FIXME: Port should return true using heuristic based on scrollable(RenderBox).
379     virtual bool shouldAutoscrollForDragAndDrop(RenderBox*) const { return false; }
380
381 protected:
382     virtual ~ChromeClient() { }
383 };
384
385 }
386 #endif // ChromeClient_h