WinCairo build fails to link.
[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 WebInputHandler;
46 class WebLayerTreeView;
47 class WebMouseEvent;
48 class WebString;
49 struct WebPoint;
50 struct WebRenderingStats;
51 template <typename T> class WebVector;
52
53 class WebWidget {
54 public:
55     // This method closes and deletes the WebWidget.
56     virtual void close() { }
57
58     // Returns the current size of the WebWidget.
59     virtual WebSize size() { return WebSize(); }
60
61     // Used to group a series of resize events. For example, if the user
62     // drags a resizer then willStartLiveResize will be called, followed by a
63     // sequence of resize events, ending with willEndLiveResize when the user
64     // lets go of the resizer.
65     virtual void willStartLiveResize() { }
66
67     // Called to resize the WebWidget.
68     virtual void resize(const WebSize&) { }
69
70     // Ends a group of resize events that was started with a call to
71     // willStartLiveResize.
72     virtual void willEndLiveResize() { }
73
74     // Called to notify the WebWidget of entering/exiting fullscreen mode. The
75     // resize method may be called between will{Enter,Exit}FullScreen and
76     // did{Enter,Exit}FullScreen.
77     virtual void willEnterFullScreen() { }
78     virtual void didEnterFullScreen() { }
79     virtual void willExitFullScreen() { }
80     virtual void didExitFullScreen() { }
81
82     // Called to update imperative animation state. This should be called before
83     // paint, although the client can rate-limit these calls.
84     virtual void animate(double monotonicFrameBeginTime) { }
85
86     // Called to layout the WebWidget. This MUST be called before Paint,
87     // and it may result in calls to WebWidgetClient::didInvalidateRect.
88     virtual void layout() { }
89
90     // Called to toggle the WebWidget in or out of force compositing mode. This
91     // should be called before paint.
92     virtual void enterForceCompositingMode(bool enter) { }
93
94     // Called to notify the WebWidget that the widget has exited compositing
95     // mode and cannot reenter.
96     virtual void didExitCompositingMode() { }
97
98     enum PaintOptions {
99         // Attempt to fulfill the painting request by reading back from the
100         // compositor, assuming we're using a compositor to render.
101         ReadbackFromCompositorIfAvailable,
102
103         // Force the widget to rerender onto the canvas using software. This
104         // mode ignores 3d transforms and ignores GPU-resident content, such
105         // as video, canvas, and WebGL.
106         //
107         // Note: This option exists on OS(ANDROID) and will hopefully be
108         //       removed once the link disambiguation feature renders using
109         //       the compositor.
110         ForceSoftwareRenderingAndIgnoreGPUResidentContent,
111     };
112
113     // Called to paint the rectangular region within the WebWidget
114     // onto the specified canvas at (viewPort.x,viewPort.y). You MUST call
115     // Layout before calling this method. It is okay to call paint
116     // multiple times once layout has been called, assuming no other
117     // changes are made to the WebWidget (e.g., once events are
118     // processed, it should be assumed that another call to layout is
119     // warranted before painting again).
120     virtual void paint(WebCanvas*, const WebRect& viewPort, PaintOptions = ReadbackFromCompositorIfAvailable) { }
121
122     // Returns true if we've started tracking repaint rectangles.
123     virtual bool isTrackingRepaints() const { return false; }
124
125     // Indicates that the compositing surface associated with this WebWidget is
126     // ready to use.
127     virtual void setCompositorSurfaceReady() { }
128
129     // Temporary method for the embedder to notify the WebWidget that the widget
130     // has taken damage, e.g. due to a window expose. This method will be
131     // removed when the WebWidget inversion patch lands --- http://crbug.com/112837
132     virtual void setNeedsRedraw() { }
133
134     // Called to inform the WebWidget of a change in theme.
135     // Implementors that cache rendered copies of widgets need to re-render
136     // on receiving this message
137     virtual void themeChanged() { }
138
139     // Called to inform the WebWidget of an input event. Returns true if
140     // the event has been processed, false otherwise.
141     virtual bool handleInputEvent(const WebInputEvent&) { return false; }
142
143     // Check whether the given point hits any registered touch event handlers.
144     virtual bool hasTouchEventHandlersAt(const WebPoint&) { return true; }
145
146     // Request that the WebWidget create an input handler for processing input
147     // events intended for this widget off of the main thread.
148     virtual WebInputHandler* createInputHandler() { return 0; }
149
150     // Applies a scroll delta to the root layer, which is bundled with a page
151     // scale factor that may apply a CSS transform on the whole document (used
152     // for mobile-device pinch zooming). This is triggered by events sent to the
153     // compositor thread through the WebInputHandler interface.
154     virtual void applyScrollAndScale(const WebSize& scrollDelta, float scaleFactor) { }
155
156     // Called to inform the WebWidget that mouse capture was lost.
157     virtual void mouseCaptureLost() { }
158
159     // Called to inform the WebWidget that it has gained or lost keyboard focus.
160     virtual void setFocus(bool) { }
161
162     // Called to inform the WebWidget of a new composition text.
163     // If selectionStart and selectionEnd has the same value, then it indicates
164     // the input caret position. If the text is empty, then the existing
165     // composition text will be cancelled.
166     // Returns true if the composition text was set successfully.
167     virtual bool setComposition(
168         const WebString& text,
169         const WebVector<WebCompositionUnderline>& underlines,
170         int selectionStart,
171         int selectionEnd) { return false; }
172
173     // Called to inform the WebWidget to confirm an ongoing composition.
174     // This method is same as confirmComposition(WebString());
175     // Returns true if there is an ongoing composition.
176     virtual bool confirmComposition() { return false; }
177
178     // Called to inform the WebWidget to confirm an ongoing composition with a
179     // new composition text. If the text is empty then the current composition
180     // text is confirmed. If there is no ongoing composition, then deletes the
181     // current selection and inserts the text. This method has no effect if
182     // there is no ongoing composition and the text is empty.
183     // Returns true if there is an ongoing composition or the text is inserted.
184     virtual bool confirmComposition(const WebString& text) { return false; }
185
186     // Fetches the character range of the current composition, also called the
187     // "marked range." Returns true and fills the out-paramters on success;
188     // returns false on failure.
189     virtual bool compositionRange(size_t* location, size_t* length) { return false; }
190
191     // Returns information about the current text input of this WebWidget.
192     virtual WebTextInputInfo textInputInfo() { return WebTextInputInfo(); }
193
194     // Returns the current text input type of this WebWidget.
195     // FIXME: Remove this method. It's redundant with textInputInfo().
196     virtual WebTextInputType textInputType() { return WebTextInputTypeNone; }
197
198     // Returns the anchor and focus bounds of the current selection.
199     // If the selection range is empty, it returns the caret bounds.
200     virtual bool selectionBounds(WebRect& anchor, WebRect& focus) const { return false; }
201
202     // Returns the text direction at the start and end bounds of the current selection.
203     // If the selection range is empty, it returns false.
204     virtual bool selectionTextDirection(WebTextDirection& start, WebTextDirection& end) const { return false; }
205
206     // Returns true if the selection range is nonempty and its anchor is first
207     // (i.e its anchor is its start).
208     virtual bool isSelectionAnchorFirst() 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     // The page background color. Can be used for filling in areas without
244     // content.
245     virtual WebColor backgroundColor() const { return 0xFFFFFFFF; /* SK_ColorWHITE */ }
246
247 protected:
248     ~WebWidget() { }
249 };
250
251 } // namespace WebKit
252
253 #endif