b78d274d348629945796e8f72faadc85055021e8
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / mac / PageClientImpl.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 PageClientImpl_h
27 #define PageClientImpl_h
28
29 #include "CorrectionPanel.h"
30 #include "PageClient.h"
31 #include <wtf/RetainPtr.h>
32
33 @class WKEditorUndoTargetObjC;
34 @class WKView;
35
36 namespace WebCore {
37 class AlternativeTextUIController;
38 }
39
40 namespace WebKit {
41 class FindIndicatorWindow;
42
43 class PageClientImpl FINAL : public PageClient {
44 public:
45     static PassOwnPtr<PageClientImpl> create(WKView*);
46     virtual ~PageClientImpl();
47     
48     void viewWillMoveToAnotherWindow();
49
50 private:
51     explicit PageClientImpl(WKView*);
52
53     virtual PassOwnPtr<DrawingAreaProxy> createDrawingAreaProxy();
54     virtual void setViewNeedsDisplay(const WebCore::IntRect&);
55     virtual void displayView();
56     virtual bool canScrollView();
57     virtual void scrollView(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollOffset);
58
59     virtual WebCore::IntSize viewSize();
60     virtual bool isViewWindowActive();
61     virtual bool isViewFocused();
62     virtual bool isViewVisible();
63     virtual bool isViewInWindow();
64     virtual LayerHostingMode viewLayerHostingMode() OVERRIDE;
65     virtual ColorSpaceData colorSpace() OVERRIDE;
66     virtual void setAcceleratedCompositingRootLayer(CALayer *) OVERRIDE;
67
68     virtual void processDidCrash();
69     virtual void pageClosed();
70     virtual void didRelaunchProcess();
71     virtual void toolTipChanged(const String& oldToolTip, const String& newToolTip);
72     virtual void setCursor(const WebCore::Cursor&);
73     virtual void setCursorHiddenUntilMouseMoves(bool);
74     virtual void didChangeViewportProperties(const WebCore::ViewportAttributes&);
75
76     virtual void registerEditCommand(PassRefPtr<WebEditCommandProxy>, WebPageProxy::UndoOrRedo);
77     virtual void clearAllEditCommands();
78     virtual bool canUndoRedo(WebPageProxy::UndoOrRedo);
79     virtual void executeUndoRedo(WebPageProxy::UndoOrRedo);
80     virtual bool interpretKeyEvent(const NativeWebKeyboardEvent&, Vector<WebCore::KeypressCommand>&);
81     virtual bool executeSavedCommandBySelector(const String& selector);
82     virtual void setDragImage(const WebCore::IntPoint& clientPosition, PassRefPtr<ShareableBitmap> dragImage, bool isLinkDrag);
83     virtual void setPromisedData(const String& pasteboardName, PassRefPtr<WebCore::SharedBuffer> imageBuffer, const String& filename, const String& extension, const String& title,
84                                  const String& url, const String& visibleUrl, PassRefPtr<WebCore::SharedBuffer> archiveBuffer);
85     virtual void updateTextInputState(bool updateSecureInputState);
86     virtual void resetSecureInputState() OVERRIDE;
87     virtual void notifyInputContextAboutDiscardedComposition() OVERRIDE;
88
89     virtual WebCore::FloatRect convertToDeviceSpace(const WebCore::FloatRect&);
90     virtual WebCore::FloatRect convertToUserSpace(const WebCore::FloatRect&);
91     virtual WebCore::IntPoint screenToWindow(const WebCore::IntPoint&);
92     virtual WebCore::IntRect windowToScreen(const WebCore::IntRect&);
93
94 #if ENABLE(GESTURE_EVENTS)
95     virtual void doneWithGestureEvent(const WebGestureEvent&, bool wasEventHandled);
96 #endif
97     virtual void doneWithKeyEvent(const NativeWebKeyboardEvent&, bool wasEventHandled);
98
99     virtual PassRefPtr<WebPopupMenuProxy> createPopupMenuProxy(WebPageProxy*);
100     virtual PassRefPtr<WebContextMenuProxy> createContextMenuProxy(WebPageProxy*);
101
102 #if ENABLE(INPUT_TYPE_COLOR)
103     virtual PassRefPtr<WebColorChooserProxy> createColorChooserProxy(WebPageProxy*, const WebCore::Color& initialColor, const WebCore::IntRect&);
104 #endif
105
106     void setFindIndicator(PassRefPtr<FindIndicator>, bool fadeOut, bool animate);
107
108     virtual void enterAcceleratedCompositingMode(const LayerTreeContext&);
109     virtual void exitAcceleratedCompositingMode();
110     virtual void updateAcceleratedCompositingMode(const LayerTreeContext&);
111
112     virtual void accessibilityWebProcessTokenReceived(const CoreIPC::DataReference&);
113
114     virtual void pluginFocusOrWindowFocusChanged(uint64_t pluginComplexTextInputIdentifier, bool pluginHasFocusAndWindowHasFocus);
115     virtual void setPluginComplexTextInputState(uint64_t pluginComplexTextInputIdentifier, PluginComplexTextInputState);
116
117     virtual void makeFirstResponder();
118     
119     virtual CGContextRef containingWindowGraphicsContext();
120
121     virtual void didCommitLoadForMainFrame(bool useCustomRepresentation);
122     virtual void didFinishLoadingDataForCustomRepresentation(const String& suggestedFilename, const CoreIPC::DataReference&);
123
124     virtual double customRepresentationZoomFactor();
125     virtual void setCustomRepresentationZoomFactor(double);
126     virtual void findStringInCustomRepresentation(const String&, FindOptions, unsigned maxMatchCount);
127     virtual void countStringMatchesInCustomRepresentation(const String&, FindOptions, unsigned maxMatchCount);
128
129     virtual void flashBackingStoreUpdates(const Vector<WebCore::IntRect>& updateRects);
130
131     virtual void didPerformDictionaryLookup(const AttributedString&, const DictionaryPopupInfo&);
132     virtual void dismissDictionaryLookupPanel();
133
134     virtual void showCorrectionPanel(WebCore::AlternativeTextType, const WebCore::FloatRect& boundingBoxOfReplacedString, const String& replacedString, const String& replacementString, const Vector<String>& alternativeReplacementStrings);
135     virtual void dismissCorrectionPanel(WebCore::ReasonForDismissingAlternativeText);
136     virtual String dismissCorrectionPanelSoon(WebCore::ReasonForDismissingAlternativeText);
137     virtual void recordAutocorrectionResponse(WebCore::AutocorrectionResponseType, const String& replacedString, const String& replacementString);
138
139     virtual void recommendedScrollbarStyleDidChange(int32_t newStyle);
140
141     virtual WKView* wkView() const { return m_wkView; }
142     virtual void intrinsicContentSizeDidChange(const WebCore::IntSize& intrinsicContentSize) OVERRIDE;
143
144 #if USE(DICTATION_ALTERNATIVES)
145     virtual uint64_t addDictationAlternatives(const RetainPtr<NSTextAlternatives>&);
146     virtual void removeDictationAlternatives(uint64_t dictationContext);
147     virtual void showDictationAlternativeUI(const WebCore::FloatRect& boundingBoxOfDictatedText, uint64_t dictationContext);
148     virtual Vector<String> dictationAlternatives(uint64_t dictationContext);
149 #endif
150
151     WKView* m_wkView;
152     RetainPtr<WKEditorUndoTargetObjC> m_undoTarget;
153 #if USE(AUTOCORRECTION_PANEL)
154     CorrectionPanel m_correctionPanel;
155 #endif
156 #if USE(DICTATION_ALTERNATIVES)
157     OwnPtr<WebCore::AlternativeTextUIController> m_alternativeTextUIController;
158 #endif
159 };
160
161 } // namespace WebKit
162
163 #endif // PageClientImpl_h