[iOS] Synchronize the WKContentView and UIScrollView updates with the tiles being...
[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 PLATFORM(MAC)
38 #include "PluginComplexTextInputState.h"
39
40 OBJC_CLASS CALayer;
41
42 #if USE(APPKIT)
43 OBJC_CLASS WKView;
44 OBJC_CLASS NSTextAlternatives;
45 #endif
46 #endif
47
48 namespace WebCore {
49     class Cursor;
50     struct ViewportAttributes;
51 }
52
53 namespace WebKit {
54
55 class DrawingAreaProxy;
56 class FindIndicator;
57 class NativeWebKeyboardEvent;
58 class RemoteLayerTreeTransaction;
59 class WebContextMenuProxy;
60 class WebEditCommandProxy;
61 class WebPopupMenuProxy;
62
63 #if ENABLE(TOUCH_EVENTS)
64 class NativeWebTouchEvent;
65 #endif
66
67 #if ENABLE(INPUT_TYPE_COLOR)
68 class WebColorPicker;
69 #endif
70
71 #if ENABLE(FULLSCREEN_API)
72 class WebFullScreenManagerProxyClient;
73 #endif
74
75 #if PLATFORM(MAC)
76 struct ColorSpaceData;
77 #endif
78
79 class PageClient {
80 public:
81     virtual ~PageClient() { }
82
83     // Create a new drawing area proxy for the given page.
84     virtual std::unique_ptr<DrawingAreaProxy> createDrawingAreaProxy() = 0;
85
86     // Tell the view to invalidate the given rect. The rect is in view coordinates.
87     virtual void setViewNeedsDisplay(const WebCore::IntRect&) = 0;
88
89     // Tell the view to immediately display its invalid rect.
90     virtual void displayView() = 0;
91
92     // Return true if scrollView() can copy bits in the view.
93     virtual bool canScrollView() = 0;
94     // Tell the view to scroll scrollRect by scrollOffset.
95     virtual void scrollView(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollOffset) = 0;
96
97     // Return the size of the view the page is associated with.
98     virtual WebCore::IntSize viewSize() = 0;
99
100     // Return whether the view's containing window is active.
101     virtual bool isViewWindowActive() = 0;
102
103     // Return whether the view is focused.
104     virtual bool isViewFocused() = 0;
105
106     // Return whether the view is visible.
107     virtual bool isViewVisible() = 0;
108
109     // Return whether the view is visible, or occluded by another window.
110     virtual bool isViewVisibleOrOccluded() { return isViewVisible(); }
111
112     // Return whether the view is in a window.
113     virtual bool isViewInWindow() = 0;
114
115     // Return whether the view is visually idle.
116     virtual bool isVisuallyIdle() { return !isViewVisible(); }
117
118     // Return the layer hosting mode for the view.
119     virtual LayerHostingMode viewLayerHostingMode() { return LayerHostingMode::InProcess; }
120
121     virtual void processDidExit() = 0;
122     virtual void didRelaunchProcess() = 0;
123     virtual void pageClosed() = 0;
124
125     virtual void preferencesDidChange() = 0;
126
127     virtual void toolTipChanged(const String&, const String&) = 0;
128
129     virtual bool decidePolicyForGeolocationPermissionRequest(WebFrameProxy&, WebSecurityOrigin&, GeolocationPermissionRequestProxy&)
130     {
131         return false;
132     }
133
134     virtual void didCommitLoadForMainFrame() = 0;
135
136 #if USE(TILED_BACKING_STORE)
137     virtual void pageDidRequestScroll(const WebCore::IntPoint&) = 0;
138     virtual void didRenderFrame(const WebCore::IntSize& contentsSize, const WebCore::IntRect& coveredRect) = 0;
139     virtual void pageTransitionViewportReady() = 0;
140 #endif
141 #if USE(COORDINATED_GRAPHICS)
142     virtual void didFindZoomableArea(const WebCore::IntPoint&, const WebCore::IntRect&) = 0;
143 #endif
144
145 #if PLATFORM(EFL) || PLATFORM(GTK)
146     virtual void updateTextInputState() = 0;
147 #endif // PLATFORM(EFL) || PLATOFRM(GTK)
148
149 #if PLATFORM(EFL) || PLATFORM(GTK)
150     virtual void handleDownloadRequest(DownloadProxy*) = 0;
151 #endif // PLATFORM(EFL) || PLATFORM(GTK)
152
153 #if PLATFORM(EFL)
154     virtual void didChangeContentSize(const WebCore::IntSize&) = 0;
155 #endif
156
157 #if PLATFORM(GTK)
158     virtual void startDrag(const WebCore::DragData&, PassRefPtr<ShareableBitmap> dragImage) = 0;
159 #endif
160
161     virtual void setCursor(const WebCore::Cursor&) = 0;
162     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
163     virtual void didChangeViewportProperties(const WebCore::ViewportAttributes&) = 0;
164
165     virtual void registerEditCommand(PassRefPtr<WebEditCommandProxy>, WebPageProxy::UndoOrRedo) = 0;
166     virtual void clearAllEditCommands() = 0;
167     virtual bool canUndoRedo(WebPageProxy::UndoOrRedo) = 0;
168     virtual void executeUndoRedo(WebPageProxy::UndoOrRedo) = 0;
169 #if PLATFORM(MAC)
170     virtual void accessibilityWebProcessTokenReceived(const IPC::DataReference&) = 0;
171     virtual bool interpretKeyEvent(const NativeWebKeyboardEvent&, Vector<WebCore::KeypressCommand>&) = 0;
172     virtual bool executeSavedCommandBySelector(const String& selector) = 0;
173     virtual void setDragImage(const WebCore::IntPoint& clientPosition, PassRefPtr<ShareableBitmap> dragImage, bool isLinkDrag) = 0;
174     virtual void updateSecureInputState() = 0;
175     virtual void resetSecureInputState() = 0;
176     virtual void notifyInputContextAboutDiscardedComposition() = 0;
177     virtual void makeFirstResponder() = 0;
178     virtual void setAcceleratedCompositingRootLayer(CALayer *) = 0;
179     virtual CALayer *acceleratedCompositingRootLayer() const = 0;
180     virtual RetainPtr<CGImageRef> takeViewSnapshot() = 0;
181     virtual void wheelEventWasNotHandledByWebCore(const NativeWebWheelEvent&) = 0;
182     virtual void clearCustomSwipeViews() = 0;
183 #endif
184
185 #if USE(APPKIT)
186     virtual void setPromisedData(const String& pasteboardName, PassRefPtr<WebCore::SharedBuffer> imageBuffer, const String& filename, const String& extension, const String& title,
187                                  const String& url, const String& visibleUrl, PassRefPtr<WebCore::SharedBuffer> archiveBuffer) = 0;
188 #endif
189
190 #if PLATFORM(GTK)
191     virtual void getEditorCommandsForKeyEvent(const NativeWebKeyboardEvent&, const AtomicString&, Vector<WTF::String>&) = 0;
192 #endif
193     virtual WebCore::FloatRect convertToDeviceSpace(const WebCore::FloatRect&) = 0;
194     virtual WebCore::FloatRect convertToUserSpace(const WebCore::FloatRect&) = 0;
195     virtual WebCore::IntPoint screenToWindow(const WebCore::IntPoint&) = 0;
196     virtual WebCore::IntRect windowToScreen(const WebCore::IntRect&) = 0;
197     
198     virtual void doneWithKeyEvent(const NativeWebKeyboardEvent&, bool wasEventHandled) = 0;
199 #if ENABLE(TOUCH_EVENTS)
200     virtual void doneWithTouchEvent(const NativeWebTouchEvent&, bool wasEventHandled) = 0;
201 #endif
202
203     virtual PassRefPtr<WebPopupMenuProxy> createPopupMenuProxy(WebPageProxy*) = 0;
204     virtual PassRefPtr<WebContextMenuProxy> createContextMenuProxy(WebPageProxy*) = 0;
205
206 #if ENABLE(INPUT_TYPE_COLOR)
207     virtual PassRefPtr<WebColorPicker> createColorPicker(WebPageProxy*, const WebCore::Color& initialColor, const WebCore::IntRect&) = 0;
208 #endif
209
210     virtual void setFindIndicator(PassRefPtr<FindIndicator>, bool fadeOut, bool animate) = 0;
211
212     virtual void enterAcceleratedCompositingMode(const LayerTreeContext&) = 0;
213     virtual void exitAcceleratedCompositingMode() = 0;
214     virtual void updateAcceleratedCompositingMode(const LayerTreeContext&) = 0;
215
216 #if !PLATFORM(IOS) && PLATFORM(MAC)
217     virtual void pluginFocusOrWindowFocusChanged(uint64_t pluginComplexTextInputIdentifier, bool pluginHasFocusAndWindowHasFocus) = 0;
218     virtual void setPluginComplexTextInputState(uint64_t pluginComplexTextInputIdentifier, PluginComplexTextInputState) = 0;
219     virtual void didPerformDictionaryLookup(const AttributedString&, const DictionaryPopupInfo&) = 0;
220     virtual void dismissDictionaryLookupPanel() = 0;
221     virtual void showCorrectionPanel(WebCore::AlternativeTextType, const WebCore::FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacementString, const Vector<String>& alternativeReplacementStrings) = 0;
222     virtual void dismissCorrectionPanel(WebCore::ReasonForDismissingAlternativeText) = 0;
223     virtual String dismissCorrectionPanelSoon(WebCore::ReasonForDismissingAlternativeText) = 0;
224     virtual void recordAutocorrectionResponse(WebCore::AutocorrectionResponseType, const String& replacedString, const String& replacementString) = 0;
225     virtual void recommendedScrollbarStyleDidChange(int32_t newStyle) = 0;
226
227     virtual ColorSpaceData colorSpace() = 0;
228
229 #if USE(APPKIT)
230     virtual WKView* wkView() const = 0;
231     virtual void intrinsicContentSizeDidChange(const WebCore::IntSize& intrinsicContentSize) = 0;
232 #if USE(DICTATION_ALTERNATIVES)
233     virtual uint64_t addDictationAlternatives(const RetainPtr<NSTextAlternatives>&) = 0;
234     virtual void removeDictationAlternatives(uint64_t dictationContext) = 0;
235     virtual void showDictationAlternativeUI(const WebCore::FloatRect& boundingBoxOfDictatedText, uint64_t dictationContext) = 0;
236     virtual Vector<String> dictationAlternatives(uint64_t dictationContext) = 0;
237 #endif // USE(DICTATION_ALTERNATIVES)
238 #endif // USE(APPKIT)
239 #endif // PLATFORM(MAC)
240
241 #if PLATFORM(IOS)
242     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;
243
244     virtual void didCommitLayerTree(const RemoteLayerTreeTransaction&) = 0;
245
246     virtual void startAssistingNode(const WebCore::IntRect&, bool hasNextFocusable, bool hasPreviousFocusable) = 0;
247     virtual void stopAssistingNode() = 0;
248     virtual void selectionDidChange() = 0;
249     virtual bool interpretKeyEvent(const NativeWebKeyboardEvent&, bool isCharEvent) = 0;
250     virtual void positionInformationDidChange(const InteractionInformationAtPosition&) = 0;
251     virtual void saveImageToLibrary(PassRefPtr<WebCore::SharedBuffer>) = 0;
252 #endif
253
254     // Auxiliary Client Creation
255 #if ENABLE(FULLSCREEN_API)
256     virtual WebFullScreenManagerProxyClient& fullScreenManagerProxyClient() = 0;
257 #endif
258 };
259
260 } // namespace WebKit
261
262 #endif // PageClient_h