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
|
/****************************************************************************
**
** 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 QtWebKit
\title Qt WebKit 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 webkitsnippets/qtwebkit_build_snippet.qdoc 1
To link against the module, add this line to your \l qmake \c
.pro file:
\snippet webkitsnippets/qtwebkit_build_snippet.qdoc 0
*/
/*!
\page qtwebkitwidgets-index.html
\title Qt WebKit Widgets
\ingroup modules
\brief The Qt WebKit Widgets module provides a web browser engine as well as
C++ classes to render and interact with web content.
Qt WebKit 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 WebKit 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.
A bridge between the JavaScript execution environment and the Qt object
model makes it possible for custom QObjects to be scripted. For detailed
documentation see \l{The Qt WebKit Bridge}.
Integration with the Qt networking module enables Web pages to be transparently loaded
from Web servers, the local file system or even the Qt resource system.
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.
QtWebKit has been enhanced to become more attractive on the mobile front as well.
For more information see \l{QtWebKit Goes Mobile}.
Qt WebKit is based on the Open Source WebKit engine. More information about
WebKit itself can be found on the \l{WebKit Open Source Project} Web site.
\section1 Including In Your Project
To include the definitions of the module's classes, use the
following directive:
\snippet webkitsnippets/qtwebkit_build_snippet.qdoc 1
To link against the module, add this line to your \l qmake \c
.pro file:
\snippet webkitsnippets/qtwebkit_build_snippet.qdoc 0
\section1 Notes
\note Building the Qt WebKit module with debugging symbols is problematic
on many platforms due to the size of the WebKit engine. We recommend
building the module only in release mode for embedded platforms.
Currently Qt WebKit will always be compiled without debugging symbols
when using gcc. Take a look at
\c{Tools/mkspecs/features/production_build.prf} if you need to change this.
\note Web site icons, also known as "FavIcons", are currently not supported
on Windows. We plan to address this in a future release.
\note WebKit has certain minimum requirements that must be met on
Embedded Linux systems. See the \l{Qt for Embedded Linux Requirements}
document for more information.
\section1 Architecture
The easiest way to render content is through the QWebView 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 webkitsnippets/simple/main.cpp Using QWebView
QWebView is used to view Web pages. An instance of QWebView has one
QWebPage. QWebPage 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.
HTML documents can be nested using frames in a frameset. An individual
frame in HTML is represented using the QWebFrame class. This class includes the
bridge to the JavaScript window object and can be painted using QPainter.
Each QWebPage has one QWebFrame object as its main frame, and the main frame
may contain many child frames.
Individual elements of an HTML document can be accessed via DOM JavaScript
interfaces from within a web page. The equivalent of this API in Qt WebKit
is represented by QWebElement. QWebElement objects are obtained using QWebFrame's
\l{QWebFrame::}{findAllElements()} and \l{QWebFrame::}{findFirstElement()}
functions with CSS selector queries.
Common web browser features, defaults and other settings can be configured
through the QWebSettings class. It is possible to provide defaults for all
QWebPage 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 WebKit 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{QWebSettings::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 WebKit Widgets examples located in the
\l{Qt WebKit Examples} page.
\section1 License Information
This is a snapshot of the Qt port of WebKit. 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 WebKit 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
WebKit is licensed under the GNU Library General Public License.
Individual contributor names and copyright dates can be found
inline in the code.
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 library 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 library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
\endlegalese
*/
|
