ValueProfile/PredictedType contains dead code, and doesn't recognize functions
[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/EditorClient.h>
33 #include <WebCore/SpellingCorrectionController.h>
34 #include <wtf/Forward.h>
35
36 #if PLATFORM(MAC)
37 #include "PluginComplexTextInputState.h"
38
39 OBJC_CLASS WKView;
40 #endif
41
42 namespace WebCore {
43     class Cursor;
44     struct ViewportArguments;
45 }
46
47 #if PLATFORM(QT)
48 class QtWebPageProxy;
49 #endif
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 class WebContextMenuProxy;
60 class WebEditCommandProxy;
61 class WebPopupMenuProxy;
62
63 #if PLATFORM(WIN)
64 struct WindowGeometry;
65 #endif
66
67 class PageClient {
68 public:
69     virtual ~PageClient() { }
70
71     // Create a new drawing area proxy for the given page.
72     virtual PassOwnPtr<DrawingAreaProxy> createDrawingAreaProxy() = 0;
73
74     // Tell the view to invalidate the given rect. The rect is in view coordinates.
75     virtual void setViewNeedsDisplay(const WebCore::IntRect&) = 0;
76
77     // Tell the view to immediately display its invalid rect.
78     virtual void displayView() = 0;
79
80     // Tell the view to scroll scrollRect by scrollOffset.
81     virtual void scrollView(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollOffset) = 0;
82
83     // Return the size of the view the page is associated with.
84     virtual WebCore::IntSize viewSize() = 0;
85
86     // Return whether the view's containing window is active.
87     virtual bool isViewWindowActive() = 0;
88
89     // Return whether the view is focused.
90     virtual bool isViewFocused() = 0;
91
92     // Return whether the view is visible.
93     virtual bool isViewVisible() = 0;
94
95     // Return whether the view is in a window.
96     virtual bool isViewInWindow() = 0;
97     
98     virtual void processDidCrash() = 0;
99     virtual void didRelaunchProcess() = 0;
100     virtual void pageClosed() = 0;
101
102     virtual void toolTipChanged(const String&, const String&) = 0;
103
104 #if USE(TILED_BACKING_STORE)
105     virtual void pageDidRequestScroll(const WebCore::IntPoint&) = 0;
106 #endif
107 #if PLATFORM(QT)
108     virtual void didChangeContentsSize(const WebCore::IntSize&) = 0;
109     virtual void didFindZoomableArea(const WebCore::IntPoint&, const WebCore::IntRect&) = 0;
110     virtual void didReceiveMessageFromNavigatorQtObject(const String&) = 0;
111     virtual void handleDownloadRequest(DownloadProxy*) = 0;
112 #endif
113
114 #if PLATFORM(QT) || PLATFORM(GTK)
115     virtual void startDrag(const WebCore::DragData&, PassRefPtr<ShareableBitmap> dragImage) = 0;
116 #endif
117
118     virtual void setCursor(const WebCore::Cursor&) = 0;
119     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
120     virtual void didChangeViewportProperties(const WebCore::ViewportArguments&) = 0;
121
122     virtual void registerEditCommand(PassRefPtr<WebEditCommandProxy>, WebPageProxy::UndoOrRedo) = 0;
123     virtual void clearAllEditCommands() = 0;
124     virtual bool canUndoRedo(WebPageProxy::UndoOrRedo) = 0;
125     virtual void executeUndoRedo(WebPageProxy::UndoOrRedo) = 0;
126 #if PLATFORM(MAC)
127     virtual void accessibilityWebProcessTokenReceived(const CoreIPC::DataReference&) = 0;
128     virtual bool interpretKeyEvent(const NativeWebKeyboardEvent&, Vector<WebCore::KeypressCommand>&) = 0;
129     virtual bool executeSavedCommandBySelector(const String& selector) = 0;
130     virtual void setDragImage(const WebCore::IntPoint& clientPosition, PassRefPtr<ShareableBitmap> dragImage, bool isLinkDrag) = 0;
131     virtual void updateTextInputState(bool updateSecureInputState) = 0;
132     virtual void resetTextInputState() = 0;
133     virtual void makeFirstResponder() = 0;
134 #endif
135 #if PLATFORM(WIN)
136     virtual void compositionSelectionChanged(bool) = 0;
137 #endif
138 #if PLATFORM(GTK)
139     virtual void getEditorCommandsForKeyEvent(const NativeWebKeyboardEvent&, const AtomicString&, Vector<WTF::String>&) = 0;
140 #endif
141     virtual WebCore::FloatRect convertToDeviceSpace(const WebCore::FloatRect&) = 0;
142     virtual WebCore::FloatRect convertToUserSpace(const WebCore::FloatRect&) = 0;
143     virtual WebCore::IntPoint screenToWindow(const WebCore::IntPoint&) = 0;
144     virtual WebCore::IntRect windowToScreen(const WebCore::IntRect&) = 0;
145     
146     virtual void doneWithKeyEvent(const NativeWebKeyboardEvent&, bool wasEventHandled) = 0;
147 #if ENABLE(TOUCH_EVENTS)
148     virtual void doneWithTouchEvent(const NativeWebTouchEvent&, bool wasEventHandled) = 0;
149 #endif
150
151     virtual PassRefPtr<WebPopupMenuProxy> createPopupMenuProxy(WebPageProxy*) = 0;
152     virtual PassRefPtr<WebContextMenuProxy> createContextMenuProxy(WebPageProxy*) = 0;
153
154     virtual void setFindIndicator(PassRefPtr<FindIndicator>, bool fadeOut) = 0;
155 #if PLATFORM(WIN)
156     virtual void didInstallOrUninstallPageOverlay(bool) = 0;
157 #endif
158
159 #if USE(ACCELERATED_COMPOSITING)
160     virtual void enterAcceleratedCompositingMode(const LayerTreeContext&) = 0;
161     virtual void exitAcceleratedCompositingMode() = 0;
162 #endif
163
164 #if PLATFORM(WIN)
165     virtual HWND nativeWindow() = 0;
166     virtual void setGestureReachedScrollingLimit(bool) = 0;
167     virtual void scheduleChildWindowGeometryUpdate(const WindowGeometry&) = 0;
168 #endif
169
170 #if PLATFORM(MAC)
171     virtual void pluginFocusOrWindowFocusChanged(uint64_t pluginComplexTextInputIdentifier, bool pluginHasFocusAndWindowHasFocus) = 0;
172     virtual void setPluginComplexTextInputState(uint64_t pluginComplexTextInputIdentifier, PluginComplexTextInputState) = 0;
173     virtual CGContextRef containingWindowGraphicsContext() = 0;
174     virtual void didPerformDictionaryLookup(const String&, double scaleFactor, const DictionaryPopupInfo&) = 0;
175     virtual void dismissDictionaryLookupPanel() = 0;
176     virtual void showCorrectionPanel(WebCore::CorrectionPanelInfo::PanelType, const WebCore::FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacementString, const Vector<String>& alternativeReplacementStrings) = 0;
177     virtual void dismissCorrectionPanel(WebCore::ReasonForDismissingCorrectionPanel) = 0;
178     virtual String dismissCorrectionPanelSoon(WebCore::ReasonForDismissingCorrectionPanel) = 0;
179     virtual void recordAutocorrectionResponse(WebCore::EditorClient::AutocorrectionResponseType, const String& replacedString, const String& replacementString) = 0;
180     
181     virtual WKView* wkView() const = 0;
182 #endif
183
184     virtual void didChangeScrollbarsForMainFrame() const = 0;
185
186     // Custom representations.
187     virtual void didCommitLoadForMainFrame(bool useCustomRepresentation) = 0;
188     virtual void didFinishLoadingDataForCustomRepresentation(const String& suggestedFilename, const CoreIPC::DataReference&) = 0;
189     virtual double customRepresentationZoomFactor() = 0;
190     virtual void setCustomRepresentationZoomFactor(double) = 0;
191
192     virtual void flashBackingStoreUpdates(const Vector<WebCore::IntRect>& updateRects) = 0;
193     virtual void findStringInCustomRepresentation(const String&, FindOptions, unsigned maxMatchCount) = 0;
194     virtual void countStringMatchesInCustomRepresentation(const String&, FindOptions, unsigned maxMatchCount) = 0;
195 };
196
197 } // namespace WebKit
198
199 #endif // PageClient_h