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
|
/****************************************************************************
**
** Copyright (C) 2014 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.
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 page's navigation history,
allows to run JavaScript code in the context of the page's main frame and enables
customization of handlers for specific events such as showing custom authentication
dialogs.
\section1 Examples
There are several Qt WebEngine Widgets examples located in the
\l{Qt WebEngine Widgets Examples} page.
\section1 License Information
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
Chromium is licensed under the following license:
Copyright (c) 2013 The Chromium Authors. 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.
\endlegalese
*/
/*!
\group webengine-widgetexamples
\title Qt WebEngine Widgets Examples
\brief Examples demonstrating the Qt WebEngine Widgets usage
\ingroup all-examples
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.
*/
|
