From 484f2d8c92e57cbe2c581a65a2ccf461eb68c883 Mon Sep 17 00:00:00 2001 From: Jocelyn Turcotte Date: Thu, 13 Mar 2014 12:37:46 +0100 Subject: Rough port of the documentation to QtWebEngine This is a gross mechanical modification of the documentation, along with build system bindings to allow it to generate. This should allow doing iterative improvements to the documentation from now on. This fixes project-related qdoc warnings but we still need to do some serious work to get the documentation better fitting QtWebEngine. All the documentation is ported to match the current state of our headers (without trying to adapt to modified APIs yet) and we should clear the part of the documentation that we don't need at the same time that we clean up our public headers. Change-Id: I6fb4e10e8b4c1c53be7bc7c581286248ac04d4da Reviewed-by: Andras Becsi --- .../doc/qtwebenginewidgets.qdocconf | 39 ++ src/webenginewidgets/doc/snippets/simple/main.cpp | 10 +- .../doc/src/qtwebenginewidgets.qdoc | 97 ++- .../doc/src/qwebenginehistory_lgpl.qdoc | 95 +-- .../doc/src/qwebenginehistoryinterface_lgpl.qdoc | 29 +- .../doc/src/qwebengineinspector_lgpl.qdoc | 53 +- .../doc/src/qwebenginepage_lgpl.qdoc | 719 +++++++++------------ .../doc/src/qwebenginesecurityorigin_lgpl.qdoc | 47 +- .../doc/src/qwebenginesettings_lgpl.qdoc | 147 ++--- .../doc/src/qwebengineview_lgpl.qdoc | 173 +++-- src/webenginewidgets/webenginewidgets.pro | 2 + 11 files changed, 669 insertions(+), 742 deletions(-) create mode 100644 src/webenginewidgets/doc/qtwebenginewidgets.qdocconf (limited to 'src/webenginewidgets') diff --git a/src/webenginewidgets/doc/qtwebenginewidgets.qdocconf b/src/webenginewidgets/doc/qtwebenginewidgets.qdocconf new file mode 100644 index 000000000..200132099 --- /dev/null +++ b/src/webenginewidgets/doc/qtwebenginewidgets.qdocconf @@ -0,0 +1,39 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) + +project = QtWebEngineWidgets +description = Qt WebEngineWidgets Reference Documentation +url = http://qt-project.org/doc/qt-$QT_VER +version = $QT_VERSION + +examplesinstallpath = webenginewidgets + +qhp.projects = QtWebEngineWidgets + +qhp.QtWebEngineWidgets.file = qtwebenginewidgets.qhp +qhp.QtWebEngineWidgets.namespace = org.qt-project.qtwebenginewidgets.$QT_VERSION_TAG +qhp.QtWebEngineWidgets.virtualFolder = qtwebenginewidgets +qhp.QtWebEngineWidgets.indexTitle = Qt WebEngine Widgets +qhp.QtWebEngineWidgets.indexRoot = + +qhp.QtWebEngineWidgets.filterAttributes = qtwebenginewidgets $QT_VERSION qtrefdoc +qhp.QtWebEngineWidgets.customFilters.Qt.name = QtWebEngineWidgets $QT_VERSION +qhp.QtWebEngineWidgets.customFilters.Qt.filterAttributes = qtwebenginewidgets $QT_VERSION +qhp.QtWebEngineWidgets.subprojects = classes examples +qhp.QtWebEngineWidgets.subprojects.classes.title = C++ Classes +qhp.QtWebEngineWidgets.subprojects.classes.indexTitle = Qt WebEngine Widgets C++ Classes +qhp.QtWebEngineWidgets.subprojects.classes.selectors = class fake:headerfile +qhp.QtWebEngineWidgets.subprojects.classes.sortPages = true +qhp.QtWebEngineWidgets.subprojects.examples.title = Examples +qhp.QtWebEngineWidgets.subprojects.examples.indexTitle = Qt WebEngine Widgets Code Samples +qhp.QtWebEngineWidgets.subprojects.examples.selectors = fake:example + +tagfile = ../../../doc/qtwebenginewidgets/qtwebenginewidgets.tags + +depends += qtcore qtnetwork qtgui qtwidgets qtdoc + +headerdirs += ../api +sourcedirs += ../api +exampledirs += ../../../examples/webenginewidgets . + +navigation.landingpage = "Qt WebEngine Widgets" +navigation.cppclassespage = "Qt WebEngine Widgets C++ Classes" diff --git a/src/webenginewidgets/doc/snippets/simple/main.cpp b/src/webenginewidgets/doc/snippets/simple/main.cpp index 408630eb1..ef05fec6f 100644 --- a/src/webenginewidgets/doc/snippets/simple/main.cpp +++ b/src/webenginewidgets/doc/snippets/simple/main.cpp @@ -19,16 +19,16 @@ #include #include -#include +#include int main(int argc, char *argv[]) { QApplication app(argc, argv); QWidget *parent = 0; -//! [Using QWebView] - QWebView *view = new QWebView(parent); - view->load(QUrl("http://qt.nokia.com/")); +//! [Using QWebEngineView] + QWebEngineView *view = new QWebEngineView(parent); + view->load(QUrl("http://qt-project.org/")); view->show(); -//! [Using QWebView] +//! [Using QWebEngineView] return app.exec(); } diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc index 5847d1403..247bd6321 100644 --- a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc +++ b/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc @@ -26,121 +26,90 @@ ****************************************************************************/ /*! - \module QtWebKit - \title Qt WebKit Widgets C++ Classes + \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 webkitsnippets/qtwebkit_build_snippet.qdoc 1 + \snippet snippets/qtwebengine_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 + \snippet snippets/qtwebengine_build_snippet.qdoc 0 */ /*! \page qtwebkitwidgets-index.html - \title Qt WebKit Widgets + \title Qt WebEngine Widgets \ingroup modules - \brief The Qt WebKit Widgets module provides a web browser engine as well as + \brief The Qt WebEngine 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 + 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 WebKit Widgets provides facilities for rendering of HyperText Markup + 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. - 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. + 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 webkitsnippets/qtwebkit_build_snippet.qdoc 1 + \snippet snippets/qtwebengine_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 + \snippet snippets/qtwebengine_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 + 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 webkitsnippets/simple/main.cpp Using QWebView + \snippet snippets/simple/main.cpp Using QWebEngineView - QWebView is used to view Web pages. An instance of QWebView has one - QWebPage. QWebPage provides access to the document structure in a page, + 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. - 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 + 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 WebKit supports the Netscape Plugin API, Qt applications can display + 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{QWebSettings::PluginsEnabled} + 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: @@ -199,23 +168,23 @@ \section1 Examples - There are several Qt WebKit Widgets examples located in the - \l{Qt WebKit Examples} page. + 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 Qt port of WebKit. The exact version information + This is a snapshot of the Qt port of WebEngine. 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 + 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 - WebKit is licensed under the GNU Library General Public License. + WebEngine is licensed under the GNU Library General Public License. Individual contributor names and copyright dates can be found inline in the code. @@ -235,3 +204,17 @@ Boston, MA 02110-1301, USA. \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 WebEngine, 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. +*/ diff --git a/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc index fc6d5e50e..83bc8ecdf 100644 --- a/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc @@ -1,4 +1,5 @@ /* + Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies) This library is free software; you can redistribute it and/or @@ -22,13 +23,13 @@ // placed inline in the code as usual. /*! - \class QWebHistoryItem + \class QWebEngineHistoryItem \since 4.4 - \brief The QWebHistoryItem class represents one item in the history of a QWebPage + \brief The QWebEngineHistoryItem class represents one item in the history of a QWebEnginePage - \inmodule QtWebKit + \inmodule QtWebEngine - Each QWebHistoryItem instance represents an entry in the history stack of a Web page, + Each QWebEngineHistoryItem instance represents an entry in the history stack of a Web page, containing information about the page, its location, and when it was last visited. The following table shows the properties of the page held by the history item, and @@ -44,69 +45,69 @@ \row \li userData() \li The user specific data that was stored with the history item. \endtable - \note QWebHistoryItem objects are value based, but \e{explicitly shared}. Changing - a QWebHistoryItem instance by calling setUserData() will change all copies of that + \note QWebEngineHistoryItem objects are value based, but \e{explicitly shared}. Changing + a QWebEngineHistoryItem instance by calling setUserData() will change all copies of that instance. - \sa QWebHistory, QWebPage::history(), QWebHistoryInterface + \sa QWebEngineHistory, QWebEnginePage::history(), QWebEngineHistoryInterface */ /*! - \fn QWebHistoryItem::QWebHistoryItem(const QWebHistoryItem &other) + \fn QWebEngineHistoryItem::QWebEngineHistoryItem(const QWebEngineHistoryItem &other) Constructs a history item from \a other. The new item and \a other will share their data, and modifying either this item or \a other will modify both instances. */ /*! - \fn QWebHistoryItem &QWebHistoryItem::operator=(const QWebHistoryItem &other) + \fn QWebEngineHistoryItem &QWebEngineHistoryItem::operator=(const QWebEngineHistoryItem &other) Assigns the \a other history item to this. This item and \a other will share their data, and modifying either this item or \a other will modify both instances. */ /*! - \fn QWebHistoryItem::~QWebHistoryItem() + \fn QWebEngineHistoryItem::~QWebEngineHistoryItem() Destroys the history item. */ /*! - \fn QUrl QWebHistoryItem::originalUrl() const + \fn QUrl QWebEngineHistoryItem::originalUrl() const Returns the original URL associated with the history item. \sa url() */ /*! - \fn QUrl QWebHistoryItem::url() const + \fn QUrl QWebEngineHistoryItem::url() const Returns the URL associated with the history item. \sa originalUrl(), title(), lastVisited() */ /*! - \fn QString QWebHistoryItem::title() const + \fn QString QWebEngineHistoryItem::title() const Returns the title of the page associated with the history item. \sa icon(), url(), lastVisited() */ /*! - \fn QDateTime QWebHistoryItem::lastVisited() const + \fn QDateTime QWebEngineHistoryItem::lastVisited() const Returns the date and time that the page associated with the item was last visited. \sa title(), icon(), url() */ /*! - \fn QIcon QWebHistoryItem::icon() const + \fn QIcon QWebEngineHistoryItem::icon() const Returns the icon associated with the history item. \sa title(), url(), lastVisited() */ /*! - \fn QVariant QWebHistoryItem::userData() const + \fn QVariant QWebEngineHistoryItem::userData() const \since 4.5 Returns the user specific data that was stored with the history item. @@ -114,7 +115,7 @@ */ /*! - \fn void QWebHistoryItem::setUserData(const QVariant& userData) + \fn void QWebEngineHistoryItem::setUserData(const QVariant& userData) \since 4.5 Stores user specific data \a userData with the history item. @@ -125,20 +126,20 @@ */ /*! - \fn bool QWebHistoryItem::isValid() const + \fn bool QWebEngineHistoryItem::isValid() const \since 4.5 Returns whether this is a valid history item. */ /*! - \class QWebHistory + \class QWebEngineHistory \since 4.4 - \brief The QWebHistory class represents the history of a QWebPage + \brief The QWebEngineHistory class represents the history of a QWebEnginePage - \inmodule QtWebKit + \inmodule QtWebEngine - Each QWebPage instance contains a history of visited pages that can be accessed - by QWebPage::history(). QWebHistory represents this history and makes it possible + Each QWebEnginePage instance contains a history of visited pages that can be accessed + by QWebEnginePage::history(). QWebEngineHistory represents this history and makes it possible to navigate it. The history uses the concept of a \e{current item}, dividing the pages visited @@ -157,28 +158,28 @@ number of items is given by count(), and the history can be cleared with the clear() function. - QWebHistory's state can be saved to a QDataStream using the >> operator and loaded + QWebEngineHistory's state can be saved to a QDataStream using the >> operator and loaded by using the << operator. - \sa QWebHistoryItem, QWebHistoryInterface, QWebPage + \sa QWebEngineHistoryItem, QWebEngineHistoryInterface, QWebEnginePage */ /*! - \fn void QWebHistory::clear() + \fn void QWebEngineHistory::clear() Clears the history. \sa count(), items() */ /*! - \fn QList QWebHistory::items() const + \fn QList QWebEngineHistory::items() const Returns a list of all items currently in the history. \sa count(), clear() */ /*! - \fn QList QWebHistory::backItems(int maxItems) const + \fn QList QWebEngineHistory::backItems(int maxItems) const Returns the list of items in the backwards history list. At most \a maxItems entries are returned. @@ -186,7 +187,7 @@ */ /*! - \fn QList QWebHistory::forwardItems(int maxItems) const + \fn QList QWebEngineHistory::forwardItems(int maxItems) const Returns the list of items in the forward history list. At most \a maxItems entries are returned. @@ -194,7 +195,7 @@ */ /*! - \fn bool QWebHistory::canGoBack() const + \fn bool QWebEngineHistory::canGoBack() const Returns true if there is an item preceding the current item in the history; otherwise returns false. @@ -202,14 +203,14 @@ */ /*! - \fn bool QWebHistory::canGoForward() const + \fn bool QWebEngineHistory::canGoForward() const Returns true if we have an item to go forward to; otherwise returns false. \sa canGoBack() */ /*! - \fn void QWebHistory::back() + \fn void QWebEngineHistory::back() Set the current item to be the previous item in the history and goes to the corresponding page; i.e., goes back one history item. @@ -217,7 +218,7 @@ */ /*! - \fn void QWebHistory::forward() + \fn void QWebEngineHistory::forward() Sets the current item to be the next item in the history and goes to the corresponding page; i.e., goes forward one history item. @@ -225,45 +226,45 @@ */ /*! - \fn void QWebHistory::goToItem(const QWebHistoryItem &item) + \fn void QWebEngineHistory::goToItem(const QWebEngineHistoryItem &item) Sets the current item to be the specified \a item in the history and goes to the page. \sa back(), forward() */ /*! - \fn QWebHistoryItem QWebHistory::backItem() const + \fn QWebEngineHistoryItem QWebEngineHistory::backItem() const Returns the item before the current item in the history. */ /*! - \fn QWebHistoryItem QWebHistory::currentItem() const + \fn QWebEngineHistoryItem QWebEngineHistory::currentItem() const Returns the current item in the history. */ /*! - \fn QWebHistoryItem QWebHistory::forwardItem() const + \fn QWebEngineHistoryItem QWebEngineHistory::forwardItem() const Returns the item after the current item in the history. */ /*! - \fn int QWebHistory::currentItemIndex() const + \fn int QWebEngineHistory::currentItemIndex() const \since 4.5 Returns the index of the current item in history. */ /*! - \fn QWebHistoryItem QWebHistory::itemAt(int i) const + \fn QWebEngineHistoryItem QWebEngineHistory::itemAt(int i) const Returns the item at index \a i in the history. */ /*! - \fn int QWebHistory::count() const + \fn int QWebEngineHistory::count() const Returns the total number of items in the history. */ /*! - \fn int QWebHistory::maximumItemCount() const + \fn int QWebEngineHistory::maximumItemCount() const \since 4.5 Returns the maximum number of items in the history. @@ -271,7 +272,7 @@ */ /*! - \fn void QWebHistory::setMaximumItemCount(int count) + \fn void QWebEngineHistory::setMaximumItemCount(int count) \since 4.5 Sets the maximum number of items in the history to \a count. @@ -279,9 +280,9 @@ */ /*! - \fn QDataStream& operator<<(QDataStream& target, const QWebHistory& history) + \fn QDataStream& operator<<(QDataStream& target, const QWebEngineHistory& history) \since 4.6 - \relates QWebHistory + \relates QWebEngineHistory \brief The operator<< function streams a history into a data stream. @@ -290,12 +291,12 @@ /*! - \fn QDataStream& operator>>(QDataStream& source, QWebHistory& history) - \relates QWebHistory + \fn QDataStream& operator>>(QDataStream& source, QWebEngineHistory& history) + \relates QWebEngineHistory \since 4.6 \brief The operator>> function loads a history from a data stream. - Loads a QWebHistory from the specified \a stream into the given \a history. + Loads a QWebEngineHistory from the specified \a stream into the given \a history. */ diff --git a/src/webenginewidgets/doc/src/qwebenginehistoryinterface_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginehistoryinterface_lgpl.qdoc index 1d17e7ce0..00e4f1a7d 100644 --- a/src/webenginewidgets/doc/src/qwebenginehistoryinterface_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebenginehistoryinterface_lgpl.qdoc @@ -1,4 +1,5 @@ /* + Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). Copyright (C) 2007 Staikos Computing Services Inc. This library is free software; you can redistribute it and/or @@ -24,60 +25,60 @@ // placed inline in the code as usual. /*! - \class QWebHistoryInterface + \class QWebEngineHistoryInterface \since 4.4 - \brief The QWebHistoryInterface class provides an interface to implement link history. + \brief The QWebEngineHistoryInterface class provides an interface to implement link history. - \inmodule QtWebKit + \inmodule QtWebEngine - The QWebHistoryInterface is an interface that can be used to + The QWebEngineHistoryInterface is an interface that can be used to keep track of visited links. It contains two pure virtual methods that are called by the WebKit engine: addHistoryEntry() is used to add urls that have been visited to the interface, while historyContains() is used to query whether the given url has been - visited by the user. By default the QWebHistoryInterface is not set, so WebKit does not keep + visited by the user. By default the QWebEngineHistoryInterface is not set, so WebKit does not keep track of visited links. - \note The history tracked by QWebHistoryInterface is not specific to an instance of QWebPage + \note The history tracked by QWebEngineHistoryInterface is not specific to an instance of QWebEnginePage but applies to all pages. */ /*! - \fn void QWebHistoryInterface::setDefaultInterface(QWebHistoryInterface* defaultInterface) + \fn void QWebEngineHistoryInterface::setDefaultInterface(QWebEngineHistoryInterface* defaultInterface) Sets a new default interface, \a defaultInterface, that will be used by all of WebKit to keep track of visited links. If an interface without a parent has already been set, the old interface will be deleted. - When the application exists QWebHistoryInterface will automatically delete the + When the application exists QWebEngineHistoryInterface will automatically delete the \a defaultInterface if it does not have a parent. */ /*! - \fn QWebHistoryInterface* QWebHistoryInterface::defaultInterface() + \fn QWebEngineHistoryInterface* QWebEngineHistoryInterface::defaultInterface() Returns the default interface that will be used by WebKit. If no default interface has been set, WebKit will not keep track of visited links and a null pointer will be returned. \sa setDefaultInterface() */ /*! - \fn QWebHistoryInterface::QWebHistoryInterface(QObject* parent) - Constructs a new QWebHistoryInterface with parent \a parent. + \fn QWebEngineHistoryInterface::QWebEngineHistoryInterface(QObject* parent) + Constructs a new QWebEngineHistoryInterface with parent \a parent. */ /*! - \fn QWebHistoryInterface::~QWebHistoryInterface() + \fn QWebEngineHistoryInterface::~QWebEngineHistoryInterface() Destroys the interface. If this is currently the default interface it will be unset. */ /*! - \fn bool QWebHistoryInterface::historyContains(const QString &url) const = 0 + \fn bool QWebEngineHistoryInterface::historyContains(const QString &url) const = 0 Called by the WebKit engine to query whether a certain \a url has been visited by the user already. Returns true if the \a url is part of the history of visited links; otherwise returns false. */ /*! - \fn void QWebHistoryInterface::addHistoryEntry(const QString &url) = 0 + \fn void QWebEngineHistoryInterface::addHistoryEntry(const QString &url) = 0 Called by WebKit to add another \a url to the list of visited pages. */ diff --git a/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc index 864618309..2e0c6ec82 100644 --- a/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc @@ -1,4 +1,5 @@ /* + Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies) This library is free software; you can redistribute it and/or @@ -22,39 +23,39 @@ // placed inline in the code as usual. /*! - \class QWebInspector + \class QWebEngineInspector \since 4.6 - \inmodule QtWebKit - \brief The QWebInspector class allows the placement and control of a - QWebPage's inspector. + \inmodule QtWebEngine + \brief The QWebEngineInspector class allows the placement and control of a + QWebEnginePage's inspector. The inspector can display a page's hierarchy, its loading statistics and the current state of its individual elements. It is mostly used by web developers. - The QWebPage to be inspected must be specified using the setPage() method. + The QWebEnginePage to be inspected must be specified using the setPage() method. - A typical use of QWebInspector follows: + A typical use of QWebEngineInspector follows: - \snippet webkitsnippets/qtwebkit_qwebinspector_snippet.cpp 0 + \snippet snippets/qtwebengine_qwebengineinspector_snippet.cpp 0 - A QWebInspector can be made visible either programmatically using - setVisible(), or by the user through the attached QWebPage's context + A QWebEngineInspector can be made visible either programmatically using + setVisible(), or by the user through the attached QWebEnginePage's context menu. - \note A QWebInspector will display a blank widget if either: + \note A QWebEngineInspector will display a blank widget if either: \list \li page() is null - \li QWebSettings::DeveloperExtrasEnabled is false + \li QWebEngineSettings::DeveloperExtrasEnabled is false \endlist \section1 Resources This class acts mostly as a container and a controller for the inspector. Most of the resources needed by the inspector are owned by the associated - QWebPage and are allocated the first time that: + QWebEnginePage and are allocated the first time that: \list \li an element is inspected - \li the QWebInspector is shown. + \li the QWebEngineInspector is shown. \endlist \section1 Inspector configuration persistence @@ -63,41 +64,41 @@ user interface (e.g. the resource tracking "Always enable" option). The inspector UI is itself a web page and is using HTML local storage to persist those settings. - Since the internal QWebPage used by the inspector isn't exposed in the API, + Since the internal QWebEnginePage used by the inspector isn't exposed in the API, the only way to enable those settings to be persisted is currently to enable - local storage globally through QWebSettings::globalSettings(). + local storage globally through QWebEngineSettings::globalSettings(). - \sa QWebSettings::localStoragePath(), QWebSettings::LocalStorageEnabled + \sa QWebEngineSettings::localStoragePath(), QWebEngineSettings::LocalStorageEnabled */ /*! - \fn QWebInspector::QWebInspector(QWidget* parent) - Constructs an unbound QWebInspector with \a parent as its parent. + \fn QWebEngineInspector::QWebEngineInspector(QWidget* parent) + Constructs an unbound QWebEngineInspector with \a parent as its parent. */ /*! - \fn QWebInspector::~QWebInspector() + \fn QWebEngineInspector::~QWebEngineInspector() Destroys the inspector. */ /*! - \fn void QWebInspector::setPage(QWebPage* page) - Bind this inspector to the QWebPage to be inspected. + \fn void QWebEngineInspector::setPage(QWebEnginePage* page) + Bind this inspector to the QWebEnginePage to be inspected. \b {Notes:} \list - \li There can only be one QWebInspector associated with a QWebPage + \li There can only be one QWebEngineInspector associated with a QWebEnginePage and vice versa. \li Calling this method with a null \a page will break the current association, if any. - \li If \a page is already associated to another QWebInspector, the association - will be replaced and the previous QWebInspector will become unbound + \li If \a page is already associated to another QWebEngineInspector, the association + will be replaced and the previous QWebEngineInspector will become unbound \endlist \sa page() */ /*! - \fn QWebPage* QWebInspector::page() const - Returns the inspected QWebPage. + \fn QWebEnginePage* QWebEngineInspector::page() const + Returns the inspected QWebEnginePage. If no web page is currently associated, a null pointer is returned. */ diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc index a63ac9c6f..54569bdc5 100644 --- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc @@ -1,4 +1,5 @@ /* + Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). Copyright (C) 2008, 2009, 2012 Nokia Corporation and/or its subsidiary(-ies) Copyright (C) 2007 Staikos Computing Services Inc. Copyright (C) 2007 Apple Inc. @@ -24,24 +25,48 @@ // placed inline in the code as usual. /*! - \class QWebPage + \class QWebEnginePage \since 4.4 - \brief The QWebPage class provides an object to view and edit web documents. + \brief The QWebEnginePage class provides an object to view and edit web documents. - \inmodule QtWebKit + \inmodule QtWebEngine - QWebPage holds a main frame responsible for web content, settings, the history - of navigated links and actions. This class can be used, together with QWebFrame, - to provide functionality like QWebView in a widget-less environment. + QWebEnginePage holds a main frame responsible for web content, settings, the history + of navigated links and actions. This class can be used to provide functionality like + QWebEngineView in a widget-less environment. - QWebPage's API is very similar to QWebView, as you are still provided with + QWebEnginePage's API is very similar to QWebEngineView, as you are still provided with common functions like action() (known as - \l{QWebView::pageAction()}{pageAction}() in QWebView), triggerAction(), - findText() and settings(). More QWebView-like functions can be found in the - main frame of QWebPage, obtained via the mainFrame() function. For example, - the \l{QWebFrame::load()}{load}(), \l{QWebFrame::setUrl()}{setUrl}() and - \l{QWebFrame::setHtml()}{setHtml}() functions for QWebPage can be accessed - using QWebFrame. + \l{QWebEngineView::pageAction()}{pageAction}() in QWebEngineView), triggerAction(), + findText() and settings(). + + + A page can be loaded using load() or setUrl(). Alternatively, if you have + the HTML content readily available, you can use setHtml() instead. + + The QWebEnginePage class also offers methods to retrieve both the URL currently + loaded by its main frame (see url()) as well as the URL originally requested + to be loaded (see requestedUrl()). These methods make possible the retrieval + of the URL before and after a DNS resolution or a redirection occurs during + the load process. The requestedUrl() also matches to the URL added to the + page history (\l{QWebEngineHistory}) if load is successful. + + 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. + The zoomFactor() property can be used to change the overall size + of the content displayed in the page. + + There are multiple ways to programmatically examine the contents of a page. + The hitTestContent() function can be used to find elements by coordinate. + For access to the underlying DOM tree, there is documentElement(), + findAllElements() and findFirstElement(). + + A QWebEnginePage can be printed onto a QPrinter using the print() function. + This function is marked as a slot and can be conveniently connected to + \l{QPrintPreviewDialog}'s \l{QPrintPreviewDialog::}{paintRequested()} + signal. The loadStarted() signal is emitted when the page begins to load.The loadProgress() signal, on the other hand, is emitted whenever an element @@ -51,39 +76,37 @@ Its argument, either true or false, indicates whether or not the load operation succeeded. - \section1 Using QWebPage in a Widget-less Environment + \section1 Using QWebEnginePage in a Widget-less Environment - Before you begin painting a QWebPage object, you need to set the size of + Before you begin painting a QWebEnginePage object, you need to set the size of the viewport by calling setViewportSize(). Then, you invoke the main - frame's render function (QWebFrame::render()). An example of this + frame's render function (QWebEnginePage::render()). An example of this is shown in the code snippet below. Suppose we have a \c Thumbnail class as follows: - \snippet webkitsnippets/webpage/main.cpp 0 + \snippet snippets/webpage/main.cpp 0 - The \c Thumbnail's constructor takes in a \a url. We connect our QWebPage - object's \l{QWebPage::}{loadFinished()} signal to our private slot, + The \c Thumbnail's constructor takes in a \a url. We connect our QWebEnginePage + object's \l{QWebEnginePage::}{loadFinished()} signal to our private slot, \c render(). - \snippet webkitsnippets/webpage/main.cpp 1 + \snippet snippets/webpage/main.cpp 1 The \c render() function shows how we can paint a thumbnail using a - QWebPage object. + QWebEnginePage object. - \snippet webkitsnippets/webpage/main.cpp 2 + \snippet snippets/webpage/main.cpp 2 - We begin by setting the \l{QWebPage::viewportSize()}{viewportSize} and + We begin by setting the \l{QWebEnginePage::viewportSize()}{viewportSize} and then we instantiate a QImage object, \c image, with the same size as our - \l{QWebPage::viewportSize()}{viewportSize}. This image is then sent + \l{QWebEnginePage::viewportSize()}{viewportSize}. This image is then sent as a parameter to \c painter. Next, we render the contents of the main frame and its subframes into \c painter. Finally, we save the scaled image. - - \sa QWebFrame */ /*! - \fn QMenu *QWebPage::createStandardContextMenu() + \fn QMenu *QWebEnginePage::createStandardContextMenu() \since 4.5 This function creates the standard context menu which is shown when the user clicks on the web page with the right mouse button. It is @@ -92,7 +115,7 @@ */ /*! - \property QWebPage::palette + \property QWebEnginePage::palette \brief the page's palette The base brush of the palette is used to draw the background of the main frame. @@ -101,7 +124,7 @@ */ /*! - \fn QVariant QWebPage::inputMethodQuery(Qt::InputMethodQuery property) const + \fn QVariant QWebEnginePage::inputMethodQuery(Qt::InputMethodQuery property) const This method is used by the input method to query a set of properties of the page to be able to support complex input method operations as support for surrounding text and reconversions. @@ -112,7 +135,7 @@ */ /*! - \enum QWebPage::FindFlag + \enum QWebEnginePage::FindFlag This enum describes the options available to the findText() function. The options can be OR-ed together from the following list: @@ -134,21 +157,21 @@ */ /*! - \enum QWebPage::LinkDelegationPolicy + \enum QWebEnginePage::LinkDelegationPolicy This enum defines the delegation policies a webpage can have when activating links and emitting the linkClicked() signal. - \value DontDelegateLinks No links are delegated. Instead, QWebPage tries to handle them all. + \value DontDelegateLinks No links are delegated. Instead, QWebEnginePage tries to handle them all. \value DelegateExternalLinks When activating links that point to documents not stored on the local filesystem or an equivalent - such as the Qt resource system - then linkClicked() is emitted. \value DelegateAllLinks Whenever a link is activated the linkClicked() signal is emitted. - \sa QWebPage::linkDelegationPolicy + \sa QWebEnginePage::linkDelegationPolicy */ /*! - \enum QWebPage::NavigationType + \enum QWebEnginePage::NavigationType This enum describes the types of navigation available when browsing through hyperlinked documents. @@ -164,7 +187,7 @@ */ /*! - \enum QWebPage::WebAction + \enum QWebEnginePage::WebAction This enum describes the types of action which can be performed on the web page. @@ -252,7 +275,7 @@ */ /*! - \enum QWebPage::WebWindowType + \enum QWebEnginePage::WebWindowType This enum describes the types of window that can be created by the createWindow() function. @@ -261,11 +284,11 @@ */ /*! - \class QWebPage::ViewportAttributes + \class QWebEnginePage::ViewportAttributes \since 4.7 - \brief The QWebPage::ViewportAttributes class describes hints that can be applied to a viewport. + \brief The QWebEnginePage::ViewportAttributes class describes hints that can be applied to a viewport. - QWebPage::ViewportAttributes provides a description of a viewport, such as viewport geometry, + QWebEnginePage::ViewportAttributes provides a description of a viewport, such as viewport geometry, initial scale factor with limits, plus information about whether a user should be able to scale the contents in the viewport or not, ie. by zooming. @@ -275,69 +298,69 @@ All values might not be set, as such when dealing with the hints, the developer needs to check whether the values are valid. Negative values denote an invalid qreal value. - \inmodule QtWebKit + \inmodule QtWebEngine */ /*! - \fn QWebPage::ViewportAttributes::ViewportAttributes() - Constructs an empty QWebPage::ViewportAttributes. + \fn QWebEnginePage::ViewportAttributes::ViewportAttributes() + Constructs an empty QWebEnginePage::ViewportAttributes. */ /*! - \fn QWebPage::ViewportAttributes::ViewportAttributes(const QWebPage::ViewportAttributes& other) - Constructs a QWebPage::ViewportAttributes which is a copy from \a other . + \fn QWebEnginePage::ViewportAttributes::ViewportAttributes(const QWebEnginePage::ViewportAttributes& other) + Constructs a QWebEnginePage::ViewportAttributes which is a copy from \a other . */ /*! - \fn QWebPage::ViewportAttributes::~ViewportAttributes() - Destroys the QWebPage::ViewportAttributes. + \fn QWebEnginePage::ViewportAttributes::~ViewportAttributes() + Destroys the QWebEnginePage::ViewportAttributes. */ /*! - \fn QWebPage::ViewportAttributes& QWebPage::ViewportAttributes::operator=(const QWebPage::ViewportAttributes& other) - Assigns the given QWebPage::ViewportAttributes to this viewport hints and returns a + \fn QWebEnginePage::ViewportAttributes& QWebEnginePage::ViewportAttributes::operator=(const QWebEnginePage::ViewportAttributes& other) + Assigns the given QWebEnginePage::ViewportAttributes to this viewport hints and returns a reference to this. */ -/*! \fn inline bool QWebPage::ViewportAttributes::isValid() const +/*! \fn inline bool QWebEnginePage::ViewportAttributes::isValid() const Returns whether this is a valid ViewportAttributes or not. An invalid ViewportAttributes will have an empty QSize, negative values for scale factors and true for the boolean isUserScalable. */ -/*! \fn inline QSize QWebPage::ViewportAttributes::size() const +/*! \fn inline QSize QWebEnginePage::ViewportAttributes::size() const Returns the size of the viewport. */ -/*! \fn inline qreal QWebPage::ViewportAttributes::initialScaleFactor() const +/*! \fn inline qreal QWebEnginePage::ViewportAttributes::initialScaleFactor() const Returns the initial scale of the viewport as a multiplier. */ -/*! \fn inline qreal QWebPage::ViewportAttributes::minimumScaleFactor() const +/*! \fn inline qreal QWebEnginePage::ViewportAttributes::minimumScaleFactor() const Returns the minimum scale value of the viewport as a multiplier. */ -/*! \fn inline qreal QWebPage::ViewportAttributes::maximumScaleFactor() const +/*! \fn inline qreal QWebEnginePage::ViewportAttributes::maximumScaleFactor() const Returns the maximum scale value of the viewport as a multiplier. */ -/*! \fn inline bool QWebPage::ViewportAttributes::isUserScalable() const +/*! \fn inline bool QWebEnginePage::ViewportAttributes::isUserScalable() const Determines whether or not the scale can be modified by the user. */ /*! - \fn QWebPage::QWebPage(QObject *parent) - Constructs an empty QWebPage with parent \a parent. + \fn QWebEnginePage::QWebEnginePage(QObject *parent) + Constructs an empty QWebEnginePage with parent \a parent. */ /*! - \fn QWebPage::~QWebPage() + \fn QWebEnginePage::~QWebEnginePage() Destroys the web page. */ /*! - \fn QWebFrame *QWebPage::mainFrame() const + \fn QWebEngineFrame *QWebEnginePage::mainFrame() const Returns the main frame of the page. The main frame provides access to the hierarchy of sub-frames and is also needed if you @@ -347,14 +370,14 @@ */ /*! - \fn QWebFrame *QWebPage::currentFrame() const + \fn QWebEngineFrame *QWebEnginePage::currentFrame() const Returns the frame currently active. \sa mainFrame(), frameCreated() */ /*! - \fn QWebFrame* QWebPage::frameAt(const QPoint& pos) const + \fn QWebEngineFrame* QWebEnginePage::frameAt(const QPoint& pos) const \since 4.6 Returns the frame at the given point \a pos, or 0 if there is no frame at @@ -364,26 +387,26 @@ */ /*! - \fn QWebHistory *QWebPage::history() const + \fn QWebEngineHistory *QWebEnginePage::history() const Returns a pointer to the view's history of navigated web pages. */ /*! - \fn void QWebPage::setView(QWidget* view) + \fn void QWebEnginePage::setView(QWidget* view) Sets the \a view that is associated with the web page. \sa view() */ /*! - \fn QWidget *QWebPage::view() const + \fn QWidget *QWebEnginePage::view() const Returns the view widget that is associated with the web page. \sa setView() */ /*! - \fn void QWebPage::javaScriptConsoleMessage(const QString& message, int lineNumber, const QString& sourceID) + \fn void QWebEnginePage::javaScriptConsoleMessage(const QString& message, int lineNumber, const QString& sourceID) This function is called whenever a JavaScript program tries to print a \a message to the web browser's console. For example in case of evaluation errors the source URL may be provided in \a sourceID as well as the \a lineNumber. @@ -392,7 +415,7 @@ */ /*! - \fn void QWebPage::javaScriptAlert(QWebFrame *frame, const QString& msg) + \fn void QWebEnginePage::javaScriptAlert(QWebEngineFrame *frame, const QString& msg) This function is called whenever a JavaScript program running inside \a frame calls the alert() function with the message \a msg. @@ -400,7 +423,7 @@ */ /*! - \fn bool QWebPage::javaScriptConfirm(QWebFrame *frame, const QString& msg) + \fn bool QWebEnginePage::javaScriptConfirm(QWebEngineFrame *frame, const QString& msg) This function is called whenever a JavaScript program running inside \a frame calls the confirm() function with the message, \a msg. Returns true if the user confirms the message; otherwise returns false. @@ -408,7 +431,7 @@ */ /*! - \fn bool QWebPage::javaScriptPrompt(QWebFrame *frame, const QString& msg, const QString& defaultValue, QString* result) + \fn bool QWebEnginePage::javaScriptPrompt(QWebEngineFrame *frame, const QString& msg, const QString& defaultValue, QString* result) This function is called whenever a JavaScript program running inside \a frame tries to prompt the user for input. The program may provide an optional message, \a msg, as well as a default value for the input in \a defaultValue. @@ -420,7 +443,7 @@ */ /*! - \fn bool QWebPage::shouldInterruptJavaScript() + \fn bool QWebEnginePage::shouldInterruptJavaScript() \since 4.6 This function is called when a JavaScript program is running for a long period of time. @@ -430,43 +453,43 @@ */ /*! - \fn QWebPage *QWebPage::createWindow(WebWindowType type) + \fn QWebEnginePage *QWebEnginePage::createWindow(WebWindowType type) This function is called whenever WebKit wants to create a new window of the given \a type, for example when a JavaScript program requests to open a document in a new window. - If the new window can be created, the new window's QWebPage is returned; otherwise a null pointer is returned. + If the new window can be created, the new window's QWebEnginePage is returned; otherwise a null pointer is returned. - If the view associated with the web page is a QWebView object, then the default implementation forwards - the request to QWebView's createWindow() function; otherwise it returns a null pointer. + If the view associated with the web page is a QWebEngineView object, then the default implementation forwards + the request to QWebEngineView's createWindow() function; otherwise it returns a null pointer. If \a type is WebModalDialog, the application must call setWindowModality(Qt::ApplicationModal) on the new window. \note In the cases when the window creation is being triggered by JavaScript, apart from reimplementing this method application must also set the JavaScriptCanOpenWindows attribute - of QWebSettings to true in order for it to get called. + of QWebEngineSettings to true in order for it to get called. - \sa acceptNavigationRequest(), QWebView::createWindow() + \sa acceptNavigationRequest(), QWebEngineView::createWindow() */ /*! - \fn QObject *QWebPage::createPlugin(const QString &classid, const QUrl &url, const QStringList ¶mNames, const QStringList ¶mValues) + \fn QObject *QWebEnginePage::createPlugin(const QString &classid, const QUrl &url, const QStringList ¶mNames, const QStringList ¶mValues) This function is called whenever WebKit encounters a HTML object element with type "application/x-qt-plugin". It is - called regardless of the value of QWebSettings::PluginsEnabled. The \a classid, \a url, \a paramNames and \a paramValues + called regardless of the value of QWebEngineSettings::PluginsEnabled. The \a classid, \a url, \a paramNames and \a paramValues correspond to the HTML object element attributes and child elements to configure the embeddable object. */ /*! - \fn QStringList QWebPage::supportedContentTypes() const - Returns the list of all content types supported by QWebPage. + \fn QStringList QWebEnginePage::supportedContentTypes() const + Returns the list of all content types supported by QWebEnginePage. */ /*! - \fn bool QWebPage::supportsContentType(const QString& mimeType) const - Returns true if QWebPage can handle the given \a mimeType; otherwise, returns false. + \fn bool QWebEnginePage::supportsContentType(const QString& mimeType) const + Returns true if QWebEnginePage can handle the given \a mimeType; otherwise, returns false. */ /*! - \fn void QWebPage::triggerAction(WebAction action, bool) + \fn void QWebEnginePage::triggerAction(WebAction action, bool) This function can be called to trigger the specified \a action. It is also called by Qt WebKit if the user triggers the action, for example through a context menu item. @@ -478,8 +501,7 @@ */ /*! - \fn void QWebPage::setViewportSize(const QSize &size) const - \property QWebPage::viewportSize + \property QWebEnginePage::viewportSize \brief the size of the viewport The size affects for example the visibility of scrollbars @@ -488,11 +510,11 @@ By default, for a newly-created Web page, this property contains a size with zero width and height. - \sa QWebFrame::render(), preferredContentsSize + \sa render(), preferredContentsSize */ /*! - \fn QWebPage::ViewportAttributes QWebPage::viewportAttributesForSize(const QSize& availableSize) const + \fn QWebEnginePage::ViewportAttributes QWebEnginePage::viewportAttributesForSize(const QSize& availableSize) const Computes the optimal viewport configuration given the \a availableSize, when user interface components are disregarded. @@ -523,8 +545,7 @@ */ /*! - \fn void QWebPage::setPreferredContentsSize(const QSize& size) const - \property QWebPage::preferredContentsSize + \property QWebEnginePage::preferredContentsSize \since 4.6 \brief a custom size used for laying out the page contents. @@ -544,7 +565,7 @@ */ /* - \fn void QWebPage::setActualVisibleContentRect(const QRect& rect) const + \fn void QWebEnginePage::setActualVisibleContentRect(const QRect& rect) const This function is to be called after any (animated) scroll/pan has ended, in the case the application handles the scrolling/panning of the web contents. This is commonly used in combination with tiling where is it common for the application to pan the actual view, which then resizes itself to the size of the contents. @@ -552,11 +573,11 @@ \note Calling this function makes WebKit stop trying to calculate the visibleContentRect. To turn that on again, call this method with an empty rect. - \sa QGraphicsWebView::resizesToContents, QWebSettings::TiledBackingStoreEnabled + \sa QWebEngineSettings::TiledBackingStoreEnabled */ /*! - \fn bool QWebPage::acceptNavigationRequest(QWebFrame *frame, const QNetworkRequest &request, QWebPage::NavigationType type) + \fn bool QWebEnginePage::acceptNavigationRequest(QWebEngineFrame *frame, const QNetworkRequest &request, QWebEnginePage::NavigationType type) This function is called whenever WebKit requests to navigate \a frame to the resource specified by \a request by means of the specified navigation type \a type. @@ -565,22 +586,20 @@ accepted createWindow() will be called. The default implementation interprets the page's linkDelegationPolicy and emits linkClicked accordingly or returns true - to let QWebPage handle the navigation itself. + to let QWebEnginePage handle the navigation itself. \sa createWindow() */ /*! - \fn bool QWebPage::hasSelection() const - \property QWebPage::hasSelection + \property QWebEnginePage::hasSelection \brief whether this page contains selected content or not. \sa selectionChanged() */ /*! - \fn QString QWebPage::selectedText() const - \property QWebPage::selectedText + \property QWebEnginePage::selectedText \brief the text currently selected By default, this property contains an empty string. @@ -589,9 +608,8 @@ */ /*! - \fn QString QWebPage::selectedHtml() const \since 4.8 - \property QWebPage::selectedHtml + \property QWebEnginePage::selectedHtml \brief the HTML currently selected By default, this property contains an empty string. @@ -600,21 +618,20 @@ */ /*! - \fn QAction *QWebPage::action(WebAction action) const + \fn QAction *QWebEnginePage::action(WebAction action) const Returns a QAction for the specified WebAction \a action. - The action is owned by the QWebPage but you can customize the look by + The action is owned by the QWebEnginePage but you can customize the look by changing its properties. - QWebPage also takes care of implementing the action, so that upon + QWebEnginePage also takes care of implementing the action, so that upon triggering the corresponding action is performed on the page. \sa triggerAction() */ /*! - \fn bool QWebPage::isModified() const - \property QWebPage::modified + \property QWebEnginePage::modified \brief whether the page contains unsubmitted form data, or the contents have been changed. By default, this property is false. @@ -623,14 +640,14 @@ */ /*! - \fn QUndoStack *QWebPage::undoStack() const + \fn QUndoStack *QWebEnginePage::undoStack() const Returns a pointer to the undo stack used for editable content. \sa modified */ /*! - \fn bool QWebPage::focusNextPrevChild(bool next) + \fn bool QWebEnginePage::focusNextPrevChild(bool next) Similar to QWidget::focusNextPrevChild() it focuses the next focusable web element if \a next is true; otherwise the previous element is focused. @@ -638,9 +655,8 @@ */ /*! - \fn void QWebPage::setContentEditable(bool editable) - \property QWebPage::contentEditable - \brief whether the content in this QWebPage is editable or not + \property QWebEnginePage::contentEditable + \brief whether the content in this QWebEnginePage is editable or not \since 4.5 If this property is enabled the contents of the page can be edited by the user through a visible @@ -651,9 +667,8 @@ */ /*! - \fn void QWebPage::setForwardUnsupportedContent(bool forward) - \property QWebPage::forwardUnsupportedContent - \brief whether QWebPage should forward unsupported content + \property QWebEnginePage::forwardUnsupportedContent + \brief whether QWebEnginePage should forward unsupported content If enabled, the unsupportedContent() signal is emitted with a network reply that can be used to read the content. @@ -664,16 +679,15 @@ */ /*! - \fn void QWebPage::setLinkDelegationPolicy(LinkDelegationPolicy policy) - \property QWebPage::linkDelegationPolicy - \brief how QWebPage should delegate the handling of links through the + \property QWebEnginePage::linkDelegationPolicy + \brief how QWebEnginePage should delegate the handling of links through the linkClicked() signal The default is to delegate no links. */ /*! - \fn bool QWebPage::swallowContextMenuEvent(QContextMenuEvent *event) + \fn bool QWebEnginePage::swallowContextMenuEvent(QContextMenuEvent *event) Filters the context menu event, \a event, through handlers for scrollbars and custom event handlers in the web page. Returns true if the event was handled; otherwise false. @@ -684,13 +698,13 @@ */ /*! - \fn void QWebPage::updatePositionDependentActions(const QPoint &pos) + \fn void QWebEnginePage::updatePositionDependentActions(const QPoint &pos) Updates the page's actions depending on the position \a pos. For example if \a pos is over an image element the CopyImageToClipboard action is enabled. */ /*! - \enum QWebPage::Extension + \enum QWebEnginePage::Extension This enum describes the types of extensions that the page can support. Before using these extensions, you should verify that the extension is supported by calling supportsExtension(). @@ -707,7 +721,7 @@ */ /*! - \enum QWebPage::ErrorDomain + \enum QWebEnginePage::ErrorDomain \since 4.6 This enum describes the domain of an ErrorPageExtensionOption object (i.e. the layer in which the error occurred). @@ -718,74 +732,74 @@ */ /*! - \class QWebPage::ExtensionOption + \class QWebEnginePage::ExtensionOption \since 4.4 - \brief The ExtensionOption class provides an extended input argument to QWebPage's extension support. + \brief The ExtensionOption class provides an extended input argument to QWebEnginePage's extension support. - \inmodule QtWebKit + \inmodule QtWebEngine - \sa QWebPage::extension(), QWebPage::ExtensionReturn + \sa QWebEnginePage::extension(), QWebEnginePage::ExtensionReturn */ /*! - \class QWebPage::ExtensionReturn + \class QWebEnginePage::ExtensionReturn \since 4.4 - \brief The ExtensionReturn class provides an output result from a QWebPage's extension. + \brief The ExtensionReturn class provides an output result from a QWebEnginePage's extension. - \inmodule QtWebKit + \inmodule QtWebEngine - \sa QWebPage::extension(), QWebPage::ExtensionOption + \sa QWebEnginePage::extension(), QWebEnginePage::ExtensionOption */ /*! - \class QWebPage::ErrorPageExtensionOption + \class QWebEnginePage::ErrorPageExtensionOption \since 4.6 \brief The ErrorPageExtensionOption class describes the option for the error page extension. - \inmodule QtWebKit + \inmodule QtWebEngine The ErrorPageExtensionOption class holds the \a url for which an error occurred as well as the associated \a frame. The error itself is reported by an error \a domain, the \a error code as well as \a errorString. - \sa QWebPage::extension(), QWebPage::ErrorPageExtensionReturn + \sa QWebEnginePage::extension(), QWebEnginePage::ErrorPageExtensionReturn */ /*! - \variable QWebPage::ErrorPageExtensionOption::url + \variable QWebEnginePage::ErrorPageExtensionOption::url \brief the url for which an error occurred */ /*! - \variable QWebPage::ErrorPageExtensionOption::frame + \variable QWebEnginePage::ErrorPageExtensionOption::frame \brief the frame associated with the error */ /*! - \variable QWebPage::ErrorPageExtensionOption::domain + \variable QWebEnginePage::ErrorPageExtensionOption::domain \brief the domain that reported the error */ /*! - \variable QWebPage::ErrorPageExtensionOption::error + \variable QWebEnginePage::ErrorPageExtensionOption::error \brief the error code. Interpretation of the value depends on the \a domain - \sa QWebPage::ErrorDomain + \sa QWebEnginePage::ErrorDomain */ /*! - \variable QWebPage::ErrorPageExtensionOption::errorString + \variable QWebEnginePage::ErrorPageExtensionOption::errorString \brief a string that describes the error */ /*! - \class QWebPage::ErrorPageExtensionReturn + \class QWebEnginePage::ErrorPageExtensionReturn \since 4.6 \brief The ErrorPageExtensionReturn describes the error page, which will be shown for the frame for which the error occurred. - \inmodule QtWebKit + \inmodule QtWebEngine The ErrorPageExtensionReturn class holds the data needed for creating an error page. Some are optional such as \a contentType, which defaults to "text/html", as well as the \a encoding, which @@ -797,83 +811,83 @@ External objects such as stylesheets or images referenced in the HTML are located relative to \a baseUrl. - \sa QWebPage::extension(), QWebPage::ErrorPageExtensionOption, QString::toUtf8() + \sa QWebEnginePage::extension(), QWebEnginePage::ErrorPageExtensionOption, QString::toUtf8() */ /*! - \fn QWebPage::ErrorPageExtensionReturn::ErrorPageExtensionReturn() + \fn QWebEnginePage::ErrorPageExtensionReturn::ErrorPageExtensionReturn() Constructs a new error page object. */ /*! - \variable QWebPage::ErrorPageExtensionReturn::contentType + \variable QWebEnginePage::ErrorPageExtensionReturn::contentType \brief the error page's content type */ /*! - \variable QWebPage::ErrorPageExtensionReturn::encoding + \variable QWebEnginePage::ErrorPageExtensionReturn::encoding \brief the error page encoding */ /*! - \variable QWebPage::ErrorPageExtensionReturn::baseUrl + \variable QWebEnginePage::ErrorPageExtensionReturn::baseUrl \brief the base url External objects such as stylesheets or images referenced in the HTML are located relative to this url. */ /*! - \variable QWebPage::ErrorPageExtensionReturn::content + \variable QWebEnginePage::ErrorPageExtensionReturn::content \brief the HTML content of the error page */ /*! - \class QWebPage::ChooseMultipleFilesExtensionOption + \class QWebEnginePage::ChooseMultipleFilesExtensionOption \since 4.5 \brief The ChooseMultipleFilesExtensionOption class describes the option for the multiple files selection extension. - \inmodule QtWebKit + \inmodule QtWebEngine The ChooseMultipleFilesExtensionOption class holds the frame originating the request and the suggested filenames which might be provided. - \sa QWebPage::extension(), QWebPage::chooseFile(), QWebPage::ChooseMultipleFilesExtensionReturn + \sa QWebEnginePage::extension(), QWebEnginePage::chooseFile(), QWebEnginePage::ChooseMultipleFilesExtensionReturn */ /*! - \variable QWebPage::ChooseMultipleFilesExtensionOption::parentFrame + \variable QWebEnginePage::ChooseMultipleFilesExtensionOption::parentFrame \brief The frame in which the request originated */ /*! - \variable QWebPage::ChooseMultipleFilesExtensionOption::suggestedFileNames + \variable QWebEnginePage::ChooseMultipleFilesExtensionOption::suggestedFileNames \brief The suggested filenames */ /*! - \variable QWebPage::ChooseMultipleFilesExtensionReturn::fileNames + \variable QWebEnginePage::ChooseMultipleFilesExtensionReturn::fileNames \brief The selected filenames */ /*! - \class QWebPage::ChooseMultipleFilesExtensionReturn + \class QWebEnginePage::ChooseMultipleFilesExtensionReturn \since 4.5 \brief The ChooseMultipleFilesExtensionReturn describes the return value for the multiple files selection extension. - \inmodule QtWebKit + \inmodule QtWebEngine The ChooseMultipleFilesExtensionReturn class holds the filenames selected by the user when the extension is invoked. - \sa QWebPage::extension(), QWebPage::ChooseMultipleFilesExtensionOption + \sa QWebEnginePage::extension(), QWebEnginePage::ChooseMultipleFilesExtensionOption */ /*! - \fn bool QWebPage::extension(Extension extension, const ExtensionOption *option, ExtensionReturn *output) - This virtual function can be reimplemented in a QWebPage subclass to provide support for extensions. The \a option + \fn bool QWebEnginePage::extension(Extension extension, const ExtensionOption *option, ExtensionReturn *output) + This virtual function can be reimplemented in a QWebEnginePage subclass to provide support for extensions. The \a option argument is provided as input to the extension; the output results can be stored in \a output. The behavior of this function is determined by \a extension. The \a option @@ -889,14 +903,14 @@ */ /*! - \fn bool QWebPage::supportsExtension(Extension extension) const + \fn bool QWebEnginePage::supportsExtension(Extension extension) const This virtual function returns true if the web page supports \a extension; otherwise false is returned. \sa extension() */ /*! - \fn bool QWebPage::findText(const QString &subString, FindFlags options) + \fn bool QWebEnginePage::findText(const QString &subString, FindFlags options) Finds the specified string, \a subString, in the page, using the given \a options. If the HighlightAllOccurrences flag is passed, the function will highlight all occurrences @@ -912,14 +926,14 @@ */ /*! - \fn QWebSettings *QWebPage::settings() const + \fn QWebEngineSettings *QWebEnginePage::settings() const Returns a pointer to the page's settings object. - \sa QWebSettings::globalSettings() + \sa QWebEngineSettings::globalSettings() */ /*! - \fn QString QWebPage::chooseFile(QWebFrame *parentFrame, const QString& suggestedFile) + \fn QString QWebEnginePage::chooseFile(QWebEngineFrame *parentFrame, const QString& suggestedFile) This function is called when the web content requests a file name, for example as a result of the user clicking on a "file upload" button in a HTML form. @@ -930,44 +944,44 @@ */ /*! - \fn void QWebPage::setNetworkAccessManager(QNetworkAccessManager *manager) + \fn void QWebEnginePage::setNetworkAccessManager(QNetworkAccessManager *manager) Sets the QNetworkAccessManager \a manager responsible for serving network requests for this - QWebPage. + QWebEnginePage. \note It is currently not supported to change the network access manager after the - QWebPage has used it. The results of doing this are undefined. + QWebEnginePage has used it. The results of doing this are undefined. \sa networkAccessManager() */ /*! - \fn QNetworkAccessManager *QWebPage::networkAccessManager() const + \fn QNetworkAccessManager *QWebEnginePage::networkAccessManager() const Returns the QNetworkAccessManager that is responsible for serving network - requests for this QWebPage. + requests for this QWebEnginePage. \sa setNetworkAccessManager() */ /*! - \fn void QWebPage::setPluginFactory(QWebPluginFactory *factory) - Sets the QWebPluginFactory \a factory responsible for creating plugins embedded into this - QWebPage. + \fn void QWebEnginePage::setPluginFactory(QWebEnginePluginFactory *factory) + Sets the QWebEnginePluginFactory \a factory responsible for creating plugins embedded into this + QWebEnginePage. - Note: The plugin factory is only used if the QWebSettings::PluginsEnabled attribute is enabled. + Note: The plugin factory is only used if the QWebEngineSettings::PluginsEnabled attribute is enabled. \sa pluginFactory() */ /*! - \fn QWebPluginFactory *QWebPage::pluginFactory() const - Returns the QWebPluginFactory that is responsible for creating plugins embedded into - this QWebPage. If no plugin factory is installed a null pointer is returned. + \fn QWebEnginePluginFactory *QWebEnginePage::pluginFactory() const + Returns the QWebEnginePluginFactory that is responsible for creating plugins embedded into + this QWebEnginePage. If no plugin factory is installed a null pointer is returned. \sa setPluginFactory() */ /*! - \fn QString QWebPage::userAgentForUrl(const QUrl&) const + \fn QString QWebEnginePage::userAgentForUrl(const QUrl&) const This function is called when a user agent for HTTP requests is needed. You can reimplement this function to dynamically return different user agents for different URLs, based on the \a url parameter. @@ -986,7 +1000,7 @@ */ /*! - \fn quint64 QWebPage::totalBytes() const + \fn quint64 QWebEnginePage::totalBytes() const Returns the total number of bytes that were received from the network to render the current page, including extra content such as embedded images. @@ -994,39 +1008,24 @@ */ /*! - \fn quint64 QWebPage::bytesReceived() const + \fn quint64 QWebEnginePage::bytesReceived() const Returns the number of bytes that were received from the network to render the current page. \sa totalBytes(), loadProgress() */ -/*! - \fn void QWebPage::setVisibilityState(VisibilityState state) - \property QWebPage::visibilityState - \brief the page's visibility state - - This property should be changed by Qt applications who want to notify the JavaScript application - that the visibility state has changed (e.g. by reimplementing QWidget::setVisible). - The visibility state will be updated with the \a state parameter value only if it's different from the previous set. - Then, HTML DOM Document Object attributes 'hidden' and 'visibilityState' - will be updated to the correct value and a 'visiblitychange' event will be fired. - More information about this HTML5 API can be found at \l{http://www.w3.org/TR/page-visibility/}{W3C Recommendation: Page Visibility}. - - By default, this property is set to VisibilityStateVisible. -*/ - /*! \since 4.8 - \fn void QWebPage::viewportChangeRequested() + \fn void QWebEnginePage::viewportChangeRequested() Page authors can provide the supplied values by using the viewport meta tag. More information about this can be found at \l{http://developer.apple.com/safari/library/documentation/appleapplications/reference/safariwebcontent/usingtheviewport/usingtheviewport.html}{Safari Reference Library: Using the Viewport Meta Tag}. - \sa QWebPage::ViewportAttributes, setPreferredContentsSize(), QGraphicsWebView::setScale() + \sa QWebEnginePage::ViewportAttributes, setPreferredContentsSize() */ /*! - \fn void QWebPage::loadStarted() + \fn void QWebEnginePage::loadStarted() This signal is emitted when a page starts loading content. @@ -1034,7 +1033,7 @@ */ /*! - \fn void QWebPage::loadProgress(int progress) + \fn void QWebEnginePage::loadProgress(int progress) This signal is emitted when the global progress status changes. The current value is provided by \a progress and scales from 0 to 100, @@ -1045,7 +1044,7 @@ */ /*! - \fn void QWebPage::loadFinished(bool ok) + \fn void QWebEnginePage::loadFinished(bool ok) This signal is emitted when the page finishes loading content. This signal is independent of script execution or page rendering. @@ -1055,7 +1054,7 @@ */ /*! - \fn void QWebPage::linkHovered(const QString &link, const QString &title, const QString &textContent) + \fn void QWebEnginePage::linkHovered(const QString &link, const QString &title, const QString &textContent) This signal is emitted when the mouse hovers over a link. @@ -1069,13 +1068,13 @@ */ /*! - \fn void QWebPage::statusBarMessage(const QString& text) + \fn void QWebEnginePage::statusBarMessage(const QString& text) This signal is emitted when the statusbar \a text is changed by the page. */ /*! - \fn void QWebPage::frameCreated(QWebFrame *frame) + \fn void QWebEnginePage::frameCreated(QWebEngineFrame *frame) This signal is emitted whenever the page creates a new \a frame. @@ -1083,7 +1082,7 @@ */ /*! - \fn void QWebPage::selectionChanged() + \fn void QWebEnginePage::selectionChanged() This signal is emitted whenever the selection changes, either interactively or programmatically (e.g. by calling triggerAction() with a selection action). @@ -1092,28 +1091,28 @@ */ /*! - \fn void QWebPage::contentsChanged() + \fn void QWebEnginePage::contentsChanged() \since 4.5 This signal is emitted whenever the text in form elements changes as well as other editable content. - \sa contentEditable, modified, QWebFrame::toHtml(), QWebFrame::toPlainText() + \sa contentEditable, modified, toHtml(), toPlainText() */ /*! - \fn void QWebPage::geometryChangeRequested(const QRect& geom) + \fn void QWebEnginePage::geometryChangeRequested(const QRect& geom) This signal is emitted whenever the document wants to change the position and size of the page to \a geom. This can happen for example through JavaScript. */ /*! - \fn void QWebPage::repaintRequested(const QRect& dirtyRect) + \fn void QWebEnginePage::repaintRequested(const QRect& dirtyRect) - This signal is emitted whenever this QWebPage should be updated. It's useful - when rendering a QWebPage without a QWebView or QGraphicsWebView. - \a dirtyRect contains the area that needs to be updated. To paint the QWebPage get + This signal is emitted whenever this QWebEnginePage should be updated. It's useful + when rendering a QWebEnginePage without a QWebEngineView. + \a dirtyRect contains the area that needs to be updated. To paint the QWebEnginePage get the mainFrame() and call the render(QPainter*, const QRegion&) method with the \a dirtyRect as the second parameter. @@ -1122,7 +1121,7 @@ */ /*! - \fn void QWebPage::scrollRequested(int dx, int dy, const QRect& rectToScroll) + \fn void QWebEnginePage::scrollRequested(int dx, int dy, const QRect& rectToScroll) This signal is emitted whenever the content given by \a rectToScroll needs to be scrolled \a dx and \a dy downwards and no view was set. @@ -1131,23 +1130,23 @@ */ /*! - \fn void QWebPage::windowCloseRequested() + \fn void QWebEnginePage::windowCloseRequested() This signal is emitted whenever the page requests the web browser window to be closed, for example through the JavaScript \c{window.close()} call. */ /*! - \fn void QWebPage::printRequested(QWebFrame *frame) + \fn void QWebEnginePage::printRequested(QWebEngineFrame *frame) This signal is emitted whenever the page requests the web browser to print \a frame, for example through the JavaScript \c{window.print()} call. - \sa QWebFrame::print(), QPrintPreviewDialog + \sa print(), QPrintPreviewDialog */ /*! - \fn void QWebPage::unsupportedContent(QNetworkReply *reply) + \fn void QWebEnginePage::unsupportedContent(QNetworkReply *reply) This signal is emitted when WebKit cannot handle a link the user navigated to or a web server's response includes a "Content-Disposition" header with the 'attachment' @@ -1165,7 +1164,7 @@ */ /*! - \fn void QWebPage::downloadRequested(const QNetworkRequest &request) + \fn void QWebEnginePage::downloadRequested(const QNetworkRequest &request) This signal is emitted when the user decides to download a link. The url of the link as well as additional meta-information is contained in \a request. @@ -1174,7 +1173,7 @@ */ /*! - \fn void QWebPage::microFocusChanged() + \fn void QWebEnginePage::microFocusChanged() This signal is emitted when for example the position of the cursor in an editable form element changes. It is used to inform input methods about the new on-screen position where @@ -1183,12 +1182,12 @@ */ /*! - \fn void QWebPage::linkClicked(const QUrl &url) + \fn void QWebEnginePage::linkClicked(const QUrl &url) This signal is emitted whenever the user clicks on a link and the page's linkDelegationPolicy property is set to delegate the link handling for the specified \a url. - By default no links are delegated and are handled by QWebPage instead. + By default no links are delegated and are handled by QWebEnginePage instead. \note This signal possibly won't be emitted for clicked links which use JavaScript to trigger navigation. @@ -1197,37 +1196,37 @@ */ /*! - \fn void QWebPage::toolBarVisibilityChangeRequested(bool visible) + \fn void QWebEnginePage::toolBarVisibilityChangeRequested(bool visible) This signal is emitted whenever the visibility of the toolbar in a web browser - window that hosts QWebPage should be changed to \a visible. + window that hosts QWebEnginePage should be changed to \a visible. */ /*! - \fn void QWebPage::statusBarVisibilityChangeRequested(bool visible) + \fn void QWebEnginePage::statusBarVisibilityChangeRequested(bool visible) This signal is emitted whenever the visibility of the statusbar in a web browser - window that hosts QWebPage should be changed to \a visible. + window that hosts QWebEnginePage should be changed to \a visible. */ /*! - \fn void QWebPage::menuBarVisibilityChangeRequested(bool visible) + \fn void QWebEnginePage::menuBarVisibilityChangeRequested(bool visible) This signal is emitted whenever the visibility of the menubar in a web browser - window that hosts QWebPage should be changed to \a visible. + window that hosts QWebEnginePage should be changed to \a visible. */ /*! - \fn void QWebPage::databaseQuotaExceeded(QWebFrame* frame, QString databaseName); + \fn void QWebEnginePage::databaseQuotaExceeded(QWebEngineFrame* frame, QString databaseName); \since 4.5 This signal is emitted whenever the web site shown in \a frame is asking to store data to the database \a databaseName and the quota allocated to that web site is exceeded. - \sa QWebDatabase + \sa QWebEngineDatabase */ /*! - \fn void QWebPage::applicationCacheQuotaExceeded(QWebSecurityOrigin* origin, quint64 defaultOriginQuota, quint64 totalSpaceNeeded); + \fn void QWebEnginePage::applicationCacheQuotaExceeded(QWebEngineSecurityOrigin* origin, quint64 defaultOriginQuota, quint64 totalSpaceNeeded); This signal is emitted whenever the web site is asking to store data to the application cache database databaseName and the quota allocated to that web site is exceeded. @@ -1236,79 +1235,29 @@ /*! \since 4.5 - \fn void QWebPage::saveFrameStateRequested(QWebFrame* frame, QWebHistoryItem* item); + \fn void QWebEnginePage::saveFrameStateRequested(QWebEngineFrame* frame, QWebEngineHistoryItem* item); This signal is emitted shortly before the history of navigated pages in \a frame is changed, for example when navigating back in the history. - The provided QWebHistoryItem, \a item, holds the history entry of the frame before + The provided QWebEngineHistoryItem, \a item, holds the history entry of the frame before the change. A potential use-case for this signal is to store custom data in - the QWebHistoryItem associated to the frame, using QWebHistoryItem::setUserData(). + the QWebEngineHistoryItem associated to the frame, using QWebEngineHistoryItem::setUserData(). */ /*! \since 4.5 - \fn void QWebPage::restoreFrameStateRequested(QWebFrame* frame); + \fn void QWebEnginePage::restoreFrameStateRequested(QWebEngineFrame* frame); This signal is emitted when the load of \a frame is finished and the application may now update its state accordingly. */ /*! - \class QWebFrame - \since 4.4 - \brief The QWebFrame class represents a frame in a web page. - - \inmodule QtWebKit - - QWebFrame represents a frame inside a web page. Each QWebPage - object contains at least one frame, the main frame, obtained using - QWebPage::mainFrame(). Additional frames will be created for HTML - \c{} or \c{