dd0cd5a1c2163b85cce7b471e666cefd137abed2
[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 "WebColorChooserProxy.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 #if ENABLE(TOUCH_EVENTS)
59 class NativeWebTouchEvent;
60 #endif
61 #if ENABLE(GESTURE_EVENTS)
62 class WebGestureEvent;
63 #endif
64 class WebContextMenuProxy;
65 class WebEditCommandProxy;
66 class WebPopupMenuProxy;
67 #if ENABLE(INPUT_TYPE_COLOR)
68 class WebColorChooserProxy;
69 #endif
70
71 #if PLATFORM(WIN)
72 struct WindowGeometry;
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 PassOwnPtr<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     // Tell the view to scroll scrollRect by scrollOffset.
93     virtual void scrollView(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollOffset) = 0;
94
95     // Return the size of the view the page is associated with.
96     virtual WebCore::IntSize viewSize() = 0;
97
98     // Return whether the view's containing window is active.
99     virtual bool isViewWindowActive() = 0;
100
101     // Return whether the view is focused.
102     virtual bool isViewFocused() = 0;
103
104     // Return whether the view is visible.
105     virtual bool isViewVisible() = 0;
106
107     // Return whether the view is in a window.
108     virtual bool isViewInWindow() = 0;
109
110     // Return the layer hosting mode for the view.
111     virtual LayerHostingMode viewLayerHostingMode() { return LayerHostingModeDefault; }
112
113     virtual void processDidCrash() = 0;
114     virtual void didRelaunchProcess() = 0;
115     virtual void pageClosed() = 0;
116
117     virtual void toolTipChanged(const String&, const String&) = 0;
118
119 #if USE(TILED_BACKING_STORE)
120     virtual void pageDidRequestScroll(const WebCore::IntPoint&) = 0;
121     virtual void didRenderFrame(const WebCore::IntSize& contentsSize, const WebCore::IntRect& coveredRect) = 0;
122     virtual void pageTransitionViewportReady() = 0;
123 #endif
124 #if PLATFORM(QT)
125     virtual void didFindZoomableArea(const WebCore::IntPoint&, const WebCore::IntRect&) = 0;
126     virtual void didReceiveMessageFromNavigatorQtObject(const String&) = 0;
127     virtual void handleAuthenticationRequiredRequest(const String& hostname, const String& realm, const String& prefilledUsername, String& username, String& password) = 0;
128     virtual void handleCertificateVerificationRequest(const String& hostname, bool& ignoreErrors) = 0;
129     virtual void handleProxyAuthenticationRequiredRequest(const String& hostname, uint16_t port, const String& prefilledUsername, String& username, String& password) = 0;
130 #endif // PLATFORM(QT).
131
132 #if PLATFORM(QT) || PLATFORM(EFL)
133     virtual void updateTextInputState() = 0;
134 #endif // PLATFORM(QT) || PLATFORM(EFL)
135
136 #if PLATFORM(QT) || PLATFORM(EFL) || PLATFORM(GTK)
137     virtual void handleDownloadRequest(DownloadProxy*) = 0;
138 #endif // PLATFORM(QT) || PLATFORM(EFL) || PLATFORM(GTK)
139
140 #if PLATFORM(QT) || PLATFORM(EFL)
141     virtual void didChangeContentsSize(const WebCore::IntSize&) = 0;
142 #endif
143
144 #if PLATFORM(QT) || PLATFORM(GTK)
145     virtual void startDrag(const WebCore::DragData&, PassRefPtr<ShareableBitmap> dragImage) = 0;
146 #endif
147
148     virtual void setCursor(const WebCore::Cursor&) = 0;
149     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
150     virtual void didChangeViewportProperties(const WebCore::ViewportAttributes&) = 0;
151
152     virtual void registerEditCommand(PassRefPtr<WebEditCommandProxy>, WebPageProxy::UndoOrRedo) = 0;
153     virtual void clearAllEditCommands() = 0;
154     virtual bool canUndoRedo(WebPageProxy::UndoOrRedo) = 0;
155     virtual void executeUndoRedo(WebPageProxy::UndoOrRedo) = 0;
156 #if PLATFORM(MAC)
157     virtual void accessibilityWebProcessTokenReceived(const CoreIPC::DataReference&) = 0;
158     virtual bool interpretKeyEvent(const NativeWebKeyboardEvent&, Vector<WebCore::KeypressCommand>&) = 0;
159     virtual bool executeSavedCommandBySelector(const String& selector) = 0;
160     virtual void setDragImage(const WebCore::IntPoint& clientPosition, PassRefPtr<ShareableBitmap> dragImage, bool isLinkDrag) = 0;
161     virtual void updateTextInputState(bool updateSecureInputState) = 0;
162     virtual void resetTextInputState() = 0;
163     virtual void makeFirstResponder() = 0;
164     virtual void setPromisedData(const String& pasteboardName, PassRefPtr<WebCore::SharedBuffer> imageBuffer, const String& filename, const String& extension, const String& title,
165                                  const String& url, const String& visibleUrl, PassRefPtr<WebCore::SharedBuffer> archiveBuffer) = 0;
166 #endif
167 #if PLATFORM(WIN)
168     virtual void compositionSelectionChanged(bool) = 0;
169 #endif
170 #if PLATFORM(GTK)
171     virtual void getEditorCommandsForKeyEvent(const NativeWebKeyboardEvent&, const AtomicString&, Vector<WTF::String>&) = 0;
172 #endif
173     virtual WebCore::FloatRect convertToDeviceSpace(const WebCore::FloatRect&) = 0;
174     virtual WebCore::FloatRect convertToUserSpace(const WebCore::FloatRect&) = 0;
175     virtual WebCore::IntPoint screenToWindow(const WebCore::IntPoint&) = 0;
176     virtual WebCore::IntRect windowToScreen(const WebCore::IntRect&) = 0;
177     
178     virtual void doneWithKeyEvent(const NativeWebKeyboardEvent&, bool wasEventHandled) = 0;
179 #if ENABLE(GESTURE_EVENTS)
180     virtual void doneWithGestureEvent(const WebGestureEvent&, bool wasEventHandled) = 0;
181 #endif
182 #if ENABLE(TOUCH_EVENTS)
183     virtual void doneWithTouchEvent(const NativeWebTouchEvent&, bool wasEventHandled) = 0;
184 #endif
185
186     virtual PassRefPtr<WebPopupMenuProxy> createPopupMenuProxy(WebPageProxy*) = 0;
187     virtual PassRefPtr<WebContextMenuProxy> createContextMenuProxy(WebPageProxy*) = 0;
188
189 #if ENABLE(INPUT_TYPE_COLOR)
190     virtual PassRefPtr<WebColorChooserProxy> createColorChooserProxy(WebPageProxy*, const WebCore::Color& initialColor, const WebCore::IntRect&) = 0;
191 #endif
192
193     virtual void setFindIndicator(PassRefPtr<FindIndicator>, bool fadeOut, bool animate) = 0;
194 #if PLATFORM(WIN)
195     virtual void didInstallOrUninstallPageOverlay(bool) = 0;
196 #endif
197
198 #if USE(ACCELERATED_COMPOSITING)
199     virtual void enterAcceleratedCompositingMode(const LayerTreeContext&) = 0;
200     virtual void exitAcceleratedCompositingMode() = 0;
201     virtual void updateAcceleratedCompositingMode(const LayerTreeContext&) = 0;
202 #endif
203
204 #if PLATFORM(WIN)
205     virtual HWND nativeWindow() = 0;
206     virtual void setGestureReachedScrollingLimit(bool) = 0;
207     virtual void scheduleChildWindowGeometryUpdate(const WindowGeometry&) = 0;
208 #endif
209
210 #if PLATFORM(MAC)
211     virtual void pluginFocusOrWindowFocusChanged(uint64_t pluginComplexTextInputIdentifier, bool pluginHasFocusAndWindowHasFocus) = 0;
212     virtual void setPluginComplexTextInputState(uint64_t pluginComplexTextInputIdentifier, PluginComplexTextInputState) = 0;
213     virtual CGContextRef containingWindowGraphicsContext() = 0;
214     virtual void didPerformDictionaryLookup(const AttributedString&, const DictionaryPopupInfo&) = 0;
215     virtual void dismissDictionaryLookupPanel() = 0;
216     virtual void showCorrectionPanel(WebCore::AlternativeTextType, const WebCore::FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacementString, const Vector<String>& alternativeReplacementStrings) = 0;
217     virtual void dismissCorrectionPanel(WebCore::ReasonForDismissingAlternativeText) = 0;
218     virtual String dismissCorrectionPanelSoon(WebCore::ReasonForDismissingAlternativeText) = 0;
219     virtual void recordAutocorrectionResponse(WebCore::AutocorrectionResponseType, const String& replacedString, const String& replacementString) = 0;
220     virtual void recommendedScrollbarStyleDidChange(int32_t newStyle) = 0;
221
222     virtual ColorSpaceData colorSpace() = 0;
223     virtual void setAcceleratedCompositingRootLayer(CALayer *) = 0;
224
225 #if USE(APPKIT)
226     virtual WKView* wkView() const = 0;
227 #if USE(DICTATION_ALTERNATIVES)
228     virtual uint64_t addDictationAlternatives(const RetainPtr<NSTextAlternatives>&) = 0;
229     virtual void removeDictationAlternatives(uint64_t dictationContext) = 0;
230     virtual void showDictationAlternativeUI(const WebCore::FloatRect& boundingBoxOfDictatedText, uint64_t dictationContext) = 0;
231     virtual void dismissDictationAlternativeUI() = 0;
232     virtual Vector<String> dictationAlternatives(uint64_t dictationContext) = 0;
233 #endif // USE(DICTATION_ALTERNATIVES)
234 #endif // USE(APPKIT)
235 #endif // PLATFORM(MAC)
236
237     virtual void didChangeScrollbarsForMainFrame() const = 0;
238
239     // Custom representations.
240     virtual void didCommitLoadForMainFrame(bool useCustomRepresentation) = 0;
241     virtual void didFinishLoadingDataForCustomRepresentation(const String& suggestedFilename, const CoreIPC::DataReference&) = 0;
242     virtual double customRepresentationZoomFactor() = 0;
243     virtual void setCustomRepresentationZoomFactor(double) = 0;
244
245     virtual void flashBackingStoreUpdates(const Vector<WebCore::IntRect>& updateRects) = 0;
246     virtual void findStringInCustomRepresentation(const String&, FindOptions, unsigned maxMatchCount) = 0;
247     virtual void countStringMatchesInCustomRepresentation(const String&, FindOptions, unsigned maxMatchCount) = 0;
248 };
249
250 } // namespace WebKit
251
252 #endif // PageClient_h