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
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\module QtWebEngine
\title Qt WebEngine Widgets C++ Classes
\brief Provides a web browser engine as well as C++ classes to render and
interact with web content
To include the definitions of the module's classes, use the
following directive:
\snippet snippets/qtwebengine_build_snippet.qdoc 1
To link against the module, add this line to your \l qmake \c
.pro file:
\snippet snippets/qtwebengine_build_snippet.qdoc 0
*/
/*!
\page qtwebenginewidgets-index.html
\title Qt WebEngine Widgets
\ingroup modules
\brief The Qt WebEngine Widgets module provides a web browser engine as well as
C++ classes to render and interact with web content.
Qt WebEngine Widgets provides a Web browser engine that makes it easy to embed
content from the World Wide Web into your Qt application. At the same time
Web content can be enhanced with native controls.
Qt WebEngine Widgets provides facilities for rendering of HyperText Markup
Language (HTML), Extensible HyperText Markup Language (XHTML) and Scalable
Vector Graphics (SVG) documents, styled using Cascading Style Sheets (CSS)
and scripted with JavaScript.
In addition to providing pure rendering features, HTML documents can be
made fully editable to the user through the use of the \c{contenteditable}
attribute on HTML elements.
Qt WebEngine is based on the Chromium project. More information about
Chromium itself can be found on the \l{http://www.chromium.org}
{Chromium Project} Web site.
\section1 Including In Your Project
To include the definitions of the module's classes, use the
following directive:
\snippet snippets/qtwebengine_build_snippet.qdoc 1
To link against the module, add this line to your \l qmake \c
.pro file:
\snippet snippets/qtwebengine_build_snippet.qdoc 0
\section1 Notes
\note Web site icons, also known as "FavIcons", are currently not supported
on Windows. We plan to address this in a future release.
\section1 Architecture
Before an application can use the Qt WebEngine Widgets classes, it must call
the static initialization method for the module.
\snippet snippets/simple/main.cpp Initializing QWebEngineWidgets
The easiest way to render content is through the QWebEngineView class. As a
widget it can be embedded into your forms or a graphics view, and it
provides convenience functions for downloading and rendering web sites.
\snippet snippets/simple/main.cpp Using QWebEngineView
QWebEngineView is used to view Web pages. An instance of QWebEngineView has one
QWebEnginePage. QWebEnginePage provides access to the document structure in a page,
describing features such as frames, the navigation history, and the
undo/redo stack for editable content.
Common web browser features, defaults and other settings can be configured
through the QWebEngineSettings class. It is possible to provide defaults for all
QWebEnginePage instances through the default settings. Individual attributes
can be overridden by the page specific settings object.
\section1 Netscape Plugin Support
\note Netscape plugin support is only available on desktop platforms.
Since WebEngine supports the Netscape Plugin API, Qt applications can display
Web pages that embed common plugins on platforms for which those plugins
are available. To enable plugin support, the user must have the appropriate
binary files for those plugins installed and the \l{QWebEngineSettings::PluginsEnabled}
attribute must be enabled for the application.
The following locations are searched for plugins:
\table
\header \li Linux/Unix (X11)
\row \li
\list
\li \c{.mozilla/plugins} in the user's home directory
\li \c{.netscape/plugins} in the user's home directory
\li System locations, such as
\list
\li \c{/usr/lib/browser/plugins}
\li \c{/usr/local/lib/mozilla/plugins}
\li \c{/usr/lib/firefox/plugins}
\li \c{/usr/lib64/browser-plugins}
\li \c{/usr/lib/browser-plugins}
\li \c{/usr/lib/mozilla/plugins}
\li \c{/usr/local/netscape/plugins}
\li \c{/opt/mozilla/plugins}
\li \c{/opt/mozilla/lib/plugins}
\li \c{/opt/netscape/plugins}
\li \c{/opt/netscape/communicator/plugins}
\li \c{/usr/lib/netscape/plugins}
\li \c{/usr/lib/netscape/plugins-libc5}
\li \c{/usr/lib/netscape/plugins-libc6}
\li \c{/usr/lib64/netscape/plugins}
\li \c{/usr/lib64/mozilla/plugins}
\endlist
\li Locations specified by environment variables:
\list
\li \c{$MOZILLA_HOME/plugins}
\li \c{$MOZ_PLUGIN_PATH}
\li \c{$QTWEBKIT_PLUGIN_PATH}
\endlist
\endlist
\endtable
\table
\header \li Windows
\row \li
\list
\li The user's \c{Application Data\Mozilla\plugins} directory
\li Standard system locations of plugins for Quicktime, Flash, etc.
\endlist
\endtable
\table
\header \li Mac OS X
\row \li
\list
\li \c{Library/Internet Plug-Ins} in the user's home directory
\li The system \c{/Library/Internet Plug-Ins} directory
\endlist
\endtable
\section1 Examples
There are several Qt WebEngine Widgets examples located in the
\l{Qt WebEngine Widgets Examples} page.
\section1 License Information
//FIXME: check if we are allowed to use the name chromium here or if it is considered promotional use.
This is a snapshot of the integration of Chromium into Qt. The exact version information
can be found in the \c{VERSION} file supplied with Qt.
Qt Commercial Edition licensees that wish to distribute applications that
use the Qt WebEngine module need to be aware of their obligations under the
GNU Library General Public License (LGPL).
Developers using the Open Source Edition can choose to redistribute
the module under the appropriate version of the GNU LGPL.
\legalese
// FIXME: add correct licensing terms for chromium / blink. The one copied from QtWebKit does not apply.
\endlegalese
*/
/*!
\group webengine-widgetexamples
\title Qt WebEngine Widgets Examples
\brief Examples demonstrating the Qt WebEngine Widgets usage
\ingroup all-examples
// FIXME: same as above - can we use Chromium / Blink?
Qt provides an integrated Web browser component based on Chromium, the popular
open source browser engine.
These examples and demonstrations show a range of different uses for Qt WebEngine,
from displaying Web pages within a Qt user interface to an implementation of
a basic function Web browser.
*/
|
