1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
/*
* Copyright (C) 2009 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef WebView_h
#define WebView_h
#error "This header file is still a work in progress; do not include!"
#include "WebCommon.h"
#include "WebWidget.h"
namespace WebKit {
class WebPreferences;
class WebString;
class WebViewClient;
struct WebPoint;
class WebView : public WebWidget {
public:
WEBKIT_API WebView* create(WebViewClient*);
// Preferences ---------------------------------------------------------
virtual WebPreferences* preferences() = 0;
// Corresponds to the encoding of the main frame. Setting the page
// encoding may cause the main frame to reload.
virtual WebString pageEncoding() const = 0;
virtual void setPageEncoding(const WebString&) = 0;
// Closing -------------------------------------------------------------
// Returns false if any handler suppressed unloading.
virtual bool dispatchBeforeUnloadEvent() = 0;
virtual void dispatchUnloadEvent() = 0;
// Frames --------------------------------------------------------------
virtual WebFrame* mainFrame() = 0;
// Returns the frame identified by the given name. This method
// supports pseudo-names like _self, _top, and _blank. It traverses
// the entire frame tree containing this tree looking for a frame that
// matches the given name.
virtual WebFrame* findFrameByName(const WebString& name) = 0;
// Focus ---------------------------------------------------------------
virtual WebFrame* focusedFrame() = 0;
virtual void setFocusedFrame(WebFrame*) = 0;
// Restores focus to the previously focused frame and element. This
// method is invoked when the WebView is shown after being hidden, and
// focus is to be restored. When a WebView loses focus, it remembers
// the frame and element that had focus.
virtual void restoreFocus() = 0;
// Focus the first (last if reverse is true) focusable node.
virtual void setInitialFocus(bool reverse) = 0;
// Clears the focused node (and selection if a text field is focused)
// to ensure that a text field on the page is not eating keystrokes we
// send it.
virtual void clearFocusedNode() = 0;
// Capture -------------------------------------------------------------
// Fills the contents of this WebView's frames into the given string.
// If the text is longer than maxCharacters, it will be clipped to that
// length. Warning: this function may be slow depending on the number
// of characters retrieved and page complexity. For a typically sized
// page, expect it to take on the order of milliseconds.
//
// If there is room, subframe text will be recursively appended. Each
// frame will be separated by an empty line.
virtual WebString captureAsText(unsigned maxCharacters) = 0;
// Paints the contents of this WebView into a bitmapped image. This
// image will not have plugins drawn. Devices are cheap to copy because
// the data is internally ref-counted, so we allocate and return a new
// copy.
//
// Set scrollToZero to force all frames to be scrolled to 0,0 before
// being painted into the image. This will not send DOM events because
// it just draws the contents at a different place, but it does mean
// the scrollbars in the resulting image will appear to be wrong
// (they'll be painted as if the content was scrolled).
virtual WebImage captureAsImage(bool scrollToZero) = 0;
// Printing ------------------------------------------------------------
// Reformats the WebView for printing. pageSize is the page size in
// pixels. Returns the number of pages that can be printed at the
// given page size.
virtual int printBegin(const WebSize& pageSize);
// Prints one page, and returns the calculated page shrinking factor
// (usually between 1/1.25 and 1/2). Returns 0 if the page number is
// invalid or not in printing mode.
virtual float printPage(int pageToPrint, const WebCanvas&);
// Reformats the WebView for screen display.
virtual void printEnd();
// Zoom ----------------------------------------------------------------
// Change the text zoom level. It will make the zoom level 20% larger
// or smaller. If textOnly is set, the text size will be changed.
// When unset, the entire page's zoom factor will be changed.
//
// You can only have either text zoom or full page zoom at one time.
// Changing the mode will change things in weird ways. Generally the
// app should only support text zoom or full page zoom, and not both.
//
// zoomDefault will reset both full page and text zoom.
virtual void zoomIn(bool textOnly) = 0;
virtual void zoomOut(bool textOnly) = 0;
virtual void zoomDefault() = 0;
// Data exchange -------------------------------------------------------
// Copy to the clipboard the image located at a particular point in the
// WebView (if there is such an image)
virtual void copyImageAt(const WebPoint&) = 0;
// Notifies the WebView that a drag has terminated.
virtual void dragSourceEndedAt(const WebPoint& clientPoint,
const WebPoint& screenPoint) = 0;
// Notifies the WebView that a drag and drop operation is in progress, with
// dropable items over the view.
virtual void dragSourceMovedTo(const WebPoint& clientPoint,
const WebPoint& screenPoint) = 0;
// Notfies the WebView that the system drag and drop operation has ended.
virtual void dragSourceSystemDragEnded() = 0;
// Callback methods when a drag-and-drop operation is trying to drop
// something on the WebView.
virtual bool dragTargetDragEnter(const WebDragData&, int identity,
const WebPoint& clientPoint,
const WebPoint& screenPoint) = 0;
virtual bool dragTargetDragOver(const WebPoint& clientPoint,
const WebPoint& screenPoint) = 0;
virtual void dragTargetDragLeave() = 0;
virtual void dragTargetDrop(const WebPoint& clientPoint,
const WebPoint& screenPoint) = 0;
virtual int dragIdentity() = 0;
// Developer tools -----------------------------------------------------
virtual WebDevToolsAgent* devToolsAgent() = 0;
// Inspect a particular point in the WebView. (x = -1 || y = -1) is a
// special case, meaning inspect the current page and not a specific
// point.
virtual void inspectElementAt(const WebPoint&) = 0;
// FIXME what about:
// StoreFocusForFrame
// DownloadImage
// Get/SetDelegate
// InsertText -> should move to WebTextInput
// AutofillSuggestionsForNode
// HideAutofillPopup
};
} // namespace WebKit
|
