2011-01-07 James Robinson <jamesr@chromium.org>
[WebKit-https.git] / 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 "WebCanvas.h"
35 #include "WebCommon.h"
36 #include "WebCompositionUnderline.h"
37 #include "WebTextInputType.h"
38 #include "WebTextDirection.h"
39
40 namespace WebKit {
41
42 class WebInputEvent;
43 class WebString;
44 struct WebRect;
45 struct WebSize;
46 template <typename T> class WebVector;
47
48 class WebWidget {
49 public:
50     // This method closes and deletes the WebWidget.
51     virtual void close() = 0;
52
53     // Returns the current size of the WebWidget.
54     virtual WebSize size() = 0;
55
56     // Called to resize the WebWidget.
57     virtual void resize(const WebSize&) = 0;
58
59     // Called to layout the WebWidget.  This MUST be called before Paint,
60     // and it may result in calls to WebWidgetClient::didInvalidateRect.
61     virtual void layout() = 0;
62
63     // Called to paint the rectangular region within the WebWidget 
64     // onto the specified canvas at (viewPort.x,viewPort.y). You MUST call
65     // Layout before calling this method.  It is okay to call paint
66     // multiple times once layout has been called, assuming no other
67     // changes are made to the WebWidget (e.g., once events are
68     // processed, it should be assumed that another call to layout is
69     // warranted before painting again).
70     virtual void paint(WebCanvas*, const WebRect& viewPort) = 0;
71
72     // Triggers compositing of the current layers onto the screen.
73     // The finish argument controls whether the compositor will wait for the
74     // GPU to finish rendering before returning. You MUST call Layout
75     // before calling this method, for the same reasons described in
76     // the paint method above.
77     virtual void composite(bool finish) = 0;
78
79     // Called to inform the WebWidget of a change in theme.
80     // Implementors that cache rendered copies of widgets need to re-render
81     // on receiving this message
82     virtual void themeChanged() = 0;
83
84     // Called to inform the WebWidget of an input event.  Returns true if
85     // the event has been processed, false otherwise.
86     virtual bool handleInputEvent(const WebInputEvent&) = 0;
87
88     // Called to inform the WebWidget that mouse capture was lost.
89     virtual void mouseCaptureLost() = 0;
90
91     // Called to inform the WebWidget that it has gained or lost keyboard focus.
92     virtual void setFocus(bool) = 0;
93
94     // Called to inform the WebWidget of a new composition text.
95     // If selectionStart and selectionEnd has the same value, then it indicates
96     // the input caret position. If the text is empty, then the existing
97     // composition text will be cancelled.
98     // Returns true if the composition text was set successfully.
99     virtual bool setComposition(
100         const WebString& text,
101         const WebVector<WebCompositionUnderline>& underlines,
102         int selectionStart,
103         int selectionEnd) = 0;
104
105     // Called to inform the WebWidget to confirm an ongoing composition.
106     // This method is same as confirmComposition(WebString());
107     // Returns true if there is an ongoing composition.
108     virtual bool confirmComposition() = 0;
109
110     // Called to inform the WebWidget to confirm an ongoing composition with a
111     // new composition text. If the text is empty then the current composition
112     // text is confirmed. If there is no ongoing composition, then deletes the
113     // current selection and inserts the text. This method has no effect if
114     // there is no ongoing composition and the text is empty.
115     // Returns true if there is an ongoing composition or the text is inserted.
116     virtual bool confirmComposition(const WebString& text) = 0;
117
118     // Returns the current text input type of this WebWidget.
119     virtual WebTextInputType textInputType() = 0;
120
121     // Returns the current caret bounds of this WebWidget. The selection bounds
122     // will be returned if a selection range is available.
123     virtual WebRect caretOrSelectionBounds() = 0;
124
125     // Changes the text direction of the selected input node.
126     virtual void setTextDirection(WebTextDirection) = 0;
127
128     // Returns true if the WebWidget uses GPU accelerated compositing
129     // to render its contents.
130     virtual bool isAcceleratedCompositingActive() const = 0;
131
132 protected:
133     ~WebWidget() { }
134 };
135
136 } // namespace WebKit
137
138 #endif