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