a389bef54b4e0e7c7717b7088752e075414a7f2a
[WebKit-https.git] / Source / WebKit / chromium / public / WebWidget.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 WebWidget_h
32 #define WebWidget_h
33
34 #include "../../../Platform/chromium/public/WebCanvas.h"
35 #include "../../../Platform/chromium/public/WebCommon.h"
36 #include "../../../Platform/chromium/public/WebRect.h"
37 #include "../../../Platform/chromium/public/WebSize.h"
38 #include "WebCompositionUnderline.h"
39 #include "WebTextDirection.h"
40 #include "WebTextInputInfo.h"
41
42 namespace WebKit {
43
44 class WebInputEvent;
45 class WebLayerTreeView;
46 class WebMouseEvent;
47 class WebString;
48 struct WebPoint;
49 struct WebRenderingStats;
50 template <typename T> class WebVector;
51
52 class WebWidget {
53 public:
54     // This method closes and deletes the WebWidget.
55     virtual void close() { }
56
57     // Returns the current size of the WebWidget.
58     virtual WebSize size() { return WebSize(); }
59
60     // Used to group a series of resize events. For example, if the user
61     // drags a resizer then willStartLiveResize will be called, followed by a
62     // sequence of resize events, ending with willEndLiveResize when the user
63     // lets go of the resizer.
64     virtual void willStartLiveResize() { }
65
66     // Called to resize the WebWidget.
67     virtual void resize(const WebSize&) { }
68
69     // Ends a group of resize events that was started with a call to
70     // willStartLiveResize.
71     virtual void willEndLiveResize() { }
72
73     // Called to notify the WebWidget of entering/exiting fullscreen mode. The
74     // resize method may be called between will{Enter,Exit}FullScreen and
75     // did{Enter,Exit}FullScreen.
76     virtual void willEnterFullScreen() { }
77     virtual void didEnterFullScreen() { }
78     virtual void willExitFullScreen() { }
79     virtual void didExitFullScreen() { }
80
81     // Called to update imperative animation state. This should be called before
82     // paint, although the client can rate-limit these calls.
83     virtual void animate(double ignored) { }
84
85     // Called to layout the WebWidget. This MUST be called before Paint,
86     // and it may result in calls to WebWidgetClient::didInvalidateRect.
87     virtual void layout() { }
88
89     // Called to toggle the WebWidget in or out of force compositing mode. This
90     // should be called before paint.
91     virtual void enterForceCompositingMode(bool enter) { }
92
93     enum PaintOptions {
94         // Attempt to fulfill the painting request by reading back from the
95         // compositor, assuming we're using a compositor to render.
96         ReadbackFromCompositorIfAvailable,
97
98         // Force the widget to rerender onto the canvas using software. This
99         // mode ignores 3d transforms and ignores GPU-resident content, such
100         // as video, canvas, and WebGL.
101         //
102         // Note: This option exists on OS(ANDROID) and will hopefully be
103         //       removed once the link disambiguation feature renders using
104         //       the compositor.
105         ForceSoftwareRenderingAndIgnoreGPUResidentContent,
106     };
107
108     // Called to paint the rectangular region within the WebWidget
109     // onto the specified canvas at (viewPort.x,viewPort.y). You MUST call
110     // Layout before calling this method. It is okay to call paint
111     // multiple times once layout has been called, assuming no other
112     // changes are made to the WebWidget (e.g., once events are
113     // processed, it should be assumed that another call to layout is
114     // warranted before painting again).
115     virtual void paint(WebCanvas*, const WebRect& viewPort, PaintOptions = ReadbackFromCompositorIfAvailable) { }
116
117     // In non-threaded compositing mode, triggers compositing of the current
118     // layers onto the screen. You MUST call Layout before calling this method,
119     // for the same reasons described in the paint method above
120     //
121     // In threaded compositing mode, indicates that the widget should update
122     // itself, for example due to window damage. The redraw will begin
123     // asynchronously and perform layout and animation internally. Do not call
124     // animate or layout in this case.
125     virtual void composite(bool finish) = 0;
126
127     // Returns true if we've started tracking repaint rectangles.
128     virtual bool isTrackingRepaints() const { return false; }
129
130     // Indicates that the compositing surface associated with this WebWidget is
131     // ready to use.
132     virtual void setCompositorSurfaceReady() = 0;
133
134     // Temporary method for the embedder to notify the WebWidget that the widget
135     // has taken damage, e.g. due to a window expose. This method will be
136     // removed when the WebWidget inversion patch lands --- http://crbug.com/112837
137     virtual void setNeedsRedraw() { }
138
139     // Temporary method for the embedder to check for throttled input. When this
140     // is true, the WebWidget is indicating that it would prefer to not receive
141     // additional input events until
142     // WebWidgetClient::didBecomeReadyForAdditionalInput is called.
143     //
144     // This method will be removed when the WebWidget inversion patch lands ---
145     // http://crbug.com/112837
146     virtual bool isInputThrottled() const { return false; }
147
148     // Called to inform the WebWidget of a change in theme.
149     // Implementors that cache rendered copies of widgets need to re-render
150     // on receiving this message
151     virtual void themeChanged() { }
152
153     // Called to inform the WebWidget of an input event. Returns true if
154     // the event has been processed, false otherwise.
155     virtual bool handleInputEvent(const WebInputEvent&) { return false; }
156
157     // Check whether the given point hits any registered touch event handlers.
158     virtual bool hasTouchEventHandlersAt(const WebPoint&) { return true; }
159
160     // Called to inform the WebWidget that mouse capture was lost.
161     virtual void mouseCaptureLost() { }
162
163     // Called to inform the WebWidget that it has gained or lost keyboard focus.
164     virtual void setFocus(bool) { }
165
166     // Called to inform the WebWidget of a new composition text.
167     // If selectionStart and selectionEnd has the same value, then it indicates
168     // the input caret position. If the text is empty, then the existing
169     // composition text will be cancelled.
170     // Returns true if the composition text was set successfully.
171     virtual bool setComposition(
172         const WebString& text,
173         const WebVector<WebCompositionUnderline>& underlines,
174         int selectionStart,
175         int selectionEnd) { return false; }
176
177     // Called to inform the WebWidget to confirm an ongoing composition.
178     // This method is same as confirmComposition(WebString());
179     // Returns true if there is an ongoing composition.
180     virtual bool confirmComposition() { return false; }
181
182     // Called to inform the WebWidget to confirm an ongoing composition with a
183     // new composition text. If the text is empty then the current composition
184     // text is confirmed. If there is no ongoing composition, then deletes the
185     // current selection and inserts the text. This method has no effect if
186     // there is no ongoing composition and the text is empty.
187     // Returns true if there is an ongoing composition or the text is inserted.
188     virtual bool confirmComposition(const WebString& text) { return false; }
189
190     // Fetches the character range of the current composition, also called the
191     // "marked range." Returns true and fills the out-paramters on success;
192     // returns false on failure.
193     virtual bool compositionRange(size_t* location, size_t* length) { return false; }
194
195     // Returns information about the current text input of this WebWidget.
196     virtual WebTextInputInfo textInputInfo() { return WebTextInputInfo(); }
197
198     // Returns the current text input type of this WebWidget.
199     // FIXME: Remove this method. It's redundant with textInputInfo().
200     virtual WebTextInputType textInputType() { return WebTextInputTypeNone; }
201
202     // Returns the anchor and focus bounds of the current selection.
203     // If the selection range is empty, it returns the caret bounds.
204     virtual bool selectionBounds(WebRect& anchor, WebRect& focus) const { return false; }
205
206     // Returns the text direction at the start and end bounds of the current selection.
207     // If the selection range is empty, it returns false.
208     virtual bool selectionTextDirection(WebTextDirection& start, WebTextDirection& end) const { return false; }
209
210     // Fetch the current selection range of this WebWidget. If there is no
211     // selection, it will output a 0-length range with the location at the
212     // caret. Returns true and fills the out-paramters on success; returns false
213     // on failure.
214     virtual bool caretOrSelectionRange(size_t* location, size_t* length) { return false; }
215
216     // Changes the text direction of the selected input node.
217     virtual void setTextDirection(WebTextDirection) { }
218
219     // Returns true if the WebWidget uses GPU accelerated compositing
220     // to render its contents.
221     virtual bool isAcceleratedCompositingActive() const { return false; }
222
223     // The WebLayerTreeView initialized on this WebWidgetClient will be going away and
224     // is no longer safe to access.
225     virtual void willCloseLayerTreeView() { }
226
227     // Calling WebWidgetClient::requestPointerLock() will result in one
228     // return call to didAcquirePointerLock() or didNotAcquirePointerLock().
229     virtual void didAcquirePointerLock() { }
230     virtual void didNotAcquirePointerLock() { }
231
232     // Pointer lock was held, but has been lost. This may be due to a
233     // request via WebWidgetClient::requestPointerUnlock(), or for other
234     // reasons such as the user exiting lock, window focus changing, etc.
235     virtual void didLosePointerLock() { }
236
237     // Informs the WebWidget that the resizer rect changed. Happens for example
238     // on mac, when a widget appears below the WebWidget without changing the
239     // WebWidget's size (WebWidget::resize() automatically checks the resizer
240     // rect.)
241     virtual void didChangeWindowResizerRect() { }
242
243     // Instrumentation method that marks beginning of frame update that includes
244     // things like animate()/layout()/paint()/composite().
245     virtual void instrumentBeginFrame() { }
246     // Cancels the effect of instrumentBeginFrame() in case there were no events
247     // following the call to instrumentBeginFrame().
248     virtual void instrumentCancelFrame() { }
249
250     // Fills in a WebRenderingStats struct containing information about rendering, e.g. count of frames rendered, time spent painting.
251     // This call is relatively expensive in threaded compositing mode, as it blocks on the compositor thread.
252     // It is safe to call in software mode, but will only give stats for rendering done in compositing mode.
253     virtual void renderingStats(WebRenderingStats&) const { }
254
255     // The page background color. Can be used for filling in areas without
256     // content.
257     virtual WebColor backgroundColor() const { return 0xFFFFFFFF; /* SK_ColorWHITE */ }
258
259 protected:
260     ~WebWidget() { }
261 };
262
263 } // namespace WebKit
264
265 #endif