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