diff options
Diffstat (limited to 'src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc')
| -rw-r--r-- | src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc | 97 |
1 files changed, 40 insertions, 57 deletions
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. +*/ |