d52f5d25e0bccab93c71471190e332e3805972fc
[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 #if USE(APPKIT)
41 OBJC_CLASS WKView;
42 OBJC_CLASS NSTextAlternatives;
43 #endif
44 #endif
45
46 namespace WebCore {
47     class Cursor;
48     struct ViewportAttributes;
49 }
50
51 namespace WebKit {
52
53 class DrawingAreaProxy;
54 class FindIndicator;
55 class NativeWebKeyboardEvent;
56 #if ENABLE(TOUCH_EVENTS)
57 class NativeWebTouchEvent;
58 #endif
59 #if ENABLE(GESTURE_EVENTS)
60 class WebGestureEvent;
61 #endif
62 class WebContextMenuProxy;
63 class WebEditCommandProxy;
64 class WebPopupMenuProxy;
65 #if ENABLE(INPUT_TYPE_COLOR)
66 class WebColorChooserProxy;
67 #endif
68
69 #if PLATFORM(WIN)
70 struct WindowGeometry;
71 #endif
72
73 #if PLATFORM(MAC)
74 struct ColorSpaceData;
75 #endif
76
77 class PageClient {
78 public:
79     virtual ~PageClient() { }
80
81     // Create a new drawing area proxy for the given page.
82     virtual PassOwnPtr<DrawingAreaProxy> createDrawingAreaProxy() = 0;
83
84     // Tell the view to invalidate the given rect. The rect is in view coordinates.
85     virtual void setViewNeedsDisplay(const WebCore::IntRect&) = 0;
86
87     // Tell the view to immediately display its invalid rect.
88     virtual void displayView() = 0;
89
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 #endif
120 #if PLATFORM(QT)
121     virtual void didRenderFrame(const WebCore::IntSize& contentsSize) = 0;
122     virtual void pageTransitionViewportReady() = 0;
123     virtual void didFindZoomableArea(const WebCore::IntPoint&, const WebCore::IntRect&) = 0;
124     virtual void didReceiveMessageFromNavigatorQtObject(const String&) = 0;
125     virtual void updateTextInputState() = 0;
126     virtual void handleAuthenticationRequiredRequest(const String& hostname, const String& realm, const String& prefilledUsername, String& username, String& password) = 0;
127     virtual void handleCertificateVerificationRequest(const String& hostname, bool& ignoreErrors) = 0;
128     virtual void handleProxyAuthenticationRequiredRequest(const String& hostname, uint16_t port, const String& prefilledUsername, String& username, String& password) = 0;
129 #endif // PLATFORM(QT).
130
131 #if PLATFORM(QT) || PLATFORM(EFL)
132     virtual void handleDownloadRequest(DownloadProxy*) = 0;
133 #endif // PLATFORM(QT) || PLATFORM(EFL)
134
135 #if PLATFORM(QT) || PLATFORM(EFL)
136     virtual void didChangeContentsSize(const WebCore::IntSize&) = 0;
137 #endif
138
139 #if PLATFORM(QT) || PLATFORM(GTK)
140     virtual void startDrag(const WebCore::DragData&, PassRefPtr<ShareableBitmap> dragImage) = 0;
141 #endif
142
143     virtual void setCursor(const WebCore::Cursor&) = 0;
144     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
145     virtual void didChangeViewportProperties(const WebCore::ViewportAttributes&) = 0;
146
147     virtual void registerEditCommand(PassRefPtr<WebEditCommandProxy>, WebPageProxy::UndoOrRedo) = 0;
148     virtual void clearAllEditCommands() = 0;
149     virtual bool canUndoRedo(WebPageProxy::UndoOrRedo) = 0;
150     virtual void executeUndoRedo(WebPageProxy::UndoOrRedo) = 0;
151 #if PLATFORM(MAC)
152     virtual void accessibilityWebProcessTokenReceived(const CoreIPC::DataReference&) = 0;
153     virtual bool interpretKeyEvent(const NativeWebKeyboardEvent&, Vector<WebCore::KeypressCommand>&) = 0;
154     virtual bool executeSavedCommandBySelector(const String& selector) = 0;
155     virtual void setDragImage(const WebCore::IntPoint& clientPosition, PassRefPtr<ShareableBitmap> dragImage, bool isLinkDrag) = 0;
156     virtual void updateTextInputState(bool updateSecureInputState) = 0;
157     virtual void resetTextInputState() = 0;
158     virtual void makeFirstResponder() = 0;
159     virtual void setPromisedData(const String& pasteboardName, PassRefPtr<WebCore::SharedBuffer> imageBuffer, const String& filename, const String& extension, const String& title,
160                                  const String& url, const String& visibleUrl, PassRefPtr<WebCore::SharedBuffer> archiveBuffer) = 0;
161 #endif
162 #if PLATFORM(WIN)
163     virtual void compositionSelectionChanged(bool) = 0;
164 #endif
165 #if PLATFORM(GTK)
166     virtual void getEditorCommandsForKeyEvent(const NativeWebKeyboardEvent&, const AtomicString&, Vector<WTF::String>&) = 0;
167 #endif
168     virtual WebCore::FloatRect convertToDeviceSpace(const WebCore::FloatRect&) = 0;
169     virtual WebCore::FloatRect convertToUserSpace(const WebCore::FloatRect&) = 0;
170     virtual WebCore::IntPoint screenToWindow(const WebCore::IntPoint&) = 0;
171     virtual WebCore::IntRect windowToScreen(const WebCore::IntRect&) = 0;
172     
173     virtual void doneWithKeyEvent(const NativeWebKeyboardEvent&, bool wasEventHandled) = 0;
174 #if ENABLE(GESTURE_EVENTS)
175     virtual void doneWithGestureEvent(const WebGestureEvent&, bool wasEventHandled) = 0;
176 #endif
177 #if ENABLE(TOUCH_EVENTS)
178     virtual void doneWithTouchEvent(const NativeWebTouchEvent&, bool wasEventHandled) = 0;
179 #endif
180
181     virtual PassRefPtr<WebPopupMenuProxy> createPopupMenuProxy(WebPageProxy*) = 0;
182     virtual PassRefPtr<WebContextMenuProxy> createContextMenuProxy(WebPageProxy*) = 0;
183
184 #if ENABLE(INPUT_TYPE_COLOR)
185     virtual PassRefPtr<WebColorChooserProxy> createColorChooserProxy(WebPageProxy*, const WebCore::Color& initialColor, const WebCore::IntRect&) = 0;
186 #endif
187
188     virtual void setFindIndicator(PassRefPtr<FindIndicator>, bool fadeOut, bool animate) = 0;
189 #if PLATFORM(WIN)
190     virtual void didInstallOrUninstallPageOverlay(bool) = 0;
191 #endif
192
193 #if USE(ACCELERATED_COMPOSITING)
194     virtual void enterAcceleratedCompositingMode(const LayerTreeContext&) = 0;
195     virtual void exitAcceleratedCompositingMode() = 0;
196     virtual void updateAcceleratedCompositingMode(const LayerTreeContext&) = 0;
197 #endif
198
199 #if PLATFORM(WIN)
200     virtual HWND nativeWindow() = 0;
201     virtual void setGestureReachedScrollingLimit(bool) = 0;
202     virtual void scheduleChildWindowGeometryUpdate(const WindowGeometry&) = 0;
203 #endif
204
205 #if PLATFORM(MAC)
206     virtual void pluginFocusOrWindowFocusChanged(uint64_t pluginComplexTextInputIdentifier, bool pluginHasFocusAndWindowHasFocus) = 0;
207     virtual void setPluginComplexTextInputState(uint64_t pluginComplexTextInputIdentifier, PluginComplexTextInputState) = 0;
208     virtual CGContextRef containingWindowGraphicsContext() = 0;
209     virtual void didPerformDictionaryLookup(const String&, double scaleFactor, const DictionaryPopupInfo&) = 0;
210     virtual void dismissDictionaryLookupPanel() = 0;
211     virtual void showCorrectionPanel(WebCore::AlternativeTextType, const WebCore::FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacementString, const Vector<String>& alternativeReplacementStrings) = 0;
212     virtual void dismissCorrectionPanel(WebCore::ReasonForDismissingAlternativeText) = 0;
213     virtual String dismissCorrectionPanelSoon(WebCore::ReasonForDismissingAlternativeText) = 0;
214     virtual void recordAutocorrectionResponse(WebCore::AutocorrectionResponseType, const String& replacedString, const String& replacementString) = 0;
215     virtual void recommendedScrollbarStyleDidChange(int32_t newStyle) = 0;
216
217     virtual ColorSpaceData colorSpace() = 0;
218
219 #if USE(APPKIT)
220     virtual WKView* wkView() const = 0;
221 #if USE(DICTATION_ALTERNATIVES)
222     virtual uint64_t addDictationAlternatives(const RetainPtr<NSTextAlternatives>&) = 0;
223     virtual void removeDictationAlternatives(uint64_t dictationContext) = 0;
224     virtual void showDictationAlternativeUI(const WebCore::FloatRect& boundingBoxOfDictatedText, uint64_t dictationContext) = 0;
225     virtual void dismissDictationAlternativeUI() = 0;
226     virtual Vector<String> dictationAlternatives(uint64_t dictationContext) = 0;
227 #endif // USE(DICTATION_ALTERNATIVES)
228 #endif // USE(APPKIT)
229 #endif // PLATFORM(MAC)
230
231     virtual void didChangeScrollbarsForMainFrame() const = 0;
232
233     // Custom representations.
234     virtual void didCommitLoadForMainFrame(bool useCustomRepresentation) = 0;
235     virtual void didFinishLoadingDataForCustomRepresentation(const String& suggestedFilename, const CoreIPC::DataReference&) = 0;
236     virtual double customRepresentationZoomFactor() = 0;
237     virtual void setCustomRepresentationZoomFactor(double) = 0;
238
239     virtual void flashBackingStoreUpdates(const Vector<WebCore::IntRect>& updateRects) = 0;
240     virtual void findStringInCustomRepresentation(const String&, FindOptions, unsigned maxMatchCount) = 0;
241     virtual void countStringMatchesInCustomRepresentation(const String&, FindOptions, unsigned maxMatchCount) = 0;
242 };
243
244 } // namespace WebKit
245
246 #endif // PageClient_h