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