2011-05-09 Shishir Agrawal <shishir@chromium.org>
[WebKit-https.git] / Source / WebKit / chromium / public / WebView.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 WebView_h
32 #define WebView_h
33
34 #include "WebDragOperation.h"
35 #include "WebPageVisibilityState.h"
36 #include "WebString.h"
37 #include "WebVector.h"
38 #include "WebWidget.h"
39
40 namespace WebKit {
41
42 class WebAccessibilityObject;
43 class WebAutoFillClient;
44 class WebDevToolsAgent;
45 class WebDevToolsAgentClient;
46 class WebDragData;
47 class WebFrame;
48 class WebFrameClient;
49 class WebGraphicsContext3D;
50 class WebNode;
51 class WebPermissionClient;
52 class WebSettings;
53 class WebSpellCheckClient;
54 class WebString;
55 class WebViewClient;
56 struct WebMediaPlayerAction;
57 struct WebPoint;
58
59 class WebView : public WebWidget {
60 public:
61     WEBKIT_API static const double textSizeMultiplierRatio;
62     WEBKIT_API static const double minTextSizeMultiplier;
63     WEBKIT_API static const double maxTextSizeMultiplier;
64
65     // Controls the time that user scripts injected into the document run.
66     enum UserScriptInjectAt {
67         UserScriptInjectAtDocumentStart,
68         UserScriptInjectAtDocumentEnd
69     };
70
71     // Controls which frames user content is injected into.
72     enum UserContentInjectIn {
73         UserContentInjectInAllFrames,
74         UserContentInjectInTopFrameOnly
75     };
76
77     // Controls which documents user styles are injected into.
78     enum UserStyleInjectionTime {
79         UserStyleInjectInExistingDocuments,
80         UserStyleInjectInSubsequentDocuments
81     };
82
83
84     // Initialization ------------------------------------------------------
85
86     // Creates a WebView that is NOT yet initialized.  You will need to
87     // call initializeMainFrame to finish the initialization.  It is valid
88     // to pass null client pointers.
89     WEBKIT_API static WebView* create(WebViewClient*);
90
91     // After creating a WebView, you should immediately call this method.
92     // You can optionally modify the settings before calling this method.
93     // The WebFrameClient will receive events for the main frame and any
94     // child frames.  It is valid to pass a null WebFrameClient pointer.
95     virtual void initializeMainFrame(WebFrameClient*) = 0;
96
97     // Initializes the various client interfaces.
98     virtual void setAutoFillClient(WebAutoFillClient*) = 0;
99     virtual void setDevToolsAgentClient(WebDevToolsAgentClient*) = 0;
100     virtual void setPermissionClient(WebPermissionClient*) = 0;
101     virtual void setSpellCheckClient(WebSpellCheckClient*) = 0;
102
103
104     // Options -------------------------------------------------------------
105
106     // The returned pointer is valid for the lifetime of the WebView.
107     virtual WebSettings* settings() = 0;
108
109     // Corresponds to the encoding of the main frame.  Setting the page
110     // encoding may cause the main frame to reload.
111     virtual WebString pageEncoding() const = 0;
112     virtual void setPageEncoding(const WebString&) = 0;
113
114     // Makes the WebView transparent.  This is useful if you want to have
115     // some custom background rendered behind it.
116     virtual bool isTransparent() const = 0;
117     virtual void setIsTransparent(bool) = 0;
118
119     // Controls whether pressing Tab key advances focus to links.
120     virtual bool tabsToLinks() const = 0;
121     virtual void setTabsToLinks(bool) = 0;
122
123     // Method that controls whether pressing Tab key cycles through page
124     // elements or inserts a '\t' char in the focused text area.
125     virtual bool tabKeyCyclesThroughElements() const = 0;
126     virtual void setTabKeyCyclesThroughElements(bool) = 0;
127
128     // Controls the WebView's active state, which may affect the rendering
129     // of elements on the page (i.e., tinting of input elements).
130     virtual bool isActive() const = 0;
131     virtual void setIsActive(bool) = 0;
132
133     // Allows disabling domain relaxation.
134     virtual void setDomainRelaxationForbidden(bool, const WebString& scheme) = 0;
135
136
137     // Closing -------------------------------------------------------------
138
139     // Runs beforeunload handlers for the current page, returning false if
140     // any handler suppressed unloading.
141     virtual bool dispatchBeforeUnloadEvent() = 0;
142
143     // Runs unload handlers for the current page.
144     virtual void dispatchUnloadEvent() = 0;
145
146
147     // Frames --------------------------------------------------------------
148
149     virtual WebFrame* mainFrame() = 0;
150
151     // Returns the frame identified by the given name.  This method
152     // supports pseudo-names like _self, _top, and _blank.  It traverses
153     // the entire frame tree containing this tree looking for a frame that
154     // matches the given name.  If the optional relativeToFrame parameter
155     // is specified, then the search begins with the given frame and its
156     // children.
157     virtual WebFrame* findFrameByName(
158         const WebString& name, WebFrame* relativeToFrame = 0) = 0;
159
160
161     // Focus ---------------------------------------------------------------
162
163     virtual WebFrame* focusedFrame() = 0;
164     virtual void setFocusedFrame(WebFrame*) = 0;
165
166     // Focus the first (last if reverse is true) focusable node.
167     virtual void setInitialFocus(bool reverse) = 0;
168
169     // Clears the focused node (and selection if a text field is focused)
170     // to ensure that a text field on the page is not eating keystrokes we
171     // send it.
172     virtual void clearFocusedNode() = 0;
173
174     // Scrolls the node currently in focus into view.
175     virtual void scrollFocusedNodeIntoView() = 0;
176
177
178     // Zoom ----------------------------------------------------------------
179
180     // Returns the current zoom level.  0 is "original size", and each increment
181     // above or below represents zooming 20% larger or smaller to default limits
182     // of 300% and 50% of original size, respectively.  Only plugins use
183     // non whole-numbers, since they might choose to have specific zoom level so
184     // that fixed-width content is fit-to-page-width, for example.
185     virtual double zoomLevel() = 0;
186
187     // Changes the zoom level to the specified level, clamping at the limits
188     // noted above, and returns the current zoom level after applying the
189     // change.
190     //
191     // If |textOnly| is set, only the text will be zoomed; otherwise the entire
192     // page will be zoomed. You can only have either text zoom or full page zoom
193     // at one time.  Changing the mode while the page is zoomed will have odd
194     // effects.
195     virtual double setZoomLevel(bool textOnly, double zoomLevel) = 0;
196
197     // Updates the zoom limits for this view.
198     virtual void zoomLimitsChanged(double minimumZoomLevel,
199                                    double maximumZoomLevel) = 0;
200
201     // Helper functions to convert between zoom level and zoom factor.  zoom
202     // factor is zoom percent / 100, so 300% = 3.0.
203     WEBKIT_API static double zoomLevelToZoomFactor(double zoomLevel);
204     WEBKIT_API static double zoomFactorToZoomLevel(double factor);
205
206
207     // Media ---------------------------------------------------------------
208
209     // Performs the specified action on the node at the given location.
210     virtual void performMediaPlayerAction(
211         const WebMediaPlayerAction&, const WebPoint& location) = 0;
212
213
214     // Data exchange -------------------------------------------------------
215
216     // Copy to the clipboard the image located at a particular point in the
217     // WebView (if there is such an image)
218     virtual void copyImageAt(const WebPoint&) = 0;
219
220     // Notifies the WebView that a drag has terminated.
221     virtual void dragSourceEndedAt(
222         const WebPoint& clientPoint, const WebPoint& screenPoint,
223         WebDragOperation operation) = 0;
224
225     // Notifies the WebView that a drag is going on.
226     virtual void dragSourceMovedTo(
227         const WebPoint& clientPoint, const WebPoint& screenPoint,
228         WebDragOperation operation) = 0;
229
230     // Notfies the WebView that the system drag and drop operation has ended.
231     virtual void dragSourceSystemDragEnded() = 0;
232
233     // Callback methods when a drag-and-drop operation is trying to drop
234     // something on the WebView.
235     virtual WebDragOperation dragTargetDragEnter(
236         const WebDragData&,
237         const WebPoint& clientPoint, const WebPoint& screenPoint,
238         WebDragOperationsMask operationsAllowed) = 0;
239     virtual WebDragOperation dragTargetDragOver(
240         const WebPoint& clientPoint, const WebPoint& screenPoint,
241         WebDragOperationsMask operationsAllowed) = 0;
242     virtual void dragTargetDragLeave() = 0;
243     virtual void dragTargetDrop(
244         const WebPoint& clientPoint, const WebPoint& screenPoint) = 0;
245
246
247     // Support for resource loading initiated by plugins -------------------
248
249     // Returns next unused request identifier which is unique within the
250     // parent Page.
251     virtual unsigned long createUniqueIdentifierForRequest() = 0;
252
253
254     // Developer tools -----------------------------------------------------
255
256     // Inspect a particular point in the WebView.  (x = -1 || y = -1) is a
257     // special case, meaning inspect the current page and not a specific
258     // point.
259     virtual void inspectElementAt(const WebPoint&) = 0;
260
261     // Settings used by the inspector.
262     virtual WebString inspectorSettings() const = 0;
263     virtual void setInspectorSettings(const WebString&) = 0;
264     virtual bool inspectorSetting(const WebString& key,
265                                   WebString* value) const = 0;
266     virtual void setInspectorSetting(const WebString& key,
267                                      const WebString& value) = 0;
268
269     // The embedder may optionally engage a WebDevToolsAgent.  This may only
270     // be set once per WebView.
271     virtual WebDevToolsAgent* devToolsAgent() = 0;
272
273
274     // Accessibility -------------------------------------------------------
275
276     // Returns the accessibility object for this view.
277     virtual WebAccessibilityObject accessibilityObject() = 0;
278
279
280     // AutoFill  -----------------------------------------------------------
281
282     // Notifies the WebView that AutoFill suggestions are available for a node.
283     // |uniqueIDs| is a vector of IDs that represent the unique ID of each
284     // AutoFill profile in the suggestions popup.  If a unique ID is 0, then the
285     // corresponding suggestion comes from Autocomplete rather than AutoFill.
286     // If a unique ID is negative, then the corresponding "suggestion" is
287     // actually a user-facing warning, e.g. explaining why AutoFill is
288     // unavailable for the current form.
289     virtual void applyAutoFillSuggestions(
290         const WebNode&,
291         const WebVector<WebString>& names,
292         const WebVector<WebString>& labels,
293         const WebVector<WebString>& icons,
294         const WebVector<int>& uniqueIDs,
295         int separatorIndex) = 0;
296
297     // Hides any popup (suggestions, selects...) that might be showing.
298     virtual void hidePopups() = 0;
299
300
301     // Context menu --------------------------------------------------------
302
303     virtual void performCustomContextMenuAction(unsigned action) = 0;
304
305
306     // Popup menu ----------------------------------------------------------
307
308     // Sets whether select popup menus should be rendered by the browser.
309     WEBKIT_API static void setUseExternalPopupMenus(bool);
310
311
312     // Visited link state --------------------------------------------------
313
314     // Tells all WebView instances to update the visited link state for the
315     // specified hash.
316     WEBKIT_API static void updateVisitedLinkState(unsigned long long hash);
317
318     // Tells all WebView instances to update the visited state for all
319     // their links.
320     WEBKIT_API static void resetVisitedLinkState();
321
322
323     // Custom colors -------------------------------------------------------
324
325     virtual void setScrollbarColors(unsigned inactiveColor,
326                                     unsigned activeColor,
327                                     unsigned trackColor) = 0;
328
329     virtual void setSelectionColors(unsigned activeBackgroundColor,
330                                     unsigned activeForegroundColor,
331                                     unsigned inactiveBackgroundColor,
332                                     unsigned inactiveForegroundColor) = 0;
333
334     // User scripts --------------------------------------------------------
335     WEBKIT_API static void addUserScript(const WebString& sourceCode,
336                                          const WebVector<WebString>& patterns,
337                                          UserScriptInjectAt injectAt,
338                                          UserContentInjectIn injectIn);
339     WEBKIT_API static void addUserStyleSheet(const WebString& sourceCode,
340                                              const WebVector<WebString>& patterns,
341                                              UserContentInjectIn injectIn,
342                                              UserStyleInjectionTime injectionTime = UserStyleInjectInSubsequentDocuments);
343     WEBKIT_API static void removeAllUserContent();
344
345     // Modal dialog support ------------------------------------------------
346
347     // Call these methods before and after running a nested, modal event loop
348     // to suspend script callbacks and resource loads.
349     WEBKIT_API static void willEnterModalLoop();
350     WEBKIT_API static void didExitModalLoop();
351
352     // GPU acceleration support --------------------------------------------
353
354     // Returns the (on-screen) WebGraphicsContext3D associated with
355     // this WebView. One will be created if it doesn't already exist.
356     // This is used to set up sharing between this context (which is
357     // that used by the compositor) and contexts for WebGL and other
358     // APIs.
359     virtual WebGraphicsContext3D* graphicsContext3D() = 0;
360
361     // Visibility -----------------------------------------------------------
362
363     // Sets the visibility of the WebView.
364     virtual void setVisibilityState(WebPageVisibilityState visibilityState,
365                                     bool isInitialState) { }
366
367 protected:
368     ~WebView() {}
369 };
370
371 } // namespace WebKit
372
373 #endif