Reviewed by Darin Adler.
[WebKit-https.git] / Source / WebKit / chromium / src / ChromeClientImpl.h
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #ifndef ChromeClientImpl_h
33 #define ChromeClientImpl_h
34
35 #include "ChromeClientChromium.h"
36 #include "PopupMenu.h"
37 #include "SearchPopupMenu.h"
38 #include "WebCoreKeyboardUIMode.h"
39
40 namespace WebCore {
41 class AccessibilityObject;
42 class Element;
43 class FileChooser;
44 class PopupContainer;
45 class PopupMenuClient;
46 class RenderBox;
47 class SecurityOrigin;
48 struct WindowFeatures;
49 }
50
51 namespace WebKit {
52 class WebViewImpl;
53 struct WebCursorInfo;
54 struct WebPopupMenuInfo;
55
56 // Handles window-level notifications from WebCore on behalf of a WebView.
57 class ChromeClientImpl : public WebCore::ChromeClientChromium {
58 public:
59     explicit ChromeClientImpl(WebViewImpl* webView);
60     virtual ~ChromeClientImpl();
61
62     WebViewImpl* webView() const { return m_webView; }
63
64     // ChromeClient methods:
65     virtual void chromeDestroyed();
66     virtual void setWindowRect(const WebCore::FloatRect&);
67     virtual WebCore::FloatRect windowRect();
68     virtual WebCore::FloatRect pageRect();
69     virtual float scaleFactor();
70     virtual void focus();
71     virtual void unfocus();
72     virtual bool canTakeFocus(WebCore::FocusDirection);
73     virtual void takeFocus(WebCore::FocusDirection);
74     virtual void focusedNodeChanged(WebCore::Node*);
75     virtual void focusedFrameChanged(WebCore::Frame*);
76     virtual WebCore::Page* createWindow(
77         WebCore::Frame*, const WebCore::FrameLoadRequest&, const WebCore::WindowFeatures&, const WebCore::NavigationAction&);
78     virtual void show();
79     virtual bool canRunModal();
80     virtual void runModal();
81     virtual void setToolbarsVisible(bool);
82     virtual bool toolbarsVisible();
83     virtual void setStatusbarVisible(bool);
84     virtual bool statusbarVisible();
85     virtual void setScrollbarsVisible(bool);
86     virtual bool scrollbarsVisible();
87     virtual void setMenubarVisible(bool);
88     virtual bool menubarVisible();
89     virtual void setResizable(bool);
90     virtual void addMessageToConsole(
91         WebCore::MessageSource, WebCore::MessageType, WebCore::MessageLevel,
92         const WTF::String& message, unsigned lineNumber,
93         const WTF::String& sourceID);
94     virtual bool canRunBeforeUnloadConfirmPanel();
95     virtual bool runBeforeUnloadConfirmPanel(
96         const WTF::String& message, WebCore::Frame*);
97     virtual void closeWindowSoon();
98     virtual void runJavaScriptAlert(WebCore::Frame*, const WTF::String&);
99     virtual bool runJavaScriptConfirm(WebCore::Frame*, const WTF::String&);
100     virtual bool runJavaScriptPrompt(
101         WebCore::Frame*, const WTF::String& message,
102         const WTF::String& defaultValue, WTF::String& result);
103     virtual void setStatusbarText(const WTF::String& message);
104     virtual bool shouldInterruptJavaScript();
105     virtual WebCore::KeyboardUIMode keyboardUIMode();
106     virtual WebCore::IntRect windowResizerRect() const;
107 #if ENABLE(REGISTER_PROTOCOL_HANDLER)
108     virtual void registerProtocolHandler(const String& scheme, const String& baseURL, const String& url, const String& title);
109 #endif
110     virtual void invalidateWindow(const WebCore::IntRect&, bool);
111     virtual void invalidateContentsAndWindow(const WebCore::IntRect&, bool);
112     virtual void invalidateContentsForSlowScroll(const WebCore::IntRect&, bool);
113 #if ENABLE(REQUEST_ANIMATION_FRAME)
114     virtual void scheduleAnimation();
115 #endif
116     virtual void scroll(
117         const WebCore::IntSize& scrollDelta, const WebCore::IntRect& rectToScroll,
118         const WebCore::IntRect& clipRect);
119     virtual WebCore::IntPoint screenToWindow(const WebCore::IntPoint&) const;
120     virtual WebCore::IntRect windowToScreen(const WebCore::IntRect&) const;
121     virtual PlatformPageClient platformPageClient() const { return 0; }
122     virtual void contentsSizeChanged(WebCore::Frame*, const WebCore::IntSize&) const;
123     virtual void scrollRectIntoView(
124         const WebCore::IntRect&, const WebCore::ScrollView*) const { }
125     virtual void scrollbarsModeDidChange() const;
126     virtual void mouseDidMoveOverElement(
127         const WebCore::HitTestResult& result, unsigned modifierFlags);
128     virtual void setToolTip(const WTF::String& tooltipText, WebCore::TextDirection);
129     virtual void print(WebCore::Frame*);
130     virtual void exceededDatabaseQuota(
131         WebCore::Frame*, const WTF::String& databaseName);
132 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
133     virtual void reachedMaxAppCacheSize(int64_t spaceNeeded);
134     virtual void reachedApplicationCacheOriginQuota(WebCore::SecurityOrigin*);
135 #endif
136 #if ENABLE(NOTIFICATIONS)
137     virtual WebCore::NotificationPresenter* notificationPresenter() const;
138 #endif
139     virtual void requestGeolocationPermissionForFrame(WebCore::Frame*, WebCore::Geolocation*);
140     virtual void cancelGeolocationPermissionRequestForFrame(WebCore::Frame*, WebCore::Geolocation*);
141     virtual void runOpenPanel(WebCore::Frame*, PassRefPtr<WebCore::FileChooser>);
142     virtual void chooseIconForFiles(const Vector<WTF::String>&, WebCore::FileChooser*);
143     virtual void setCursor(const WebCore::Cursor&);
144     virtual void formStateDidChange(const WebCore::Node*);
145 #if ENABLE(TOUCH_EVENTS)
146     // FIXME: All touch events are forwarded regardless of whether or not they are needed.
147     virtual void needTouchEvents(bool needTouchEvents) { }
148 #endif
149
150 #if USE(ACCELERATED_COMPOSITING)
151     // Pass 0 as the GraphicsLayer to detatch the root layer.
152     virtual void attachRootGraphicsLayer(WebCore::Frame*, WebCore::GraphicsLayer*);
153
154     // Sets a flag to specify that the next time content is drawn to the window,
155     // the changes appear on the screen in synchrony with updates to GraphicsLayers.
156     virtual void setNeedsOneShotDrawingSynchronization() { }
157
158     // Sets a flag to specify that the view needs to be updated, so we need
159     // to do an eager layout before the drawing.
160     virtual void scheduleCompositingLayerSync();
161
162     virtual CompositingTriggerFlags allowedCompositingTriggers() const;
163 #endif
164
165     virtual bool supportsFullscreenForNode(const WebCore::Node*);
166     virtual void enterFullscreenForNode(WebCore::Node*);
167     virtual void exitFullscreenForNode(WebCore::Node*);
168
169 #if ENABLE(FULLSCREEN_API)
170     virtual bool supportsFullScreenForElement(const WebCore::Element*);
171     virtual void enterFullScreenForElement(WebCore::Element*);
172     virtual void exitFullScreenForElement(WebCore::Element*);
173     virtual void fullScreenRendererChanged(WebCore::RenderBox*);
174 #endif
175
176     // ChromeClientChromium methods:
177     virtual void popupOpened(WebCore::PopupContainer* popupContainer,
178                              const WebCore::IntRect& bounds,
179                              bool handleExternally);
180     virtual void popupClosed(WebCore::PopupContainer* popupContainer);
181     virtual void postAccessibilityNotification(WebCore::AccessibilityObject*, WebCore::AXObjectCache::AXNotification);
182
183     // ChromeClientImpl:
184     void setCursorForPlugin(const WebCursorInfo&);
185
186     virtual bool selectItemWritingDirectionIsNatural();
187     virtual bool selectItemAlignmentFollowsMenuWritingDirection();
188     virtual PassRefPtr<WebCore::PopupMenu> createPopupMenu(WebCore::PopupMenuClient*) const;
189     virtual PassRefPtr<WebCore::SearchPopupMenu> createSearchPopupMenu(WebCore::PopupMenuClient*) const;
190
191 #if ENABLE(CONTEXT_MENUS)
192     virtual void showContextMenu() { }
193 #endif
194
195 private:
196     void getPopupMenuInfo(WebCore::PopupContainer*, WebPopupMenuInfo*);
197     void setCursor(const WebCursorInfo&);
198
199     WebViewImpl* m_webView;  // weak pointer
200     bool m_toolbarsVisible;
201     bool m_statusbarVisible;
202     bool m_scrollbarsVisible;
203     bool m_menubarVisible;
204     bool m_resizable;
205 };
206
207 } // namespace WebKit
208
209 #endif