Remove ChromeClient::willPopupMenu
[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/Vector.h>
42
43 #if ENABLE(SQL_DATABASE)
44 #include "DatabaseDetails.h"
45 #endif
46
47 OBJC_CLASS NSResponder;
48
49 namespace WebCore {
50
51 class AccessibilityObject;
52 class ColorChooser;
53 class ColorChooserClient;
54 class DateTimeChooser;
55 class DateTimeChooserClient;
56 class Element;
57 class FileChooser;
58 class FileIconLoader;
59 class FloatRect;
60 class Frame;
61 class Geolocation;
62 class GraphicsContext3D;
63 class GraphicsLayer;
64 class GraphicsLayerFactory;
65 class HitTestResult;
66 class HTMLInputElement;
67 class IntRect;
68 class NavigationAction;
69 class Node;
70 class Page;
71 class PagePopup;
72 class PagePopupClient;
73 class PagePopupDriver;
74 class PopupMenuClient;
75 class SecurityOrigin;
76 class Widget;
77
78 struct DateTimeChooserParameters;
79 struct FrameLoadRequest;
80 struct GraphicsDeviceAdapter;
81 struct ViewportArguments;
82 struct WindowFeatures;
83
84 class ChromeClient {
85 public:
86     virtual void chromeDestroyed() = 0;
87
88     virtual void setWindowRect(const FloatRect&) = 0;
89     virtual FloatRect windowRect() = 0;
90
91     virtual FloatRect pageRect() = 0;
92
93     virtual void focus() = 0;
94     virtual void unfocus() = 0;
95
96     virtual bool canTakeFocus(FocusDirection) = 0;
97     virtual void takeFocus(FocusDirection) = 0;
98
99     virtual void focusedNodeChanged(Node*) = 0;
100     virtual void focusedFrameChanged(Frame*) = 0;
101
102     // The Frame pointer provides the ChromeClient with context about which
103     // Frame wants to create the new Page. Also, the newly created window
104     // should not be shown to the user until the ChromeClient of the newly
105     // created Page has its show method called.
106     // The FrameLoadRequest parameter is only for ChromeClient to check if the
107     // request could be fulfilled. The ChromeClient should not load the request.
108     virtual Page* createWindow(Frame*, const FrameLoadRequest&, const WindowFeatures&, const NavigationAction&) = 0;
109     virtual void show() = 0;
110
111     virtual bool canRunModal() = 0;
112     virtual void runModal() = 0;
113
114     virtual void setToolbarsVisible(bool) = 0;
115     virtual bool toolbarsVisible() = 0;
116
117     virtual void setStatusbarVisible(bool) = 0;
118     virtual bool statusbarVisible() = 0;
119
120     virtual void setScrollbarsVisible(bool) = 0;
121     virtual bool scrollbarsVisible() = 0;
122
123     virtual void setMenubarVisible(bool) = 0;
124     virtual bool menubarVisible() = 0;
125
126     virtual void setResizable(bool) = 0;
127
128     virtual void addMessageToConsole(MessageSource, MessageLevel, const String& message, unsigned lineNumber, unsigned columnNumber, const String& sourceID) = 0;
129     // FIXME: Remove this MessageType variant once all the clients are updated.
130     virtual void addMessageToConsole(MessageSource source, MessageType, MessageLevel level, const String& message, unsigned lineNumber, unsigned columnNumber, const String& sourceID)
131     {
132         addMessageToConsole(source, level, message, lineNumber, columnNumber, sourceID);
133     }
134
135     virtual bool canRunBeforeUnloadConfirmPanel() = 0;
136     virtual bool runBeforeUnloadConfirmPanel(const String& message, Frame*) = 0;
137
138     virtual void closeWindowSoon() = 0;
139
140     virtual void runJavaScriptAlert(Frame*, const String&) = 0;
141     virtual bool runJavaScriptConfirm(Frame*, const String&) = 0;
142     virtual bool runJavaScriptPrompt(Frame*, const String& message, const String& defaultValue, String& result) = 0;
143     virtual void setStatusbarText(const String&) = 0;
144     virtual bool shouldInterruptJavaScript() = 0;
145     virtual KeyboardUIMode keyboardUIMode() = 0;
146
147     virtual void* webView() const = 0;
148
149     virtual IntRect windowResizerRect() const = 0;
150
151     // Methods used by HostWindow.
152     virtual bool supportsImmediateInvalidation() { return false; }
153     virtual void invalidateRootView(const IntRect&, bool immediate) = 0;
154     virtual void invalidateContentsAndRootView(const IntRect&, bool immediate) = 0;
155     virtual void invalidateContentsForSlowScroll(const IntRect&, bool immediate) = 0;
156     virtual void scroll(const IntSize&, const IntRect&, const IntRect&) = 0;
157 #if USE(TILED_BACKING_STORE)
158     virtual void delegatedScrollRequested(const IntPoint&) = 0;
159 #endif
160     virtual IntPoint screenToRootView(const IntPoint&) const = 0;
161     virtual IntRect rootViewToScreen(const IntRect&) const = 0;
162     virtual PlatformPageClient platformPageClient() const = 0;
163     virtual void scrollbarsModeDidChange() const = 0;
164     virtual void setCursor(const Cursor&) = 0;
165     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
166 #if ENABLE(REQUEST_ANIMATION_FRAME) && !USE(REQUEST_ANIMATION_FRAME_TIMER)
167     virtual void scheduleAnimation() = 0;
168 #endif
169     // End methods used by HostWindow.
170
171     virtual void dispatchViewportPropertiesDidChange(const ViewportArguments&) const { }
172
173     virtual void contentsSizeChanged(Frame*, const IntSize&) const = 0;
174     virtual void deviceOrPageScaleFactorChanged() const { }
175     virtual void layoutUpdated(Frame*) const { }
176     virtual void scrollRectIntoView(const IntRect&) const { }; // Currently only Mac has a non empty implementation.
177
178     virtual bool shouldUnavailablePluginMessageBeButton(RenderEmbeddedObject::PluginUnavailabilityReason) const { return false; }
179     virtual void unavailablePluginButtonClicked(Element*, RenderEmbeddedObject::PluginUnavailabilityReason) const { }
180     virtual void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags) = 0;
181
182     virtual void setToolTip(const String&, TextDirection) = 0;
183
184     virtual void print(Frame*) = 0;
185     virtual bool shouldRubberBandInDirection(ScrollDirection) const = 0;
186
187     virtual Color underlayColor() const { return Color(); }
188
189 #if ENABLE(SQL_DATABASE)
190     virtual void exceededDatabaseQuota(Frame*, const String& databaseName, DatabaseDetails) = 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, bool behindText, bool entireLine);
218             
219     virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename);
220     virtual String generateReplacementFile(const String& path);
221
222     virtual bool paintCustomOverhangArea(GraphicsContext*, const IntRect&, const IntRect&, const IntRect&);
223
224 #if ENABLE(INPUT_TYPE_COLOR)
225     virtual PassOwnPtr<ColorChooser> createColorChooser(ColorChooserClient*, const Color&) = 0;
226 #endif
227
228 #if ENABLE(DATE_AND_TIME_INPUT_TYPES)
229     // This function is used for:
230     //  - Mandatory date/time choosers if !ENABLE(INPUT_MULTIPLE_FIELDS_UI)
231     //  - Date/time choosers for types for which RenderTheme::supportsCalendarPicker
232     //    returns true, if ENABLE(INPUT_MULTIPLE_FIELDS_UI)
233     //  - <datalist> UI for date/time input types regardless of
234     //    ENABLE(INPUT_MULTIPLE_FIELDS_UI)
235     virtual PassRefPtr<DateTimeChooser> openDateTimeChooser(DateTimeChooserClient*, const DateTimeChooserParameters&) = 0;
236 #endif
237
238     virtual void runOpenPanel(Frame*, PassRefPtr<FileChooser>) = 0;
239     // Asynchronous request to load an icon for specified filenames.
240     virtual void loadIconForFiles(const Vector<String>&, FileIconLoader*) = 0;
241
242 #if ENABLE(DIRECTORY_UPLOAD)
243     // Asychronous request to enumerate all files in a directory chosen by the user.
244     virtual void enumerateChosenDirectory(FileChooser*) = 0;
245 #endif
246
247     // Notification that the given form element has changed. This function
248     // will be called frequently, so handling should be very fast.
249     virtual void formStateDidChange(const Node*) = 0;
250         
251     virtual void elementDidFocus(const Node*) { };
252     virtual void elementDidBlur(const Node*) { };
253
254 #if USE(ACCELERATED_COMPOSITING)
255     // Allows ports to customize the type of graphics layers created by this page.
256     virtual GraphicsLayerFactory* graphicsLayerFactory() const { return 0; }
257
258     // Pass 0 as the GraphicsLayer to detatch the root layer.
259     virtual void attachRootGraphicsLayer(Frame*, GraphicsLayer*) = 0;
260     // Sets a flag to specify that the next time content is drawn to the window,
261     // the changes appear on the screen in synchrony with updates to GraphicsLayers.
262     virtual void setNeedsOneShotDrawingSynchronization() = 0;
263     // Sets a flag to specify that the view needs to be updated, so we need
264     // to do an eager layout before the drawing.
265     virtual void scheduleCompositingLayerFlush() = 0;
266     // Returns whether or not the client can render the composited layer,
267     // regardless of the settings.
268     virtual bool allowsAcceleratedCompositing() const { return true; }
269
270     enum CompositingTrigger {
271         ThreeDTransformTrigger = 1 << 0,
272         VideoTrigger = 1 << 1,
273         PluginTrigger = 1 << 2,
274         CanvasTrigger = 1 << 3,
275         AnimationTrigger = 1 << 4,
276         FilterTrigger = 1 << 5,
277         ScrollableInnerFrameTrigger = 1 << 6,
278         AnimatedOpacityTrigger = 1 << 7,
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 #endif
314
315     virtual void enableSuddenTermination() { }
316     virtual void disableSuddenTermination() { }
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     virtual void postAccessibilityNotification(AccessibilityObject*, AXObjectCache::AXNotification) { }
342
343     virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { }
344     virtual void recommendedScrollbarStyleDidChange(int /*newStyle*/) { }
345
346     enum DialogType {
347         AlertDialog = 0,
348         ConfirmDialog = 1,
349         PromptDialog = 2,
350         HTMLDialog = 3
351     };
352     virtual bool shouldRunModalDialogDuringPageDismissal(const DialogType&, const String& dialogMessage, FrameLoader::PageDismissalType) const { UNUSED_PARAM(dialogMessage); return true; }
353
354     virtual void numWheelEventHandlersChanged(unsigned) = 0;
355         
356     virtual bool isSVGImageChromeClient() const { return false; }
357
358 #if ENABLE(POINTER_LOCK)
359     virtual bool requestPointerLock() { return false; }
360     virtual void requestPointerUnlock() { }
361     virtual bool isPointerLocked() { return false; }
362 #endif
363
364     virtual void logDiagnosticMessage(const String& message, const String& description, const String& status) { UNUSED_PARAM(message); UNUSED_PARAM(description); UNUSED_PARAM(status); }
365
366     virtual FloatSize minimumWindowSize() const { return FloatSize(100, 100); };
367
368     virtual bool isEmptyChromeClient() const { return false; }
369
370     virtual String plugInStartLabelTitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
371     virtual String plugInStartLabelSubtitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
372     virtual String plugInExtraStyleSheet() const { return String(); }
373     virtual String plugInExtraScript() const { return String(); }
374
375     // FIXME: Port should return true using heuristic based on scrollable(RenderBox).
376     virtual bool shouldAutoscrollForDragAndDrop(RenderBox*) const { return false; }
377
378     virtual void didAssociateFormControls(const Vector<RefPtr<Element> >&) { };
379     virtual bool shouldNotifyOnFormChanges() { return false; };
380
381 protected:
382     virtual ~ChromeClient() { }
383 };
384
385 }
386 #endif // ChromeClient_h