[chromium] No modifier flags (shift/ctrl/alt) in drag&drop events on chromium linux
[WebKit-https.git] / Source / WebKit / chromium / public / WebView.h
1 /*
2  * Copyright (C) 2009, 2010, 2011, 2012 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 "WebWidget.h"
37 #include "platform/WebString.h"
38 #include "platform/WebVector.h"
39
40 namespace WebKit {
41
42 class WebAccessibilityObject;
43 class WebAutofillClient;
44 class WebBatteryStatus;
45 class WebDevToolsAgent;
46 class WebDevToolsAgentClient;
47 class WebDragData;
48 class WebFrame;
49 class WebFrameClient;
50 class WebGraphicsContext3D;
51 class WebNode;
52 class WebPageOverlay;
53 class WebPermissionClient;
54 class WebPrerendererClient;
55 class WebRange;
56 class WebSettings;
57 class WebSpellCheckClient;
58 class WebString;
59 class WebTextFieldDecoratorClient;
60 class WebViewClient;
61 struct WebActiveWheelFlingParameters;
62 struct WebMediaPlayerAction;
63 struct WebPluginAction;
64 struct WebPoint;
65
66 class WebView : public WebWidget {
67 public:
68     WEBKIT_EXPORT static const double textSizeMultiplierRatio;
69     WEBKIT_EXPORT static const double minTextSizeMultiplier;
70     WEBKIT_EXPORT static const double maxTextSizeMultiplier;
71     WEBKIT_EXPORT static const float minPageScaleFactor;
72     WEBKIT_EXPORT static const float maxPageScaleFactor;
73
74     // Controls the time that user scripts injected into the document run.
75     enum UserScriptInjectAt {
76         UserScriptInjectAtDocumentStart,
77         UserScriptInjectAtDocumentEnd
78     };
79
80     // Controls which frames user content is injected into.
81     enum UserContentInjectIn {
82         UserContentInjectInAllFrames,
83         UserContentInjectInTopFrameOnly
84     };
85
86     // Controls which documents user styles are injected into.
87     enum UserStyleInjectionTime {
88         UserStyleInjectInExistingDocuments,
89         UserStyleInjectInSubsequentDocuments
90     };
91
92
93     // Initialization ------------------------------------------------------
94
95     // Creates a WebView that is NOT yet initialized.  You will need to
96     // call initializeMainFrame to finish the initialization.  It is valid
97     // to pass null client pointers.
98     WEBKIT_EXPORT static WebView* create(WebViewClient*);
99
100     // After creating a WebView, you should immediately call this method.
101     // You can optionally modify the settings before calling this method.
102     // The WebFrameClient will receive events for the main frame and any
103     // child frames.  It is valid to pass a null WebFrameClient pointer.
104     virtual void initializeMainFrame(WebFrameClient*) = 0;
105
106     // Initializes the various client interfaces.
107     virtual void setAutofillClient(WebAutofillClient*) = 0;
108     virtual void setDevToolsAgentClient(WebDevToolsAgentClient*) = 0;
109     virtual void setPermissionClient(WebPermissionClient*) = 0;
110     virtual void setPrerendererClient(WebPrerendererClient*) = 0;
111     virtual void setSpellCheckClient(WebSpellCheckClient*) = 0;
112     virtual void addTextFieldDecoratorClient(WebTextFieldDecoratorClient*) = 0;
113
114
115     // Options -------------------------------------------------------------
116
117     // The returned pointer is valid for the lifetime of the WebView.
118     virtual WebSettings* settings() = 0;
119
120     // Corresponds to the encoding of the main frame.  Setting the page
121     // encoding may cause the main frame to reload.
122     virtual WebString pageEncoding() const = 0;
123     virtual void setPageEncoding(const WebString&) = 0;
124
125     // Makes the WebView transparent.  This is useful if you want to have
126     // some custom background rendered behind it.
127     virtual bool isTransparent() const = 0;
128     virtual void setIsTransparent(bool) = 0;
129
130     // Controls whether pressing Tab key advances focus to links.
131     virtual bool tabsToLinks() const = 0;
132     virtual void setTabsToLinks(bool) = 0;
133
134     // Method that controls whether pressing Tab key cycles through page
135     // elements or inserts a '\t' char in the focused text area.
136     virtual bool tabKeyCyclesThroughElements() const = 0;
137     virtual void setTabKeyCyclesThroughElements(bool) = 0;
138
139     // Controls the WebView's active state, which may affect the rendering
140     // of elements on the page (i.e., tinting of input elements).
141     virtual bool isActive() const = 0;
142     virtual void setIsActive(bool) = 0;
143
144     // Allows disabling domain relaxation.
145     virtual void setDomainRelaxationForbidden(bool, const WebString& scheme) = 0;
146
147
148     // Closing -------------------------------------------------------------
149
150     // Runs beforeunload handlers for the current page, returning false if
151     // any handler suppressed unloading.
152     virtual bool dispatchBeforeUnloadEvent() = 0;
153
154     // Runs unload handlers for the current page.
155     virtual void dispatchUnloadEvent() = 0;
156
157
158     // Frames --------------------------------------------------------------
159
160     virtual WebFrame* mainFrame() = 0;
161
162     // Returns the frame identified by the given name.  This method
163     // supports pseudo-names like _self, _top, and _blank.  It traverses
164     // the entire frame tree containing this tree looking for a frame that
165     // matches the given name.  If the optional relativeToFrame parameter
166     // is specified, then the search begins with the given frame and its
167     // children.
168     virtual WebFrame* findFrameByName(
169         const WebString& name, WebFrame* relativeToFrame = 0) = 0;
170
171
172     // Focus ---------------------------------------------------------------
173
174     virtual WebFrame* focusedFrame() = 0;
175     virtual void setFocusedFrame(WebFrame*) = 0;
176
177     // Focus the first (last if reverse is true) focusable node.
178     virtual void setInitialFocus(bool reverse) = 0;
179
180     // Clears the focused node (and selection if a text field is focused)
181     // to ensure that a text field on the page is not eating keystrokes we
182     // send it.
183     virtual void clearFocusedNode() = 0;
184
185     // Scrolls the node currently in focus into view.
186     virtual void scrollFocusedNodeIntoView() = 0;
187
188     // Scrolls the node currently in focus into |rect|, where |rect| is in
189     // window space.
190     virtual void scrollFocusedNodeIntoRect(const WebRect&) { }
191
192
193     // Zoom ----------------------------------------------------------------
194
195     // Returns the current zoom level.  0 is "original size", and each increment
196     // above or below represents zooming 20% larger or smaller to default limits
197     // of 300% and 50% of original size, respectively.  Only plugins use
198     // non whole-numbers, since they might choose to have specific zoom level so
199     // that fixed-width content is fit-to-page-width, for example.
200     virtual double zoomLevel() = 0;
201
202     // Changes the zoom level to the specified level, clamping at the limits
203     // noted above, and returns the current zoom level after applying the
204     // change.
205     //
206     // If |textOnly| is set, only the text will be zoomed; otherwise the entire
207     // page will be zoomed. You can only have either text zoom or full page zoom
208     // at one time.  Changing the mode while the page is zoomed will have odd
209     // effects.
210     virtual double setZoomLevel(bool textOnly, double zoomLevel) = 0;
211
212     // Updates the zoom limits for this view.
213     virtual void zoomLimitsChanged(double minimumZoomLevel,
214                                    double maximumZoomLevel) = 0;
215
216     // Helper functions to convert between zoom level and zoom factor.  zoom
217     // factor is zoom percent / 100, so 300% = 3.0.
218     WEBKIT_EXPORT static double zoomLevelToZoomFactor(double zoomLevel);
219     WEBKIT_EXPORT static double zoomFactorToZoomLevel(double factor);
220
221     // Gets the scale factor of the page, where 1.0 is the normal size, > 1.0
222     // is scaled up, < 1.0 is scaled down.
223     virtual float pageScaleFactor() const = 0;
224
225     // Indicates whether the page scale factor has been set since navigating
226     // to a new page.
227     virtual bool isPageScaleFactorSet() const = 0;
228
229     // Scales the page and the scroll offset by a given factor, while ensuring
230     // that the new scroll position does not go beyond the edge of the page.
231     virtual void setPageScaleFactorPreservingScrollOffset(float) = 0;
232
233     // Scales a page by a factor of scaleFactor and then sets a scroll position to (x, y).
234     // setPageScaleFactor() magnifies and shrinks a page without affecting layout.
235     // On the other hand, zooming affects layout of the page.
236     virtual void setPageScaleFactor(float scaleFactor, const WebPoint& origin) = 0;
237
238     // PageScaleFactor will be force-clamped between minPageScale and maxPageScale
239     // (and these values will persist until setPageScaleFactorLimits is called
240     // again).
241     virtual void setPageScaleFactorLimits(float minPageScale, float maxPageScale) = 0;
242
243     virtual float minimumPageScaleFactor() const = 0;
244     virtual float maximumPageScaleFactor() const = 0;
245
246     // The ratio of the current device's screen DPI to the target device's screen DPI.
247     virtual float deviceScaleFactor() const = 0;
248
249     // Sets the ratio as computed by computeViewportAttributes.
250     virtual void setDeviceScaleFactor(float) = 0;
251
252
253     // Fixed Layout --------------------------------------------------------
254
255     // In fixed layout mode, the layout of the page is independent of the
256     // view port size, given by WebWidget::size().
257
258     virtual bool isFixedLayoutModeEnabled() const = 0;
259     virtual void enableFixedLayoutMode(bool enable) = 0;
260
261     virtual WebSize fixedLayoutSize() const = 0;
262     virtual void setFixedLayoutSize(const WebSize&) = 0;
263
264
265     // Auto-Resize -----------------------------------------------------------
266
267     // In auto-resize mode, the view is automatically adjusted to fit the html
268     // content within the given bounds.
269     virtual void enableAutoResizeMode(
270         const WebSize& minSize,
271         const WebSize& maxSize) = 0;
272
273     // Turn off auto-resize.
274     virtual void disableAutoResizeMode() = 0;
275
276     // Media ---------------------------------------------------------------
277
278     // Performs the specified media player action on the node at the given location.
279     virtual void performMediaPlayerAction(
280         const WebMediaPlayerAction&, const WebPoint& location) = 0;
281
282     // Performs the specified plugin action on the node at the given location.
283     virtual void performPluginAction(
284         const WebPluginAction&, const WebPoint& location) = 0;
285
286
287     // Data exchange -------------------------------------------------------
288
289     // Copy to the clipboard the image located at a particular point in the
290     // WebView (if there is such an image)
291     virtual void copyImageAt(const WebPoint&) = 0;
292
293     // Notifies the WebView that a drag has terminated.
294     virtual void dragSourceEndedAt(
295         const WebPoint& clientPoint, const WebPoint& screenPoint,
296         WebDragOperation operation) = 0;
297
298     // Notifies the WebView that a drag is going on.
299     virtual void dragSourceMovedTo(
300         const WebPoint& clientPoint, const WebPoint& screenPoint,
301         WebDragOperation operation) = 0;
302
303     // Notfies the WebView that the system drag and drop operation has ended.
304     virtual void dragSourceSystemDragEnded() = 0;
305
306     // Callback methods when a drag-and-drop operation is trying to drop
307     // something on the WebView.
308     // FIXME: Remove this method after chromium changes catch up.
309     virtual WebDragOperation dragTargetDragEnter(
310         const WebDragData&,
311         const WebPoint& clientPoint, const WebPoint& screenPoint,
312         WebDragOperationsMask operationsAllowed) = 0;
313     virtual WebDragOperation dragTargetDragEnter(
314         const WebDragData&,
315         const WebPoint& clientPoint, const WebPoint& screenPoint,
316         WebDragOperationsMask operationsAllowed,
317         int keyModifiers) = 0;
318     // FIXME: Remove this method after chromium changes catch up.
319     virtual WebDragOperation dragTargetDragOver(
320         const WebPoint& clientPoint, const WebPoint& screenPoint,
321         WebDragOperationsMask operationsAllowed) = 0;
322     virtual WebDragOperation dragTargetDragOver(
323         const WebPoint& clientPoint, const WebPoint& screenPoint,
324         WebDragOperationsMask operationsAllowed,
325         int keyModifiers) = 0;
326     virtual void dragTargetDragLeave() = 0;
327     // FIXME: Remove this method after chromium changes catch up.
328     virtual void dragTargetDrop(
329         const WebPoint& clientPoint, const WebPoint& screenPoint) = 0;
330     virtual void dragTargetDrop(
331         const WebPoint& clientPoint, const WebPoint& screenPoint,
332         int keyModifiers) = 0;
333
334
335     // Support for resource loading initiated by plugins -------------------
336
337     // Returns next unused request identifier which is unique within the
338     // parent Page.
339     virtual unsigned long createUniqueIdentifierForRequest() = 0;
340
341
342     // Developer tools -----------------------------------------------------
343
344     // Inspect a particular point in the WebView.  (x = -1 || y = -1) is a
345     // special case, meaning inspect the current page and not a specific
346     // point.
347     virtual void inspectElementAt(const WebPoint&) = 0;
348
349     // Settings used by the inspector.
350     virtual WebString inspectorSettings() const = 0;
351     virtual void setInspectorSettings(const WebString&) = 0;
352     virtual bool inspectorSetting(const WebString& key,
353                                   WebString* value) const = 0;
354     virtual void setInspectorSetting(const WebString& key,
355                                      const WebString& value) = 0;
356
357     // The embedder may optionally engage a WebDevToolsAgent.  This may only
358     // be set once per WebView.
359     virtual WebDevToolsAgent* devToolsAgent() = 0;
360
361
362     // Accessibility -------------------------------------------------------
363
364     // Returns the accessibility object for this view.
365     virtual WebAccessibilityObject accessibilityObject() = 0;
366
367
368     // Autofill  -----------------------------------------------------------
369
370     // Notifies the WebView that Autofill suggestions are available for a node.
371     // |itemIDs| is a vector of IDs for the menu items. A positive itemID is a
372     // unique ID for the Autofill entries. Other MenuItemIDs are defined in
373     // WebAutofillClient.h
374     virtual void applyAutofillSuggestions(
375         const WebNode&,
376         const WebVector<WebString>& names,
377         const WebVector<WebString>& labels,
378         const WebVector<WebString>& icons,
379         const WebVector<int>& itemIDs,
380         int separatorIndex = -1) = 0;
381
382     // Hides any popup (suggestions, selects...) that might be showing.
383     virtual void hidePopups() = 0;
384
385
386     // Context menu --------------------------------------------------------
387
388     virtual void performCustomContextMenuAction(unsigned action) = 0;
389
390
391     // Popup menu ----------------------------------------------------------
392
393     // Sets whether select popup menus should be rendered by the browser.
394     WEBKIT_EXPORT static void setUseExternalPopupMenus(bool);
395
396
397     // Visited link state --------------------------------------------------
398
399     // Tells all WebView instances to update the visited link state for the
400     // specified hash.
401     WEBKIT_EXPORT static void updateVisitedLinkState(unsigned long long hash);
402
403     // Tells all WebView instances to update the visited state for all
404     // their links.
405     WEBKIT_EXPORT static void resetVisitedLinkState();
406
407
408     // Custom colors -------------------------------------------------------
409
410     virtual void setScrollbarColors(unsigned inactiveColor,
411                                     unsigned activeColor,
412                                     unsigned trackColor) = 0;
413
414     virtual void setSelectionColors(unsigned activeBackgroundColor,
415                                     unsigned activeForegroundColor,
416                                     unsigned inactiveBackgroundColor,
417                                     unsigned inactiveForegroundColor) = 0;
418
419     // User scripts --------------------------------------------------------
420     WEBKIT_EXPORT static void addUserScript(const WebString& sourceCode,
421                                             const WebVector<WebString>& patterns,
422                                             UserScriptInjectAt injectAt,
423                                             UserContentInjectIn injectIn);
424     WEBKIT_EXPORT static void addUserStyleSheet(const WebString& sourceCode,
425                                                 const WebVector<WebString>& patterns,
426                                                 UserContentInjectIn injectIn,
427                                                 UserStyleInjectionTime injectionTime = UserStyleInjectInSubsequentDocuments);
428     WEBKIT_EXPORT static void removeAllUserContent();
429
430     // Modal dialog support ------------------------------------------------
431
432     // Call these methods before and after running a nested, modal event loop
433     // to suspend script callbacks and resource loads.
434     WEBKIT_EXPORT static void willEnterModalLoop();
435     WEBKIT_EXPORT static void didExitModalLoop();
436
437     // GPU acceleration support --------------------------------------------
438
439     // Returns the (on-screen) WebGraphicsContext3D associated with
440     // this WebView. One will be created if it doesn't already exist.
441     // This is used to set up sharing between this context (which is
442     // that used by the compositor) and contexts for WebGL and other
443     // APIs.
444     virtual WebGraphicsContext3D* graphicsContext3D() = 0;
445
446     // Context that's in the compositor's share group, but is not the compositor context itself.
447     // Can be used for allocating resources that the compositor will later access.
448     virtual WebGraphicsContext3D* sharedGraphicsContext3D() = 0;
449
450     // Called to inform the WebView that a wheel fling animation was started externally (for instance
451     // by the compositor) but must be completed by the WebView.
452     virtual void transferActiveWheelFlingAnimation(const WebActiveWheelFlingParameters&) = 0;
453
454     // Visibility -----------------------------------------------------------
455
456     // Sets the visibility of the WebView.
457     virtual void setVisibilityState(WebPageVisibilityState visibilityState,
458                                     bool isInitialState) { }
459
460     // PageOverlay ----------------------------------------------------------
461
462     // Adds/removes page overlay to this WebView. These functions change the
463     // graphical appearance of the WebView. WebPageOverlay paints the
464     // contents of the page overlay. It also provides an z-order number for
465     // the page overlay. The z-order number defines the paint order the page
466     // overlays. Page overlays with larger z-order number will be painted after
467     // page overlays with smaller z-order number. That is, they appear above
468     // the page overlays with smaller z-order number. If two page overlays have
469     // the same z-order number, the later added one will be on top.
470     virtual void addPageOverlay(WebPageOverlay*, int /*z-order*/) = 0;
471     virtual void removePageOverlay(WebPageOverlay*) = 0;
472
473     // Battery status API support -------------------------------------------
474
475     // Updates the battery status in the BatteryClient. This also triggers the
476     // appropriate JS events (e.g. sends a 'levelchange' event to JS if the
477     // level is changed in this update from the previous update).
478     virtual void updateBatteryStatus(const WebBatteryStatus&) { }
479
480     // Testing functionality for LayoutTestController -----------------------
481
482     // Simulates a compositor lost context.
483     virtual void loseCompositorContext(int numTimes) = 0;
484
485 protected:
486     ~WebView() {}
487 };
488
489 } // namespace WebKit
490
491 #endif