summaryrefslogtreecommitdiffstats
path: root/src/webenginewidgets/doc/src
diff options
context:
space:
mode:
authorAllan Sandfeld Jensen <allan.jensen@theqtcompany.com>2015-08-18 09:47:34 +0200
committerAllan Sandfeld Jensen <allan.jensen@theqtcompany.com>2015-08-18 10:08:28 +0200
commite53ddd7b7ec0ca766557d947031820986f11b1a2 (patch)
tree19f7d4c09af27da94bda2dd0ff647b1913b70a67 /src/webenginewidgets/doc/src
parent13d03ef21d3bd67595bd0b36be7401f6e6bcbbd6 (diff)
parentdd7b409388949bc628af75a6e65474d699c416d3 (diff)
Merge branch '5.5' into 5.6
Diffstat (limited to 'src/webenginewidgets/doc/src')
-rw-r--r--src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc46
-rw-r--r--src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc4
-rw-r--r--src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc10
-rw-r--r--src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc2
-rw-r--r--src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc5
5 files changed, 26 insertions, 41 deletions
diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc
index ed1f1a773..1e8cda065 100644
--- a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc
+++ b/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc
@@ -28,6 +28,7 @@
/*!
\module QtWebEngineWidgets
\title Qt WebEngine Widgets C++ Classes
+ \qtvariable webenginewidgets
\brief Provides a web browser engine as well as C++ classes to render and
interact with web content
@@ -47,43 +48,22 @@
\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.
+ \brief The Qt WebEngine Widgets module provides a web browser engine as
+ well as C++ classes to display 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 gives you a Web browser engine that you can use to
+ embed content easily from the World Wide Web into your Qt application.
- Qt WebEngine Widgets provides facilities for rendering of HyperText Markup
- Language version 5 (HTML5), Extensible HyperText Markup Language (XHTML) and Scalable
- Vector Graphics (SVG) documents, styled using Cascading Style Sheets (CSS)
- and scripted with JavaScript.
+ Qt WebEngine Widgets lets you display HyperText Markup Language version 5
+ (HTML5), 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.
+ HTML and XHTML documents can also be made fully editable to the user by
+ using 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 Should I use Qt WebEngine or Qt WebKit?
-
- Qt WebEngine supercedes the \l{Qt WebKit Widgets}{Qt WebKit} module, which
- was based on the WebKit project, but isn't actively synchronized with the
- upstream WebKit code since Qt 5.2.
-
- Chromium provides its own network and painting engines and is developed
- tightly together with its dependent modules, thus Qt WebEngine provides
- better and more reliable support for the latest HTML5 specification.
- For this reason Qt WebEngine is however heavier than Qt WebKit and doesn't
- give direct access to the network stack and the HTML document through C++ APIs.
-
- For new code we suggest using Qt WebEngine, but it makes sense to continue
- using Qt WebKit for applications that are in need of a deeper C++ API than
- having better and up-to-date support for HTML, CSS and JavaScript features.
-
- For tips on how to change a Qt WebKit application to use Qt WebEngine, see
- \l{Porting from Qt WebKit to Qt WebEngine}
+ Qt WebEngine is based on the Chromium project. See the
+ \l{http://www.chromium.org}{Chromium Project} Web site for more information.
\section1 Including In Your Project
diff --git a/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc
index 08690e504..2674890de 100644
--- a/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc
@@ -25,7 +25,7 @@
/*!
\class QWebEngineHistoryItem
\brief The QWebEngineHistoryItem class represents one item in the history of a QWebEnginePage
-
+ \since 5.4
\inmodule QtWebEngineWidgets
Each QWebEngineHistoryItem instance represents an entry in the history stack of a Web page,
@@ -100,7 +100,7 @@
/*!
\class QWebEngineHistory
\brief The QWebEngineHistory class represents the history of a QWebEnginePage
-
+ \since 5.4
\inmodule QtWebEngineWidgets
Each QWebEnginePage instance contains a history of visited pages that can be accessed
diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
index 29e5d60ce..676643387 100644
--- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
@@ -27,7 +27,7 @@
/*!
\class QWebEnginePage
\brief The QWebEnginePage class provides an object to view and edit web documents.
-
+ \since 5.4
\inmodule QtWebEngineWidgets
QWebEnginePage holds a main frame responsible for web content, the history
@@ -50,8 +50,8 @@
The title of an HTML page can be accessed with the title() property.
Additionally, a page may also specify an icon, which can be accessed
- using the icon() property. If the title or the icon changes, the
- corresponding titleChanged() and iconChanged() signals will be emitted.
+ using the iconUrl() property. If the title or the icon changes, the
+ corresponding titleChanged() and iconUrlChanged() signals will be emitted.
The zoomFactor() property can be used to change the overall size
of the content displayed in the page.
@@ -586,6 +586,10 @@
Sets the permission for the web site identified by \a securityOrigin to use \a feature to \a policy.
+ \note Call this method on featurePermissionRequested() signal, as it is
+ meant to serve pending feature requests only. Setting feature permissions
+ ahead of a request has no effect.
+
\sa featurePermissionRequested(), featurePermissionRequestCanceled()
*/
diff --git a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc
index 82410a50f..521c08781 100644
--- a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc
@@ -32,7 +32,7 @@
/*!
\class QWebEngineSettings
- \since QtWebEngine 1.0
+ \since 5.4
\brief The QWebEngineSettings class provides an object to store the settings used
by QWebEnginePage
diff --git a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
index d1b390580..163e9a28e 100644
--- a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
@@ -28,6 +28,7 @@
\class QWebEngineView
\brief The QWebEngineView class provides a widget that is used to view and edit
web documents.
+ \since 5.4
\ingroup advanced
\inmodule QtWebEngineWidgets
@@ -58,8 +59,8 @@
The title of an HTML document can be accessed with the title() property.
Additionally, a web site may also specify an icon, which can be accessed
- using the icon() property. If the title or the icon changes, the corresponding
- titleChanged() and iconChanged() signals will be emitted. The
+ using the iconUrl() property. If the title or the icon changes, the corresponding
+ titleChanged() and iconUrlChanged() signals will be emitted. The
textSizeMultiplier() property can be used to change the overall size of
the text displayed in the web view.