From 754beccc8843ccd2201d63f987891f1f85135918 Mon Sep 17 00:00:00 2001 From: Jerome Pasion <jerome.pasion@digia.com> Date: Sun, 5 Oct 2014 18:25:29 +0200 Subject: [PATCH] Doc: Added information about WebEngine and WebChannel in "web" topic. -increases visibility to new modules. -also bumped the topic page to the front page. Task-number: QTBUG-40901 Change-Id: I6e9bacbc31c19b885209f51b3485346e88fbbd8d Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> --- doc/src/index.qdoc | 1 + doc/src/topics.qdoc | 2 +- doc/src/web-content.qdoc | 46 ++++++++++++++++++++++++++++++++++------ 3 files changed, 41 insertions(+), 8 deletions(-) diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc index 6af10546..eeb41a3c 100644 --- a/doc/src/index.qdoc +++ b/doc/src/index.qdoc @@ -91,6 +91,7 @@ \li \l[QtMultimedia]{Multimedia} \li \l{Networking and Connectivity} \li \l{Graphics} + \li \l{Integrating Web Content}{Web Content} \li \l{Mobile APIs} \li \l{QML Applications} \endlist diff --git a/doc/src/topics.qdoc b/doc/src/topics.qdoc index 74e58ef1..0caeff35 100644 --- a/doc/src/topics.qdoc +++ b/doc/src/topics.qdoc @@ -41,6 +41,7 @@ functionality and can be used as a starting point for learning how to to get the \li \l[QtMultimedia]{Multimedia} \li \l{Networking and Connectivity} \li \l{Graphics} +\li \l{Integrating Web Content} \li \l{Mobile APIs} \li \l{QML Applications} \endlist @@ -48,7 +49,6 @@ functionality and can be used as a starting point for learning how to to get the \list \li \l {Scripting} \li \l {Internationalization with Qt} -\li \l {Integrating Web Content} \li \l {Testing and Debugging} \li \l {Porting Guide}{Porting from Qt 4} \endlist diff --git a/doc/src/web-content.qdoc b/doc/src/web-content.qdoc index 773dd9de..6b8cacc7 100644 --- a/doc/src/web-content.qdoc +++ b/doc/src/web-content.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. @@ -30,13 +30,17 @@ \title Integrating Web Content \brief Qt's WebKit integration -Qt provides a \l {http://www.webkit.org/}{WebKit}-based layout engine -with support for a wide range of standard web techologies such as HTML, CSS and -JavaScript, that make it possible to embed content from the World Wide Web into -your Qt application. Qt features both WebKit-based QML and C++ APIs. +To create Qt-based web applications, Qt provides both +\l {http://www.webkit.org/}{WebKit}-based and Chromium-based +(\l{Qt WebEngine}{WebEngine}) layout engines with support for a wide range of +standard web techologies such as HTML, CSS, and JavaScript, that make it possible +to embed content from the World Wide Web into your Qt application. +It is also possible to combine Qt C++ and QML code with HTML and JavaScript to +create web applications. Through Qt WebChannel, several of Qt's APIs are +accessible to remote clients. -\section1 WebKit for QML Applications +\section1 WebKit in Qt \l{Qt WebKit} allows WebKit 2 functionality in QML applications by importing the \l{WebView} QML type. \l WebView has a minimalistic QML API for @@ -55,7 +59,7 @@ These pages have more information about QML: \li \l{QML Applications} \endlist -\section1 Qt WebKit Widgets Module +\section2 WebKit Widgets The \l{Qt WebKit Widgets} module provides a feature-rich C++ API that facilitates loading, viewing, and editing web documents. Qt WebKit Widgets @@ -64,4 +68,32 @@ Extensible HyperText Markup Language (XHTML) and Scalable Vector Graphics (SVG) documents, styled using Cascading Style Sheets (CSS) and scripted with JavaScript. +\section1 WebEngine in Qt + +As with Qt WebKit, \l{Qt WebEngine} allows web content to be displayed in +Qt applications. This module is new in Qt 5.4 and in future releases will serve +as a replacement to Qt WebKit. + +These pages contain information about porting applications to use Qt WebEngine +and the various APIs: +\list +\li \l{Qt WebEngine} - provides a QML API +\li \l{Qt WebEngine Widgets} - provides a C++ API +\li \l{Porting from Qt WebKit to Qt WebEngine} +\endlist + +\section1 Qt and HTML-JavaScript Hybrid Applications + +The \l{Qt WebChannel} module enables HTML or JavaScript clients to access +Qt APIs such as QObject. It provides both C++ or QML API, allowing Qt apps +to communicate with JavaScript and HTML frontends. + +These pages contain more information about the various APIs: +\list +\li \l{Qt WebChannel JavaScript API}{JavaScript API} +\li \l{Qt WebChannel C++ Classes}{C++ API} +\li \l{Qt WebChannel QML Types}{QML API} +\li \l{Qt WebChannel Standalone Example}{Standalone Example} +\endlist + */ -- GitLab