Combine ActionMenuHitTestResult with WebHitTestResult
[WebKit-https.git] / Source / WebKit2 / UIProcess / PageClient.h
1 /*
2  * Copyright (C) 2010, 2011 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef PageClient_h
27 #define PageClient_h
28
29 #include "ShareableBitmap.h"
30 #include "WebColorPicker.h"
31 #include "WebPageProxy.h"
32 #include "WebPopupMenuProxy.h"
33 #include <WebCore/AlternativeTextClient.h>
34 #include <WebCore/EditorClient.h>
35 #include <wtf/Forward.h>
36
37 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
38 #include <WebCore/MediaPlaybackTargetPicker.h>
39 #endif
40
41 #if PLATFORM(COCOA)
42 #include "PluginComplexTextInputState.h"
43
44 OBJC_CLASS CALayer;
45
46 #if USE(APPKIT)
47 OBJC_CLASS WKView;
48 OBJC_CLASS NSTextAlternatives;
49 #endif
50 #endif
51
52 namespace WebCore {
53 class Cursor;
54 class TextIndicator;
55 struct Highlight;
56 struct ViewportAttributes;
57 }
58
59 namespace WebKit {
60
61 class DrawingAreaProxy;
62 class NativeWebKeyboardEvent;
63 class RemoteLayerTreeTransaction;
64 class ViewSnapshot;
65 class WebContextMenuProxy;
66 class WebEditCommandProxy;
67 class WebPopupMenuProxy;
68
69 #if ENABLE(TOUCH_EVENTS)
70 class NativeWebTouchEvent;
71 #endif
72
73 #if ENABLE(INPUT_TYPE_COLOR)
74 class WebColorPicker;
75 #endif
76
77 #if ENABLE(FULLSCREEN_API)
78 class WebFullScreenManagerProxyClient;
79 #endif
80
81 #if PLATFORM(COCOA)
82 struct ColorSpaceData;
83 #endif
84
85 class PageClient {
86 public:
87     virtual ~PageClient() { }
88
89     // Create a new drawing area proxy for the given page.
90     virtual std::unique_ptr<DrawingAreaProxy> createDrawingAreaProxy() = 0;
91
92     // Tell the view to invalidate the given rect. The rect is in view coordinates.
93     virtual void setViewNeedsDisplay(const WebCore::IntRect&) = 0;
94
95     // Tell the view to immediately display its invalid rect.
96     virtual void displayView() = 0;
97
98     // Return true if scrollView() can copy bits in the view.
99     virtual bool canScrollView() = 0;
100     // Tell the view to scroll scrollRect by scrollOffset.
101     virtual void scrollView(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollOffset) = 0;
102     // Tell the view to scroll to the given position, and whether this was a programmatic scroll.
103     virtual void requestScroll(const WebCore::FloatPoint& scrollPosition, bool isProgrammaticScroll) = 0;
104
105     // Return the size of the view the page is associated with.
106     virtual WebCore::IntSize viewSize() = 0;
107
108     // Return whether the view's containing window is active.
109     virtual bool isViewWindowActive() = 0;
110
111     // Return whether the view is focused.
112     virtual bool isViewFocused() = 0;
113
114     // Return whether the view is visible.
115     virtual bool isViewVisible() = 0;
116
117     // Return whether the view is visible, or occluded by another window.
118     virtual bool isViewVisibleOrOccluded() { return isViewVisible(); }
119
120     // Return whether the view is in a window.
121     virtual bool isViewInWindow() = 0;
122
123     // Return whether the view is visually idle.
124     virtual bool isVisuallyIdle() { return !isViewVisible(); }
125
126     // Return the layer hosting mode for the view.
127     virtual LayerHostingMode viewLayerHostingMode() { return LayerHostingMode::InProcess; }
128
129     virtual void processDidExit() = 0;
130     virtual void didRelaunchProcess() = 0;
131     virtual void pageClosed() = 0;
132
133     virtual void preferencesDidChange() = 0;
134
135     virtual void toolTipChanged(const String&, const String&) = 0;
136
137     virtual bool decidePolicyForGeolocationPermissionRequest(WebFrameProxy&, API::SecurityOrigin&, GeolocationPermissionRequestProxy&)
138     {
139         return false;
140     }
141
142     virtual void didCommitLoadForMainFrame(const String& mimeType, bool useCustomContentProvider) = 0;
143
144 #if USE(COORDINATED_GRAPHICS_MULTIPROCESS)
145     virtual void pageDidRequestScroll(const WebCore::IntPoint&) = 0;
146     virtual void didRenderFrame(const WebCore::IntSize& contentsSize, const WebCore::IntRect& coveredRect) = 0;
147     virtual void pageTransitionViewportReady() = 0;
148     virtual void didFindZoomableArea(const WebCore::IntPoint&, const WebCore::IntRect&) = 0;
149 #endif
150
151 #if PLATFORM(EFL) || PLATFORM(GTK)
152     virtual void updateTextInputState() = 0;
153 #endif // PLATFORM(EFL) || PLATOFRM(GTK)
154
155     virtual void handleDownloadRequest(DownloadProxy*) = 0;
156
157     virtual bool handleRunOpenPanel(WebPageProxy*, WebFrameProxy*, WebOpenPanelParameters*, WebOpenPanelResultListenerProxy*) { return false; }
158
159     virtual void didChangeContentSize(const WebCore::IntSize&) = 0;
160
161 #if PLATFORM(GTK) && ENABLE(DRAG_SUPPORT)
162     virtual void startDrag(const WebCore::DragData&, PassRefPtr<ShareableBitmap> dragImage) = 0;
163 #endif
164
165     virtual void setCursor(const WebCore::Cursor&) = 0;
166     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
167     virtual void didChangeViewportProperties(const WebCore::ViewportAttributes&) = 0;
168
169     virtual void registerEditCommand(PassRefPtr<WebEditCommandProxy>, WebPageProxy::UndoOrRedo) = 0;
170     virtual void clearAllEditCommands() = 0;
171     virtual bool canUndoRedo(WebPageProxy::UndoOrRedo) = 0;
172     virtual void executeUndoRedo(WebPageProxy::UndoOrRedo) = 0;
173 #if PLATFORM(COCOA)
174     virtual void accessibilityWebProcessTokenReceived(const IPC::DataReference&) = 0;
175     virtual bool executeSavedCommandBySelector(const String& selector) = 0;
176     virtual void setDragImage(const WebCore::IntPoint& clientPosition, PassRefPtr<ShareableBitmap> dragImage, bool isLinkDrag) = 0;
177     virtual void updateSecureInputState() = 0;
178     virtual void resetSecureInputState() = 0;
179     virtual void notifyInputContextAboutDiscardedComposition() = 0;
180     virtual void makeFirstResponder() = 0;
181     virtual void setAcceleratedCompositingRootLayer(LayerOrView *) = 0;
182     virtual LayerOrView *acceleratedCompositingRootLayer() const = 0;
183     virtual PassRefPtr<ViewSnapshot> takeViewSnapshot() = 0;
184     virtual void wheelEventWasNotHandledByWebCore(const NativeWebWheelEvent&) = 0;
185     virtual void selectionDidChange() = 0;
186 #endif
187
188 #if PLATFORM(MAC) && !USE(ASYNC_NSTEXTINPUTCLIENT)
189     virtual void notifyApplicationAboutInputContextChange() = 0;
190 #endif
191
192 #if USE(APPKIT)
193     virtual void setPromisedDataForImage(const String& pasteboardName, PassRefPtr<WebCore::SharedBuffer> imageBuffer, const String& filename, const String& extension, const String& title,
194                                  const String& url, const String& visibleUrl, PassRefPtr<WebCore::SharedBuffer> archiveBuffer) = 0;
195 #if ENABLE(ATTACHMENT_ELEMENT)
196     virtual void setPromisedDataForAttachment(const String& pasteboardName, const String& filename, const String& extension, const String& title,
197                                          const String& url, const String& visibleUrl) = 0;
198
199 #endif
200 #endif
201
202 #if PLATFORM(GTK)
203     virtual void getEditorCommandsForKeyEvent(const NativeWebKeyboardEvent&, const AtomicString&, Vector<WTF::String>&) = 0;
204 #endif
205     virtual WebCore::FloatRect convertToDeviceSpace(const WebCore::FloatRect&) = 0;
206     virtual WebCore::FloatRect convertToUserSpace(const WebCore::FloatRect&) = 0;
207     virtual WebCore::IntPoint screenToRootView(const WebCore::IntPoint&) = 0;
208     virtual WebCore::IntRect rootViewToScreen(const WebCore::IntRect&) = 0;
209 #if PLATFORM(IOS)
210     virtual WebCore::IntPoint accessibilityScreenToRootView(const WebCore::IntPoint&) = 0;
211     virtual WebCore::IntRect rootViewToAccessibilityScreen(const WebCore::IntRect&) = 0;
212 #endif
213     
214     virtual void doneWithKeyEvent(const NativeWebKeyboardEvent&, bool wasEventHandled) = 0;
215 #if ENABLE(TOUCH_EVENTS)
216     virtual void doneWithTouchEvent(const NativeWebTouchEvent&, bool wasEventHandled) = 0;
217 #endif
218
219     virtual PassRefPtr<WebPopupMenuProxy> createPopupMenuProxy(WebPageProxy*) = 0;
220     virtual PassRefPtr<WebContextMenuProxy> createContextMenuProxy(WebPageProxy*) = 0;
221
222 #if ENABLE(INPUT_TYPE_COLOR)
223     virtual PassRefPtr<WebColorPicker> createColorPicker(WebPageProxy*, const WebCore::Color& initialColor, const WebCore::IntRect&) = 0;
224 #endif
225
226     virtual void setTextIndicator(PassRefPtr<WebCore::TextIndicator>, bool fadeOut) = 0;
227     virtual void setTextIndicatorAnimationProgress(float) = 0;
228
229     virtual void enterAcceleratedCompositingMode(const LayerTreeContext&) = 0;
230     virtual void exitAcceleratedCompositingMode() = 0;
231     virtual void updateAcceleratedCompositingMode(const LayerTreeContext&) = 0;
232
233 #if PLATFORM(MAC)
234     virtual void pluginFocusOrWindowFocusChanged(uint64_t pluginComplexTextInputIdentifier, bool pluginHasFocusAndWindowHasFocus) = 0;
235     virtual void setPluginComplexTextInputState(uint64_t pluginComplexTextInputIdentifier, PluginComplexTextInputState) = 0;
236     virtual void didPerformDictionaryLookup(const DictionaryPopupInfo&) = 0;
237     virtual void dismissContentRelativeChildWindows() = 0;
238     virtual void showCorrectionPanel(WebCore::AlternativeTextType, const WebCore::FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacementString, const Vector<String>& alternativeReplacementStrings) = 0;
239     virtual void dismissCorrectionPanel(WebCore::ReasonForDismissingAlternativeText) = 0;
240     virtual String dismissCorrectionPanelSoon(WebCore::ReasonForDismissingAlternativeText) = 0;
241     virtual void recordAutocorrectionResponse(WebCore::AutocorrectionResponseType, const String& replacedString, const String& replacementString) = 0;
242     virtual void recommendedScrollbarStyleDidChange(WebCore::ScrollbarStyle) = 0;
243     virtual void removeNavigationGestureSnapshot() = 0;
244
245     virtual CGRect boundsOfLayerInLayerBackedWindowCoordinates(CALayer *) const = 0;
246
247     virtual ColorSpaceData colorSpace() = 0;
248
249     virtual void showPlatformContextMenu(NSMenu *, WebCore::IntPoint) = 0;
250
251 #if USE(APPKIT)
252     virtual WKView* wkView() const = 0;
253     virtual void intrinsicContentSizeDidChange(const WebCore::IntSize& intrinsicContentSize) = 0;
254 #if USE(DICTATION_ALTERNATIVES)
255     virtual uint64_t addDictationAlternatives(const RetainPtr<NSTextAlternatives>&) = 0;
256     virtual void removeDictationAlternatives(uint64_t dictationContext) = 0;
257     virtual void showDictationAlternativeUI(const WebCore::FloatRect& boundingBoxOfDictatedText, uint64_t dictationContext) = 0;
258     virtual Vector<String> dictationAlternatives(uint64_t dictationContext) = 0;
259 #endif // USE(DICTATION_ALTERNATIVES)
260 #if USE(INSERTION_UNDO_GROUPING)
261     virtual void registerInsertionUndoGrouping() = 0;
262 #endif // USE(INSERTION_UNDO_GROUPING)
263 #endif // USE(APPKIT)
264 #endif // PLATFORM(MAC)
265
266 #if PLATFORM(IOS)
267     virtual void commitPotentialTapFailed() = 0;
268     virtual void didGetTapHighlightGeometries(uint64_t requestID, const WebCore::Color&, const Vector<WebCore::FloatQuad>& highlightedQuads, const WebCore::IntSize& topLeftRadius, const WebCore::IntSize& topRightRadius, const WebCore::IntSize& bottomLeftRadius, const WebCore::IntSize& bottomRightRadius) = 0;
269
270     virtual void didCommitLayerTree(const RemoteLayerTreeTransaction&) = 0;
271     virtual void dynamicViewportUpdateChangedTarget(double newScale, const WebCore::FloatPoint& newScrollPosition, uint64_t transactionID) = 0;
272     virtual void restorePageState(const WebCore::FloatRect&, double) = 0;
273     virtual void restorePageCenterAndScale(const WebCore::FloatPoint&, double) = 0;
274
275     virtual void startAssistingNode(const AssistedNodeInformation&, bool userIsInteracting, bool blurPreviousNode, API::Object* userData) = 0;
276     virtual void stopAssistingNode() = 0;
277     virtual bool isAssistingNode() = 0;
278     virtual bool interpretKeyEvent(const NativeWebKeyboardEvent&, bool isCharEvent) = 0;
279     virtual void positionInformationDidChange(const InteractionInformationAtPosition&) = 0;
280     virtual void saveImageToLibrary(PassRefPtr<WebCore::SharedBuffer>) = 0;
281     virtual void didUpdateBlockSelectionWithTouch(uint32_t touch, uint32_t flags, float growThreshold, float shrinkThreshold) = 0;
282     virtual void showPlaybackTargetPicker(bool hasVideo, const WebCore::IntRect& elementRect) = 0;
283     virtual void zoomToRect(WebCore::FloatRect, double minimumScale, double maximumScale) = 0;
284     virtual void didChangeViewportMetaTagWidth(float) = 0;
285     virtual double minimumZoomScale() const = 0;
286     virtual WebCore::FloatSize contentsSize() const = 0;
287     virtual void overflowScrollViewWillStartPanGesture() = 0;
288     virtual void overflowScrollViewDidScroll() = 0;
289     virtual void overflowScrollWillStartScroll() = 0;
290     virtual void overflowScrollDidEndScroll() = 0;
291     virtual void didFinishDrawingPagesToPDF(const IPC::DataReference&) = 0;
292     virtual Vector<String> mimeTypesWithCustomContentProviders() = 0;
293
294     virtual void showInspectorHighlight(const WebCore::Highlight&) = 0;
295     virtual void hideInspectorHighlight() = 0;
296
297     virtual void showInspectorIndication() = 0;
298     virtual void hideInspectorIndication() = 0;
299
300     virtual void enableInspectorNodeSearch() = 0;
301     virtual void disableInspectorNodeSearch() = 0;
302 #endif
303
304     // Auxiliary Client Creation
305 #if ENABLE(FULLSCREEN_API)
306     virtual WebFullScreenManagerProxyClient& fullScreenManagerProxyClient() = 0;
307 #endif
308
309     // Custom representations.
310     virtual void didFinishLoadingDataForCustomContentProvider(const String& suggestedFilename, const IPC::DataReference&) = 0;
311
312     virtual void navigationGestureDidBegin() = 0;
313     virtual void navigationGestureWillEnd(bool willNavigate, WebBackForwardListItem&) = 0;
314     virtual void navigationGestureDidEnd(bool willNavigate, WebBackForwardListItem&) = 0;
315     virtual void willRecordNavigationSnapshot(WebBackForwardListItem&) = 0;
316
317     virtual void didFirstVisuallyNonEmptyLayoutForMainFrame() = 0;
318     virtual void didFinishLoadForMainFrame() = 0;
319     virtual void didSameDocumentNavigationForMainFrame(SameDocumentNavigationType) = 0;
320
321     virtual void didChangeBackgroundColor() = 0;
322
323 #if PLATFORM(MAC)
324     virtual void didPerformActionMenuHitTest(const WebHitTestResult::Data&, bool forImmediateAction, bool contentPreventsDefault, API::Object*) = 0;
325 #endif
326
327 #if ENABLE(WIRELESS_PLAYBACK_TARGET) && !PLATFORM(IOS)
328     virtual std::unique_ptr<WebCore::MediaPlaybackTargetPicker> createPlaybackTargetPicker(WebPageProxy*) = 0;
329 #endif
330
331 };
332
333 } // namespace WebKit
334
335 #endif // PageClient_h