Partially revert 104427, change WebWidgetClient::didHandleGestureEvent semantics.
[WebKit-https.git] / Source / WebKit / chromium / public / WebWidgetClient.h
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebWidgetClient_h
32 #define WebWidgetClient_h
33
34 #include "WebNavigationPolicy.h"
35 #include "WebScreenInfo.h"
36 #include "platform/WebCommon.h"
37 #include "platform/WebRect.h"
38 #include <public/WebLayerTreeView.h>
39
40 namespace WebKit {
41
42 class WebGestureEvent;
43 class WebString;
44 class WebWidget;
45 struct WebCursorInfo;
46 struct WebSize;
47
48 class WebWidgetClient {
49 public:
50     // Called when a region of the WebWidget needs to be re-painted.
51     virtual void didInvalidateRect(const WebRect&) { }
52
53     // Called when a region of the WebWidget, given by clipRect, should be
54     // scrolled by the specified dx and dy amounts.
55     virtual void didScrollRect(int dx, int dy, const WebRect& clipRect) { }
56
57     // Called when the Widget has changed size as a result of an auto-resize.
58     virtual void didAutoResize(const WebSize& newSize) { }
59
60     // Called when the compositor is enabled or disabled.
61     // The inputHandlerIdentifier can be used on the compositor thread to get access
62     // to the WebCompositorInputHandler instance associated with this WebWidget.
63     // If there is no WebCompositorInputHandler associated with this WebWidget (for example if
64     // threaded compositing is not enabled) then calling WebCompositorInputHandler::fromIdentifier()
65     // for the specified identifier will return 0.
66     virtual void didActivateCompositor(int inputHandlerIdentifier) { }
67     virtual void didDeactivateCompositor() { }
68
69     // Attempt to initialize compositing for this widget using the given
70     // parameters. If this is successful, layerTreeView() will return a valid
71     // WebLayerTreeView. If not, nothing happens.
72     virtual void initializeLayerTreeView(WebLayerTreeViewClient*, const WebLayer& rootLayer, const WebLayerTreeView::Settings&) { }
73
74     // Return a compositing view used for this widget. This is owned by the
75     // WebWidgetClient.
76     virtual WebLayerTreeView* layerTreeView() { return 0; }
77
78     // Indicates to the embedder that the compositor is about to begin a
79     // frame. This is primarily to signal to flow control mechanisms that a
80     // frame is beginning, not to perform actual painting work.
81     virtual void willBeginCompositorFrame() { }
82
83     // Indicates to the embedder that the WebWidget is ready for additional
84     // input.
85     virtual void didBecomeReadyForAdditionalInput() { }
86
87     // Called for compositing mode when a frame commit operation has finished.
88     virtual void didCommitCompositorFrame() { }
89
90     // Called for compositing mode when the draw commands for a WebKit-side
91     // frame have been issued.
92     virtual void didCommitAndDrawCompositorFrame() { }
93
94     // Called for compositing mode when swapbuffers has been posted in the GPU
95     // process.
96     virtual void didCompleteSwapBuffers() { }
97
98     // Called when a call to WebWidget::composite is required
99     virtual void scheduleComposite() { }
100
101     // Called when a call to WebWidget::animate is required
102     virtual void scheduleAnimation() { }
103
104     // Called when the widget acquires or loses focus, respectively.
105     virtual void didFocus() { }
106     virtual void didBlur() { }
107
108     // Called when the cursor for the widget changes.
109     virtual void didChangeCursor(const WebCursorInfo&) { }
110
111     // Called when the widget should be closed.  WebWidget::close() should
112     // be called asynchronously as a result of this notification.
113     virtual void closeWidgetSoon() { }
114
115     // Called to show the widget according to the given policy.
116     virtual void show(WebNavigationPolicy) { }
117
118     // Called to block execution of the current thread until the widget is
119     // closed.
120     virtual void runModal() { }
121
122     // Called to enter/exit fullscreen mode. If enterFullScreen returns true,
123     // then WebWidget::{will,Did}EnterFullScreen should bound resizing the
124     // WebWidget into fullscreen mode. Similarly, when exitFullScreen is
125     // called, WebWidget::{will,Did}ExitFullScreen should bound resizing the
126     // WebWidget out of fullscreen mode.
127     virtual bool enterFullScreen() { return false; }
128     virtual void exitFullScreen() { }
129
130     // Called to get/set the position of the widget in screen coordinates.
131     virtual WebRect windowRect() { return WebRect(); }
132     virtual void setWindowRect(const WebRect&) { }
133
134     // Called when a tooltip should be shown at the current cursor position.
135     virtual void setToolTipText(const WebString&, WebTextDirection hint) { }
136
137     // Called to get the position of the resizer rect in window coordinates.
138     virtual WebRect windowResizerRect() { return WebRect(); }
139
140     // Called to get the position of the root window containing the widget
141     // in screen coordinates.
142     virtual WebRect rootWindowRect() { return WebRect(); }
143
144     // Called to query information about the screen where this widget is
145     // displayed.
146     virtual WebScreenInfo screenInfo() { return WebScreenInfo(); }
147
148     // Called to get the scale factor of the display.
149     virtual float deviceScaleFactor() { return 1; }
150
151     // When this method gets called, WebWidgetClient implementation should
152     // reset the input method by cancelling any ongoing composition.
153     virtual void resetInputMethod() { }
154
155     // Requests to lock the mouse cursor. If true is returned, the success
156     // result will be asynchronously returned via a single call to
157     // WebWidget::didAcquirePointerLock() or
158     // WebWidget::didNotAcquirePointerLock().
159     // If false, the request has been denied synchronously.
160     virtual bool requestPointerLock() { return false; }
161
162     // Cause the pointer lock to be released. This may be called at any time,
163     // including when a lock is pending but not yet acquired.
164     // WebWidget::didLosePointerLock() is called when unlock is complete.
165     virtual void requestPointerUnlock() { }
166
167     // Returns true iff the pointer is locked to this widget.
168     virtual bool isPointerLocked() { return false; }
169
170     // Called when a gesture event is handled.
171     virtual void didHandleGestureEvent(const WebGestureEvent& event, bool eventCancelled) { }
172
173 protected:
174     ~WebWidgetClient() { }
175 };
176
177 } // namespace WebKit
178
179 #endif