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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
/*
* Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
* Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies)
* Copyright (c) 2012 Hewlett-Packard Development Company, L.P.
* Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this program; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
// The documentation in this file was imported from QtWebKit and is thus constrained
// by its LGPL license. Documentation written from scratch for new methods should be
// placed inline in the code as usual.
/*!
\page qtwebengine-index.html
\title Qt WebEngine
The Qt WebEngine module provides the WebEngineView API which allows QML applications
to render regions of dynamic web content. A \e{WebEngineView} component may share
the screen with other QML components or encompass the full screen as
specified within the QML application.
It allows an
application to load pages into the WebEngineView, either by URL or with
an HTML string, and navigate within session history. By default,
links to different pages load within the same WebEngineView, but applications
may intercept requests to delegate links to other functions.
The following sample QML application loads a web page, responds to session
history context, and intercepts requests for external links. It also makes
use of \l ScrollView from \l {Qt Quick Controls} to add scroll bars for
the content area.
\code
import QtQuick 2.0
import QtQuick.Controls 1.0
import QtWebEngine 1.0
ScrollView {
width: 1280
height: 720
WebEngineView {
id: webview
url: "http://qt-project.org"
anchors.fill: parent
onNavigationRequested: {
// detect URL scheme prefix, most likely an external link
var schemaRE = /^\w+:/;
if (schemaRE.test(request.url)) {
request.action = WebEngineView.AcceptRequest;
} else {
request.action = WebEngineView.IgnoreRequest;
// delegate request.url here
}
}
}
}
\endcode
\section1 Examples
There are several Qt WebEngine examples located in the
\l{Qt WebEngine Examples} page.
*/
/*!
\qmltype WebEngineView
\instantiates QQuickWebEngineView
\inqmlmodule QtWebEngine 1.0
\brief A WebEngineView renders web content within a QML application
*/
/*!
\qmlmethod void WebEngineView::goBack()
Go backward within the browser's session history, if possible.
(Equivalent to the \c{window.history.back()} DOM method.)
\sa WebEngineView::canGoBack
*/
/*!
\qmlmethod void WebEngineView::goForward()
Go forward within the browser's session history, if possible.
(Equivalent to the \c{window.history.forward()} DOM method.)
*/
/*!
\qmlmethod void WebEngineView::stop()
Stop loading the current page.
*/
/*!
\qmlmethod void WebEngineView::reload()
Reload the current page. (Equivalent to the
\c{window.location.reload()} DOM method.)
*/
/*!
\qmlproperty url WebEngineView::url
The location of the currently displaying HTML page. This writable
property offers the main interface to load a page into a web view.
It functions the same as the \c{window.location} DOM property.
\sa WebEngineView::loadHtml()
*/
/*!
\qmlproperty url WebEngineView::icon
The location of the currently displaying Web site icon, also known as favicon
or shortcut icon. This read-only URL corresponds to the image used within a
mobile browser application to represent a bookmarked page on the device's home
screen.
This example uses the \c{icon} property to build an \c{Image} element:
\code
Image {
id: appIcon
source: webView.icon != "" ? webView.icon : "fallbackFavIcon.png";
...
}
\endcode
*/
/*!
\qmlproperty int WebEngineView::loadProgress
The amount of the page that has been loaded, expressed as an integer
percentage in the range from \c{0} to \c{100}.
*/
/*!
\qmlproperty bool WebEngineView::canGoBack
Returns \c{true} if there are prior session history entries, \c{false}
otherwise.
*/
/*!
\qmlproperty bool WebEngineView::canGoForward
Returns \c{true} if there are subsequent session history entries,
\c{false} otherwise.
*/
/*!
\qmlproperty bool WebEngineView::loading
Returns \c{true} if the HTML page is currently loading, \c{false} otherwise.
*/
/*!
\qmlproperty string WebEngineView::title
The title of the currently displaying HTML page, a read-only value
that reflects the contents of the \c{<title>} tag.
*/
/*!
\qmlmethod void WebEngineView::loadHtml(string html, url baseUrl, url unreachableUrl)
\brief Loads the specified \a html as the content of the web view.
(This method offers a lower-level alternative to the \c{url} property,
which references HTML pages via URL.)
External objects such as stylesheets or images referenced in the HTML
document are located relative to \a baseUrl. For example if provided \a html
was originally retrieved from \c http://www.example.com/documents/overview.html
and that was the base url, then an image referenced with the relative url \c diagram.png
would be looked for at \c{http://www.example.com/documents/diagram.png}.
If an \a unreachableUrl is passed it is used as the url for the loaded
content. This is typically used to display error pages for a failed
load.
\sa WebEngineView::url
*/
/*!
\qmlsignal WebEngineView::onLoadingChanged(loadRequest)
Occurs when any page load begins, ends, or fails. Various read-only
parameters are available on the \a loadRequest:
\list
\li \c{url}: the location of the resource that is loading.
\li \c{status}: Reflects one of three load states:
\c{LoadStartedStatus}, \c{LoadSucceededStatus}, or
\c{LoadFailedStatus}. See \c{WebEngineView::LoadStatus}.
\li \c{errorString}: description of load error.
\li \c{errorCode}: HTTP error code.
\li \c{errorDomain}: high-level error types, one of
\c{NetworkErrorDomain}, \c{HttpErrorDomain}, \c{InternalErrorDomain},
\c{DownloadErrorDomain}, or \c{NoErrorDomain}. See
\l{WebEngineView::ErrorDomain}.
\endlist
\sa WebEngineView::loading
*/
/*!
\qmlsignal WebEngineView::onLinkHovered(hoveredUrl, hoveredTitle)
Within a mouse-driven interface, this signal is emitted when a mouse
pointer passes over a link, corresponding to the \c{mouseover} DOM
event. (May also occur in touch interfaces for \c{mouseover} events
that are not cancelled with \c{preventDefault()}.) The \a{hoveredUrl}
provides the link's location, and the \a{hoveredTitle} is any avalable
link text.
*/
/*!
\qmlsignal WebEngineView::onNavigationRequested(request)
Occurs for various kinds of navigation. If the application listens
for this signal, it must set the \c{request.action} to either of the
following \l{WebEngineView::NavigationRequestAction} enum values:
\list
\li \c{AcceptRequest}: Allow navigation to external pages within the
web view. This represents the default behavior when no listener is
active.
\li \c{IgnoreRequest}: Suppress navigation to new pages within the web
view. (The listener may then delegate navigation externally to
the browser application.)
\endlist
The \a{request} also provides the following read-only values:
\list
\li \c{url}: The location of the requested page.
\li \c{navigationType}: contextual information, one of
\c{LinkClickedNavigation}, \c{BackForwardNavigation},
\c{ReloadNavigation}, \c{FormSubmittedNavigation},
\c{FormResubmittedNavigation}, or \c{OtherNavigation} enum values.
See \l{WebEngineView::NavigationType}.
\li \c{keyboardModifiers}: potential states for \l{Qt::KeyboardModifier}.
\li \c{mouseButton}: potential states for \l{Qt::MouseButton}.
\endlist
*/
/*!
\qmlproperty enumeration WebEngineView::ErrorDomain
Details various high-level error types.
\table
\header
\li Constant
\li Description
\row
\li InternalErrorDomain
\li Content fails to be interpreted by Qt WebEngine.
\row
\li NetworkErrorDomain
\li Error results from faulty network connection.
\row
\li HttpErrorDomain
\li Error is produced by server.
\row
\li DownloadErrorDomain
\li Error in saving file.
\row
\li NoErrorDomain
\li Unspecified fallback error.
\endtable
*/
/*!
\qmlproperty enumeration WebEngineView::NavigationType
Distinguishes context for various navigation actions.
\table
\header
\li Constant
\li Description
\row
\li LinkClickedNavigation
\li Navigation via link.
\row
\li FormSubmittedNavigation
\li Form data is posted.
\row
\li BackForwardNavigation
\li Navigation back and forth within session history.
\row
\li ReloadNavigation
\li The current page is reloaded.
\row
\li FormResubmittedNavigation
\li Form data is re-posted.
\row
\li OtherNavigation
\li Unspecified fallback method of navigation.
\endtable
*/
/*!
\qmlproperty enumeration WebEngineView::LoadStatus
Reflects a page's load status.
\table
\header
\li Constant
\li Description
\row
\li LoadStartedStatus
\li Page is currently loading.
\row
\li LoadSucceededStatus
\li Page has successfully loaded, and is not currently loading.
\row
\li LoadFailedStatus
\li Page has failed to load, and is not currently loading.
\endtable
*/
/*!
\qmlproperty enumeration WebEngineView::NavigationRequestAction
Specifies a policy when navigating a link to an external page.
\table
\header
\li Constant
\li Description
\row
\li AcceptRequest
\li Allow navigation to external pages within the web view.
\row
\li IgnoreRequest
\li Suppress navigation to new pages within the web view.
\endtable
*/
|
