Reviewed and landed by Sam Weinig.
[WebKit-https.git] / Source / WebKit2 / UIProcess / PageClient.h
1 /*
2  * Copyright (C) 2010 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 <wtf/Forward.h>
33
34 namespace WebCore {
35     class Cursor;
36     struct ViewportArguments;
37 }
38
39 namespace WebKit {
40
41 class DrawingAreaProxy;
42 class FindIndicator;
43 class NativeWebKeyboardEvent;
44 class NativeWebKeyboardEvent;
45 class WebContextMenuProxy;
46 class WebEditCommandProxy;
47 class WebPopupMenuProxy;
48
49 class PageClient {
50 public:
51     virtual ~PageClient() { }
52
53     // Create a new drawing area proxy for the given page.
54     virtual PassOwnPtr<DrawingAreaProxy> createDrawingAreaProxy() = 0;
55
56     // Tell the view to invalidate the given rect. The rect is in view coordinates.
57     virtual void setViewNeedsDisplay(const WebCore::IntRect&) = 0;
58
59     // Tell the view to immediately display its invalid rect.
60     virtual void displayView() = 0;
61
62     // Tell the view to scroll scrollRect by scrollOffset.
63     virtual void scrollView(const WebCore::IntRect& scrollRect, const WebCore::IntSize& scrollOffset) = 0;
64
65     // Return the size of the view the page is associated with.
66     virtual WebCore::IntSize viewSize() = 0;
67
68     // Return whether the view's containing window is active.
69     virtual bool isViewWindowActive() = 0;
70
71     // Return whether the view is focused.
72     virtual bool isViewFocused() = 0;
73
74     // Return whether the view is visible.
75     virtual bool isViewVisible() = 0;
76
77     // Return whether the view is in a window.
78     virtual bool isViewInWindow() = 0;
79     
80     virtual void processDidCrash() = 0;
81     virtual void didRelaunchProcess() = 0;
82     virtual void pageClosed() = 0;
83
84     virtual void takeFocus(bool direction) = 0;
85     virtual void toolTipChanged(const String&, const String&) = 0;
86
87 #if ENABLE(TILED_BACKING_STORE)
88     virtual void pageDidRequestScroll(const WebCore::IntSize&) = 0;
89 #endif
90 #if PLATFORM(QT)
91     virtual void didChangeContentsSize(const WebCore::IntSize&) = 0;
92     virtual void didFindZoomableArea(const WebCore::IntRect&) = 0;
93 #endif
94
95     virtual void setCursor(const WebCore::Cursor&) = 0;
96     virtual void setViewportArguments(const WebCore::ViewportArguments&) = 0;
97
98     virtual void registerEditCommand(PassRefPtr<WebEditCommandProxy>, WebPageProxy::UndoOrRedo) = 0;
99     virtual void clearAllEditCommands() = 0;
100     virtual void setEditCommandState(const String& commandName, bool isEnabled, int state) = 0;
101 #if PLATFORM(MAC)
102     virtual void accessibilityWebProcessTokenReceived(const CoreIPC::DataReference&) = 0;
103     virtual void interceptKeyEvent(const NativeWebKeyboardEvent&, Vector<WebCore::KeypressCommand>& commandName, uint32_t selectionStart, uint32_t selectionEnd, Vector<WebCore::CompositionUnderline>& underlines) = 0;
104     virtual void setDragImage(const WebCore::IntPoint& clientPosition, const WebCore::IntSize& imageSize, PassRefPtr<ShareableBitmap> dragImage, bool isLinkDrag) = 0;
105 #endif
106 #if PLATFORM(WIN)
107     virtual void compositionSelectionChanged(bool) = 0;
108 #endif
109     virtual WebCore::FloatRect convertToDeviceSpace(const WebCore::FloatRect&) = 0;
110     virtual WebCore::FloatRect convertToUserSpace(const WebCore::FloatRect&) = 0;
111
112     virtual void doneWithKeyEvent(const NativeWebKeyboardEvent&, bool wasEventHandled) = 0;
113
114     virtual PassRefPtr<WebPopupMenuProxy> createPopupMenuProxy(WebPageProxy*) = 0;
115     virtual PassRefPtr<WebContextMenuProxy> createContextMenuProxy(WebPageProxy*) = 0;
116
117     virtual void setFindIndicator(PassRefPtr<FindIndicator>, bool fadeOut) = 0;
118
119 #if USE(ACCELERATED_COMPOSITING)
120     virtual void enterAcceleratedCompositingMode(const LayerTreeContext&) = 0;
121     virtual void exitAcceleratedCompositingMode() = 0;
122     
123     virtual void pageDidEnterAcceleratedCompositing() = 0;
124     virtual void pageDidLeaveAcceleratedCompositing() = 0;
125 #endif
126
127 #if PLATFORM(WIN)
128     virtual HWND nativeWindow() = 0;
129 #endif
130
131 #if PLATFORM(MAC)
132     virtual void setComplexTextInputEnabled(uint64_t pluginComplexTextInputIdentifier, bool complexTextInputEnabled) = 0;
133     virtual void setAutodisplay(bool) = 0;
134
135     virtual CGContextRef containingWindowGraphicsContext() = 0;
136 #endif
137
138     virtual void didChangeScrollbarsForMainFrame() const = 0;
139
140     // Custom representations.
141     virtual void didCommitLoadForMainFrame(bool useCustomRepresentation) = 0;
142     virtual void didFinishLoadingDataForCustomRepresentation(const CoreIPC::DataReference&) = 0;
143     virtual double customRepresentationZoomFactor() = 0;
144     virtual void setCustomRepresentationZoomFactor(double) = 0;
145 };
146
147 } // namespace WebKit
148
149 #endif // PageClient_h