Pass the right color space over to the web process so we can set it on our CA context
[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 "WebPageProxy.h"
31 #include "WebPopupMenuProxy.h"
32 #include <WebCore/AlternativeTextClient.h>
33 #include <WebCore/EditorClient.h>
34 #include <wtf/Forward.h>
35
36 #if PLATFORM(MAC)
37 #include "PluginComplexTextInputState.h"
38
39 #if USE(APPKIT)
40 OBJC_CLASS WKView;
41 #endif
42 #endif
43
44 namespace WebCore {
45     class Cursor;
46     struct ViewportAttributes;
47 }
48
49 namespace WebKit {
50
51 class DrawingAreaProxy;
52 class FindIndicator;
53 class NativeWebKeyboardEvent;
54 #if ENABLE(TOUCH_EVENTS)
55 class NativeWebTouchEvent;
56 #endif
57 #if ENABLE(GESTURE_EVENTS)
58 class WebGestureEvent;
59 #endif
60 class WebContextMenuProxy;
61 class WebEditCommandProxy;
62 class WebPopupMenuProxy;
63
64 #if PLATFORM(WIN)
65 struct WindowGeometry;
66 #endif
67
68 #if PLATFORM(MAC)
69 struct ColorSpaceData;
70 #endif
71
72 class PageClient {
73 public:
74     virtual ~PageClient() { }
75
76     // Create a new drawing area proxy for the given page.
77     virtual PassOwnPtr<DrawingAreaProxy> createDrawingAreaProxy() = 0;
78
79     // Tell the view to invalidate the given rect. The rect is in view coordinates.
80     virtual void setViewNeedsDisplay(const WebCore::IntRect&) = 0;
81
82     // Tell the view to immediately display its invalid rect.
83     virtual void displayView() = 0;
84
85     // Tell the view to scroll scrollRect by scrollOffset.
86     virtual void scrollView(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollOffset) = 0;
87
88     // Return the size of the view the page is associated with.
89     virtual WebCore::IntSize viewSize() = 0;
90
91     // Return whether the view's containing window is active.
92     virtual bool isViewWindowActive() = 0;
93
94     // Return whether the view is focused.
95     virtual bool isViewFocused() = 0;
96
97     // Return whether the view is visible.
98     virtual bool isViewVisible() = 0;
99
100     // Return whether the view is in a window.
101     virtual bool isViewInWindow() = 0;
102
103     // Return the layer hosting mode for the view.
104     virtual LayerHostingMode viewLayerHostingMode() { return LayerHostingModeDefault; }
105
106     virtual void processDidCrash() = 0;
107     virtual void didRelaunchProcess() = 0;
108     virtual void pageClosed() = 0;
109
110     virtual void toolTipChanged(const String&, const String&) = 0;
111
112 #if USE(TILED_BACKING_STORE)
113     virtual void pageDidRequestScroll(const WebCore::IntPoint&) = 0;
114 #endif
115 #if PLATFORM(QT)
116     virtual void didChangeContentsSize(const WebCore::IntSize&) = 0;
117     virtual void didFindZoomableArea(const WebCore::IntPoint&, const WebCore::IntRect&) = 0;
118     virtual void didReceiveMessageFromNavigatorQtObject(const String&) = 0;
119     virtual void handleDownloadRequest(DownloadProxy*) = 0;
120     virtual void updateTextInputState() = 0;
121     virtual void handleAuthenticationRequiredRequest(const String& hostname, const String& realm, const String& prefilledUsername, String& username, String& password) = 0;
122     virtual void handleCertificateVerificationRequest(const String& hostname, bool& ignoreErrors) = 0;
123     virtual void handleProxyAuthenticationRequiredRequest(const String& hostname, uint16_t port, const String& prefilledUsername, String& username, String& password) = 0;
124 #endif // PLATFORM(QT).
125
126 #if PLATFORM(QT) || PLATFORM(GTK)
127     virtual void startDrag(const WebCore::DragData&, PassRefPtr<ShareableBitmap> dragImage) = 0;
128 #endif
129
130     virtual void setCursor(const WebCore::Cursor&) = 0;
131     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
132     virtual void didChangeViewportProperties(const WebCore::ViewportAttributes&) = 0;
133
134     virtual void registerEditCommand(PassRefPtr<WebEditCommandProxy>, WebPageProxy::UndoOrRedo) = 0;
135     virtual void clearAllEditCommands() = 0;
136     virtual bool canUndoRedo(WebPageProxy::UndoOrRedo) = 0;
137     virtual void executeUndoRedo(WebPageProxy::UndoOrRedo) = 0;
138 #if PLATFORM(MAC)
139     virtual void accessibilityWebProcessTokenReceived(const CoreIPC::DataReference&) = 0;
140     virtual bool interpretKeyEvent(const NativeWebKeyboardEvent&, Vector<WebCore::KeypressCommand>&) = 0;
141     virtual bool executeSavedCommandBySelector(const String& selector) = 0;
142     virtual void setDragImage(const WebCore::IntPoint& clientPosition, PassRefPtr<ShareableBitmap> dragImage, bool isLinkDrag) = 0;
143     virtual void updateTextInputState(bool updateSecureInputState) = 0;
144     virtual void resetTextInputState() = 0;
145     virtual void makeFirstResponder() = 0;
146     virtual void setPromisedData(const String& pasteboardName, PassRefPtr<WebCore::SharedBuffer> imageBuffer, const String& filename, const String& extension, const String& title,
147                                  const String& url, const String& visibleUrl, PassRefPtr<WebCore::SharedBuffer> archiveBuffer) = 0;
148 #endif
149 #if PLATFORM(WIN)
150     virtual void compositionSelectionChanged(bool) = 0;
151 #endif
152 #if PLATFORM(GTK)
153     virtual void getEditorCommandsForKeyEvent(const NativeWebKeyboardEvent&, const AtomicString&, Vector<WTF::String>&) = 0;
154 #endif
155     virtual WebCore::FloatRect convertToDeviceSpace(const WebCore::FloatRect&) = 0;
156     virtual WebCore::FloatRect convertToUserSpace(const WebCore::FloatRect&) = 0;
157     virtual WebCore::IntPoint screenToWindow(const WebCore::IntPoint&) = 0;
158     virtual WebCore::IntRect windowToScreen(const WebCore::IntRect&) = 0;
159     
160     virtual void doneWithKeyEvent(const NativeWebKeyboardEvent&, bool wasEventHandled) = 0;
161 #if ENABLE(GESTURE_EVENTS)
162     virtual void doneWithGestureEvent(const WebGestureEvent&, bool wasEventHandled) = 0;
163 #endif
164 #if ENABLE(TOUCH_EVENTS)
165     virtual void doneWithTouchEvent(const NativeWebTouchEvent&, bool wasEventHandled) = 0;
166 #endif
167
168     virtual PassRefPtr<WebPopupMenuProxy> createPopupMenuProxy(WebPageProxy*) = 0;
169     virtual PassRefPtr<WebContextMenuProxy> createContextMenuProxy(WebPageProxy*) = 0;
170
171     virtual void setFindIndicator(PassRefPtr<FindIndicator>, bool fadeOut, bool animate) = 0;
172 #if PLATFORM(WIN)
173     virtual void didInstallOrUninstallPageOverlay(bool) = 0;
174 #endif
175
176 #if USE(ACCELERATED_COMPOSITING)
177     virtual void enterAcceleratedCompositingMode(const LayerTreeContext&) = 0;
178     virtual void exitAcceleratedCompositingMode() = 0;
179     virtual void updateAcceleratedCompositingMode(const LayerTreeContext&) = 0;
180 #endif
181
182 #if PLATFORM(WIN)
183     virtual HWND nativeWindow() = 0;
184     virtual void setGestureReachedScrollingLimit(bool) = 0;
185     virtual void scheduleChildWindowGeometryUpdate(const WindowGeometry&) = 0;
186 #endif
187
188 #if PLATFORM(MAC)
189     virtual void pluginFocusOrWindowFocusChanged(uint64_t pluginComplexTextInputIdentifier, bool pluginHasFocusAndWindowHasFocus) = 0;
190     virtual void setPluginComplexTextInputState(uint64_t pluginComplexTextInputIdentifier, PluginComplexTextInputState) = 0;
191     virtual CGContextRef containingWindowGraphicsContext() = 0;
192     virtual void didPerformDictionaryLookup(const String&, double scaleFactor, const DictionaryPopupInfo&) = 0;
193     virtual void dismissDictionaryLookupPanel() = 0;
194     virtual void showCorrectionPanel(WebCore::AlternativeTextType, const WebCore::FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacementString, const Vector<String>& alternativeReplacementStrings) = 0;
195     virtual void dismissCorrectionPanel(WebCore::ReasonForDismissingAlternativeText) = 0;
196     virtual String dismissCorrectionPanelSoon(WebCore::ReasonForDismissingAlternativeText) = 0;
197     virtual void recordAutocorrectionResponse(WebCore::AutocorrectionResponseType, const String& replacedString, const String& replacementString) = 0;
198     virtual void recommendedScrollbarStyleDidChange(int32_t newStyle) = 0;
199
200     virtual ColorSpaceData colorSpace() = 0;
201
202 #if USE(APPKIT)
203     virtual WKView* wkView() const = 0;
204 #endif
205 #endif
206
207     virtual void didChangeScrollbarsForMainFrame() const = 0;
208
209     // Custom representations.
210     virtual void didCommitLoadForMainFrame(bool useCustomRepresentation) = 0;
211     virtual void didFinishLoadingDataForCustomRepresentation(const String& suggestedFilename, const CoreIPC::DataReference&) = 0;
212     virtual double customRepresentationZoomFactor() = 0;
213     virtual void setCustomRepresentationZoomFactor(double) = 0;
214
215     virtual void flashBackingStoreUpdates(const Vector<WebCore::IntRect>& updateRects) = 0;
216     virtual void findStringInCustomRepresentation(const String&, FindOptions, unsigned maxMatchCount) = 0;
217     virtual void countStringMatchesInCustomRepresentation(const String&, FindOptions, unsigned maxMatchCount) = 0;
218 };
219
220 } // namespace WebKit
221
222 #endif // PageClient_h