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 "WebColorPicker.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(COCOA)
  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 struct Highlight;
  52 }
  53
  54 namespace WebKit {
  55
  56 class DrawingAreaProxy;
  57 class FindIndicator;
  58 class NativeWebKeyboardEvent;
  59 class RemoteLayerTreeTransaction;
  60 class ViewSnapshot;
  61 class WebContextMenuProxy;
  62 class WebEditCommandProxy;
  63 class WebPopupMenuProxy;
  64
  65 #if ENABLE(TOUCH_EVENTS)
  66 class NativeWebTouchEvent;
  67 #endif
  68
  69 #if ENABLE(INPUT_TYPE_COLOR)
  70 class WebColorPicker;
  71 #endif
  72
  73 #if ENABLE(FULLSCREEN_API)
  74 class WebFullScreenManagerProxyClient;
  75 #endif
  76
  77 #if PLATFORM(COCOA)
  78 struct ColorSpaceData;
  79 #endif
  80
  81 class PageClient {
  82 public:
  83     virtual ~PageClient() { }
  84
  85     // Create a new drawing area proxy for the given page.
  86     virtual std::unique_ptr<DrawingAreaProxy> createDrawingAreaProxy() = 0;
  87
  88     // Tell the view to invalidate the given rect. The rect is in view coordinates.
  89     virtual void setViewNeedsDisplay(const WebCore::IntRect&) = 0;
  90
  91     // Tell the view to immediately display its invalid rect.
  92     virtual void displayView() = 0;
  93
  94     // Return true if scrollView() can copy bits in the view.
  95     virtual bool canScrollView() = 0;
  96     // Tell the view to scroll scrollRect by scrollOffset.
  97     virtual void scrollView(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollOffset) = 0;
  98     // Tell the view to scroll to the given position, and whether this was a programmatic scroll.
  99     virtual void requestScroll(const WebCore::FloatPoint& scrollPosition, bool isProgrammaticScroll) = 0;
 100
 101     // Return the size of the view the page is associated with.
 102     virtual WebCore::IntSize viewSize() = 0;
 103
 104     // Return whether the view's containing window is active.
 105     virtual bool isViewWindowActive() = 0;
 106
 107     // Return whether the view is focused.
 108     virtual bool isViewFocused() = 0;
 109
 110     // Return whether the view is visible.
 111     virtual bool isViewVisible() = 0;
 112
 113     // Return whether the view is visible, or occluded by another window.
 114     virtual bool isViewVisibleOrOccluded() { return isViewVisible(); }
 115
 116     // Return whether the view is in a window.
 117     virtual bool isViewInWindow() = 0;
 118
 119     // Return whether the view is visually idle.
 120     virtual bool isVisuallyIdle() { return !isViewVisible(); }
 121
 122     // Return the layer hosting mode for the view.
 123     virtual LayerHostingMode viewLayerHostingMode() { return LayerHostingMode::InProcess; }
 124
 125     virtual void processDidExit() = 0;
 126     virtual void didRelaunchProcess() = 0;
 127     virtual void pageClosed() = 0;
 128
 129     virtual void preferencesDidChange() = 0;
 130
 131     virtual void toolTipChanged(const String&, const String&) = 0;
 132
 133     virtual bool decidePolicyForGeolocationPermissionRequest(WebFrameProxy&, WebSecurityOrigin&, GeolocationPermissionRequestProxy&)
 134     {
 135         return false;
 136     }
 137
 138     virtual void didCommitLoadForMainFrame(const String& mimeType, bool useCustomContentProvider) = 0;
 139
 140 #if USE(TILED_BACKING_STORE)
 141     virtual void pageDidRequestScroll(const WebCore::IntPoint&) = 0;
 142     virtual void didRenderFrame(const WebCore::IntSize& contentsSize, const WebCore::IntRect& coveredRect) = 0;
 143     virtual void pageTransitionViewportReady() = 0;
 144 #endif
 145 #if USE(COORDINATED_GRAPHICS)
 146     virtual void didFindZoomableArea(const WebCore::IntPoint&, const WebCore::IntRect&) = 0;
 147 #endif
 148
 149 #if PLATFORM(EFL) || PLATFORM(GTK)
 150     virtual void updateTextInputState() = 0;
 151 #endif // PLATFORM(EFL) || PLATOFRM(GTK)
 152
 153     virtual void handleDownloadRequest(DownloadProxy*) = 0;
 154
 155     virtual bool handleRunOpenPanel(WebPageProxy*, WebFrameProxy*, WebOpenPanelParameters*, WebOpenPanelResultListenerProxy*) { return false; }
 156
 157 #if PLATFORM(EFL)
 158     virtual void didChangeContentSize(const WebCore::IntSize&) = 0;
 159 #endif
 160
 161 #if PLATFORM(GTK)
 162     virtual void startDrag(const WebCore::DragData&, PassRefPtr<ShareableBitmap> dragImage) = 0;
 163 #endif
 164
 165     virtual void setCursor(const WebCore::Cursor&) = 0;
 166     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
 167     virtual void didChangeViewportProperties(const WebCore::ViewportAttributes&) = 0;
 168
 169     virtual void registerEditCommand(PassRefPtr<WebEditCommandProxy>, WebPageProxy::UndoOrRedo) = 0;
 170     virtual void clearAllEditCommands() = 0;
 171     virtual bool canUndoRedo(WebPageProxy::UndoOrRedo) = 0;
 172     virtual void executeUndoRedo(WebPageProxy::UndoOrRedo) = 0;
 173 #if PLATFORM(COCOA)
 174     virtual void accessibilityWebProcessTokenReceived(const IPC::DataReference&) = 0;
 175     virtual bool executeSavedCommandBySelector(const String& selector) = 0;
 176     virtual void setDragImage(const WebCore::IntPoint& clientPosition, PassRefPtr<ShareableBitmap> dragImage, bool isLinkDrag) = 0;
 177     virtual void updateSecureInputState() = 0;
 178     virtual void resetSecureInputState() = 0;
 179     virtual void notifyInputContextAboutDiscardedComposition() = 0;
 180     virtual void makeFirstResponder() = 0;
 181     virtual void setAcceleratedCompositingRootLayer(LayerOrView *) = 0;
 182     virtual LayerOrView *acceleratedCompositingRootLayer() const = 0;
 183     virtual PassRefPtr<ViewSnapshot> takeViewSnapshot() = 0;
 184     virtual void wheelEventWasNotHandledByWebCore(const NativeWebWheelEvent&) = 0;
 185     virtual void clearCustomSwipeViews() = 0;
 186 #endif
 187
 188 #if USE(APPKIT)
 189     virtual void setPromisedData(const String& pasteboardName, PassRefPtr<WebCore::SharedBuffer> imageBuffer, const String& filename, const String& extension, const String& title,
 190                                  const String& url, const String& visibleUrl, PassRefPtr<WebCore::SharedBuffer> archiveBuffer) = 0;
 191 #endif
 192
 193 #if PLATFORM(GTK)
 194     virtual void getEditorCommandsForKeyEvent(const NativeWebKeyboardEvent&, const AtomicString&, Vector<WTF::String>&) = 0;
 195 #endif
 196     virtual WebCore::FloatRect convertToDeviceSpace(const WebCore::FloatRect&) = 0;
 197     virtual WebCore::FloatRect convertToUserSpace(const WebCore::FloatRect&) = 0;
 198     virtual WebCore::IntPoint screenToRootView(const WebCore::IntPoint&) = 0;
 199     virtual WebCore::IntRect rootViewToScreen(const WebCore::IntRect&) = 0;
 200 #if PLATFORM(IOS)
 201     virtual WebCore::IntPoint accessibilityScreenToRootView(const WebCore::IntPoint&) = 0;
 202     virtual WebCore::IntRect rootViewToAccessibilityScreen(const WebCore::IntRect&) = 0;
 203 #endif
 204
 205     virtual void doneWithKeyEvent(const NativeWebKeyboardEvent&, bool wasEventHandled) = 0;
 206 #if ENABLE(TOUCH_EVENTS)
 207     virtual void doneWithTouchEvent(const NativeWebTouchEvent&, bool wasEventHandled) = 0;
 208 #endif
 209
 210     virtual PassRefPtr<WebPopupMenuProxy> createPopupMenuProxy(WebPageProxy*) = 0;
 211     virtual PassRefPtr<WebContextMenuProxy> createContextMenuProxy(WebPageProxy*) = 0;
 212
 213 #if ENABLE(INPUT_TYPE_COLOR)
 214     virtual PassRefPtr<WebColorPicker> createColorPicker(WebPageProxy*, const WebCore::Color& initialColor, const WebCore::IntRect&) = 0;
 215 #endif
 216
 217     virtual void setFindIndicator(PassRefPtr<FindIndicator>, bool fadeOut, bool animate) = 0;
 218
 219     virtual void enterAcceleratedCompositingMode(const LayerTreeContext&) = 0;
 220     virtual void exitAcceleratedCompositingMode() = 0;
 221     virtual void updateAcceleratedCompositingMode(const LayerTreeContext&) = 0;
 222
 223 #if PLATFORM(MAC)
 224     virtual void pluginFocusOrWindowFocusChanged(uint64_t pluginComplexTextInputIdentifier, bool pluginHasFocusAndWindowHasFocus) = 0;
 225     virtual void setPluginComplexTextInputState(uint64_t pluginComplexTextInputIdentifier, PluginComplexTextInputState) = 0;
 226     virtual void didPerformDictionaryLookup(const AttributedString&, const DictionaryPopupInfo&) = 0;
 227     virtual void dismissDictionaryLookupPanel() = 0;
 228     virtual void showCorrectionPanel(WebCore::AlternativeTextType, const WebCore::FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacementString, const Vector<String>& alternativeReplacementStrings) = 0;
 229     virtual void dismissCorrectionPanel(WebCore::ReasonForDismissingAlternativeText) = 0;
 230     virtual String dismissCorrectionPanelSoon(WebCore::ReasonForDismissingAlternativeText) = 0;
 231     virtual void recordAutocorrectionResponse(WebCore::AutocorrectionResponseType, const String& replacedString, const String& replacementString) = 0;
 232     virtual void recommendedScrollbarStyleDidChange(int32_t newStyle) = 0;
 233
 234     virtual ColorSpaceData colorSpace() = 0;
 235
 236 #if USE(APPKIT)
 237     virtual WKView* wkView() const = 0;
 238     virtual void intrinsicContentSizeDidChange(const WebCore::IntSize& intrinsicContentSize) = 0;
 239 #if USE(DICTATION_ALTERNATIVES)
 240     virtual uint64_t addDictationAlternatives(const RetainPtr<NSTextAlternatives>&) = 0;
 241     virtual void removeDictationAlternatives(uint64_t dictationContext) = 0;
 242     virtual void showDictationAlternativeUI(const WebCore::FloatRect& boundingBoxOfDictatedText, uint64_t dictationContext) = 0;
 243     virtual Vector<String> dictationAlternatives(uint64_t dictationContext) = 0;
 244 #endif // USE(DICTATION_ALTERNATIVES)
 245 #if USE(INSERTION_UNDO_GROUPING)
 246     virtual void registerInsertionUndoGrouping() = 0;
 247 #endif // USE(INSERTION_UNDO_GROUPING)
 248 #endif // USE(APPKIT)
 249 #endif // PLATFORM(MAC)
 250
 251 #if PLATFORM(IOS)
 252     virtual void commitPotentialTapFailed() = 0;
 253     virtual void didGetTapHighlightGeometries(uint64_t requestID, const WebCore::Color&, const Vector<WebCore::FloatQuad>& highlightedQuads, const WebCore::IntSize& topLeftRadius, const WebCore::IntSize& topRightRadius, const WebCore::IntSize& bottomLeftRadius, const WebCore::IntSize& bottomRightRadius) = 0;
 254
 255     virtual void didCommitLayerTree(const RemoteLayerTreeTransaction&) = 0;
 256     virtual void dynamicViewportUpdateChangedTarget(double newScale, const WebCore::FloatPoint& newScrollPosition, uint64_t transactionID) = 0;
 257     virtual void restorePageState(const WebCore::FloatRect&, double) = 0;
 258     virtual void restorePageCenterAndScale(const WebCore::FloatPoint&, double) = 0;
 259
 260     virtual void startAssistingNode(const AssistedNodeInformation&, bool userIsInteracting, bool blurPreviousNode, API::Object* userData) = 0;
 261     virtual void stopAssistingNode() = 0;
 262     virtual bool isAssistingNode() = 0;
 263     virtual void selectionDidChange() = 0;
 264     virtual bool interpretKeyEvent(const NativeWebKeyboardEvent&, bool isCharEvent) = 0;
 265     virtual void positionInformationDidChange(const InteractionInformationAtPosition&) = 0;
 266     virtual void saveImageToLibrary(PassRefPtr<WebCore::SharedBuffer>) = 0;
 267     virtual void didUpdateBlockSelectionWithTouch(uint32_t touch, uint32_t flags, float growThreshold, float shrinkThreshold) = 0;
 268     virtual void showPlaybackTargetPicker(bool hasVideo, const WebCore::IntRect& elementRect) = 0;
 269     virtual void zoomToRect(WebCore::FloatRect, double minimumScale, double maximumScale) = 0;
 270     virtual void didChangeViewportMetaTagWidth(float) = 0;
 271     virtual void setUsesMinimalUI(bool) = 0;
 272     virtual double minimumZoomScale() const = 0;
 273     virtual WebCore::FloatSize contentsSize() const = 0;
 274     virtual void overflowScrollViewWillStartPanGesture() = 0;
 275     virtual void overflowScrollViewDidScroll() = 0;
 276     virtual void overflowScrollWillStartScroll() = 0;
 277     virtual void overflowScrollDidEndScroll() = 0;
 278     virtual void didFinishDrawingPagesToPDF(const IPC::DataReference&) = 0;
 279     virtual Vector<String> mimeTypesWithCustomContentProviders() = 0;
 280
 281 #if ENABLE(INSPECTOR)
 282     virtual void showInspectorHighlight(const WebCore::Highlight&) = 0;
 283     virtual void hideInspectorHighlight() = 0;
 284
 285     virtual void showInspectorIndication() = 0;
 286     virtual void hideInspectorIndication() = 0;
 287
 288     virtual void enableInspectorNodeSearch() = 0;
 289     virtual void disableInspectorNodeSearch() = 0;
 290 #endif
 291 #endif
 292
 293     // Auxiliary Client Creation
 294 #if ENABLE(FULLSCREEN_API)
 295     virtual WebFullScreenManagerProxyClient& fullScreenManagerProxyClient() = 0;
 296 #endif
 297
 298     // Custom representations.
 299     virtual void didFinishLoadingDataForCustomContentProvider(const String& suggestedFilename, const IPC::DataReference&) = 0;
 300
 301     virtual void navigationGestureDidBegin() = 0;
 302     virtual void navigationGestureWillEnd(bool willNavigate, WebBackForwardListItem&) = 0;
 303     virtual void navigationGestureDidEnd(bool willNavigate, WebBackForwardListItem&) = 0;
 304     virtual void willRecordNavigationSnapshot(WebBackForwardListItem&) = 0;
 305 };
 306
 307 } // namespace WebKit
 308
 309 #endif // PageClient_h