diff options
Diffstat (limited to 'basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc')
16 files changed, 802 insertions, 0 deletions
diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/doc.pro b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/doc.pro new file mode 100644 index 0000000..3966427 --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/doc.pro @@ -0,0 +1,14 @@ +TEMPLATE = aux + +build_online_docs: \ + QMAKE_DOCS = $$PWD/online/qtwebbrowser.qdocconf +else: \ + QMAKE_DOCS = $$PWD/qtwebbrowser.qdocconf + +DISTFILES += \ + $$PWD/src/qtwebbrowser.qdoc \ + $$PWD/src/external-resources.qdoc \ + $$PWD/qtwebbrowser-project.qdocconf \ + $$PWD/qtwebbrowser.qdocconf \ + $$PWD/online/qtwebbrowser.qdocconf \ + $$PWD/images/src/block-diagram.qmodel diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/block-diagram.png b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/block-diagram.png Binary files differnew file mode 100644 index 0000000..50dec11 --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/block-diagram.png diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/bookmarks.png b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/bookmarks.png Binary files differnew file mode 100644 index 0000000..5796891 --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/bookmarks.png diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/html5test.png b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/html5test.png Binary files differnew file mode 100644 index 0000000..4d71ac0 --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/html5test.png diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/inputhelp.png b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/inputhelp.png Binary files differnew file mode 100644 index 0000000..cd310ba --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/inputhelp.png diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/menubar.png b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/menubar.png Binary files differnew file mode 100644 index 0000000..943dc25 --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/menubar.png diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/pageselection.png b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/pageselection.png Binary files differnew file mode 100644 index 0000000..67e216d --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/pageselection.png diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/settings.png b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/settings.png Binary files differnew file mode 100644 index 0000000..069d477 --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/settings.png diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/src/block-diagram.qmodel b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/src/block-diagram.qmodel new file mode 100644 index 0000000..7a78937 --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/src/block-diagram.qmodel @@ -0,0 +1,496 @@ +<?xml version="1.0" encoding="UTF-8"?> +<qmt> + <project> + <uid>{f35988a9-6bcf-4b28-9496-6d2bda6b4b59}</uid> + <root-package> + <instance> + <MPackage> + <base-MObject> + <MObject> + <base-MElement> + <MElement> + <uid>{0076d7ae-ef4b-45eb-8cfb-6ab04beb9d0c}</uid> + </MElement> + </base-MElement> + <name>block-diagram</name> + <children> + <handles> + <handles> + <qlist> + <item> + <handle> + <uid>{a8c8ed99-0062-4b4c-935d-1076b1886ea3}</uid> + <target> + <instance type="MCanvasDiagram"> + <MCanvasDiagram> + <base-MDiagram> + <MDiagram> + <base-MObject> + <MObject> + <base-MElement> + <MElement> + <uid>{a8c8ed99-0062-4b4c-935d-1076b1886ea3}</uid> + </MElement> + </base-MElement> + <name>block-diagram</name> + </MObject> + </base-MObject> + <elements> + <qlist> + <item> + <instance type="DComponent"> + <DComponent> + <base-DObject> + <DObject> + <base-DElement> + <DElement> + <uid>{31670797-833f-490c-a1a7-96027da776ae}</uid> + </DElement> + </base-DElement> + <object>{35301846-40c1-4814-8279-27e504981b6d}</object> + <name>Qt WebBrowser</name> + <pos>x:200;y:210</pos> + <rect>x:-80;y:-30;w:160;h:60</rect> + <auto-sized>false</auto-sized> + <visual-role>0</visual-role> + <visual-emphasized>true</visual-emphasized> + </DObject> + </base-DObject> + </DComponent> + </instance> + </item> + <item> + <instance type="DComponent"> + <DComponent> + <base-DObject> + <DObject> + <base-DElement> + <DElement> + <uid>{4d899821-3971-40fd-ac87-fb15d951bd03}</uid> + </DElement> + </base-DElement> + <object>{0b5ebe96-6859-435b-a13a-e1520b3feeb5}</object> + <name>Qt Quick</name> + <pos>x:475;y:300</pos> + <rect>x:-80;y:-30;w:160;h:60</rect> + <auto-sized>false</auto-sized> + <visual-role>0</visual-role> + </DObject> + </base-DObject> + </DComponent> + </instance> + </item> + <item> + <instance type="DComponent"> + <DComponent> + <base-DObject> + <DObject> + <base-DElement> + <DElement> + <uid>{26ba5615-d61d-4d53-bc8a-a23fb5d92543}</uid> + </DElement> + </base-DElement> + <object>{152e2926-742b-4266-a67d-0badd705cd90}</object> + <name>Qt WebEngine</name> + <pos>x:475;y:210</pos> + <rect>x:-80;y:-30;w:160;h:60</rect> + <auto-sized>false</auto-sized> + <visual-role>0</visual-role> + </DObject> + </base-DObject> + </DComponent> + </instance> + </item> + <item> + <instance type="DComponent"> + <DComponent> + <base-DObject> + <DObject> + <base-DElement> + <DElement> + <uid>{f68aba0c-bb1c-45e9-9f3e-ec530e272d7d}</uid> + </DElement> + </base-DElement> + <object>{a6df659c-bbb2-4109-b0e6-60918263837d}</object> + <name>Qt VirtualKeyboard</name> + <pos>x:200;y:300</pos> + <rect>x:-80;y:-30;w:160;h:60</rect> + <auto-sized>false</auto-sized> + <visual-role>0</visual-role> + </DObject> + </base-DObject> + </DComponent> + </instance> + </item> + <item> + <instance type="DDependency"> + <DDependency> + <base-DRelation> + <DRelation> + <base-DElement> + <DElement> + <uid>{9ecae4ad-a91b-4afb-b852-9513ef0db2bd}</uid> + </DElement> + </base-DElement> + <object>{a2469a49-9150-43c6-95f9-46a9df37d5a2}</object> + <a>{31670797-833f-490c-a1a7-96027da776ae}</a> + <b>{4d899821-3971-40fd-ac87-fb15d951bd03}</b> + </DRelation> + </base-DRelation> + </DDependency> + </instance> + </item> + <item> + <instance type="DDependency"> + <DDependency> + <base-DRelation> + <DRelation> + <base-DElement> + <DElement> + <uid>{efba6948-7090-4bbc-ae78-1ff87ad47bbf}</uid> + </DElement> + </base-DElement> + <object>{74e1c3d1-48e0-4f6e-98c7-5775be6ff115}</object> + <a>{31670797-833f-490c-a1a7-96027da776ae}</a> + <b>{26ba5615-d61d-4d53-bc8a-a23fb5d92543}</b> + </DRelation> + </base-DRelation> + </DDependency> + </instance> + </item> + <item> + <instance type="DDependency"> + <DDependency> + <base-DRelation> + <DRelation> + <base-DElement> + <DElement> + <uid>{12376e90-4be9-4a93-befe-fb2c7523e6c8}</uid> + </DElement> + </base-DElement> + <object>{c0b38869-5ee2-4ceb-a90c-f1f0e8958253}</object> + <a>{31670797-833f-490c-a1a7-96027da776ae}</a> + <b>{f68aba0c-bb1c-45e9-9f3e-ec530e272d7d}</b> + </DRelation> + </base-DRelation> + </DDependency> + </instance> + </item> + <item> + <instance type="DDependency"> + <DDependency> + <base-DRelation> + <DRelation> + <base-DElement> + <DElement> + <uid>{92a27c93-ee2c-45d9-acd5-e64b320e5c02}</uid> + </DElement> + </base-DElement> + <object>{80706f71-fbfb-4a87-b090-6384b2226b55}</object> + <a>{26ba5615-d61d-4d53-bc8a-a23fb5d92543}</a> + <b>{4d899821-3971-40fd-ac87-fb15d951bd03}</b> + </DRelation> + </base-DRelation> + </DDependency> + </instance> + </item> + <item> + <instance type="DDependency"> + <DDependency> + <base-DRelation> + <DRelation> + <base-DElement> + <DElement> + <uid>{d177f4d0-a1af-48ac-96af-1ca71308d9f1}</uid> + </DElement> + </base-DElement> + <object>{e736c99c-a627-4731-a8dc-0a14f8b48354}</object> + <a>{f68aba0c-bb1c-45e9-9f3e-ec530e272d7d}</a> + <b>{4d899821-3971-40fd-ac87-fb15d951bd03}</b> + </DRelation> + </base-DRelation> + </DDependency> + </instance> + </item> + </qlist> + </elements> + <last-modified>1464094346159</last-modified> + <toolbarid>Components</toolbarid> + </MDiagram> + </base-MDiagram> + </MCanvasDiagram> + </instance> + </target> + </handle> + </item> + <item> + <handle> + <uid>{19c62089-bf53-411a-b533-1418ec5c160d}</uid> + <target> + <instance type="MPackage"> + <MPackage> + <base-MObject> + <MObject> + <base-MElement> + <MElement> + <uid>{19c62089-bf53-411a-b533-1418ec5c160d}</uid> + </MElement> + </base-MElement> + <name>New Package</name> + </MObject> + </base-MObject> + </MPackage> + </instance> + </target> + </handle> + </item> + <item> + <handle> + <uid>{37e5fedf-65dc-4f96-ad9e-294c5abc5aa0}</uid> + <target> + <instance type="MPackage"> + <MPackage> + <base-MObject> + <MObject> + <base-MElement> + <MElement> + <uid>{37e5fedf-65dc-4f96-ad9e-294c5abc5aa0}</uid> + </MElement> + </base-MElement> + <name>ew Package</name> + </MObject> + </base-MObject> + </MPackage> + </instance> + </target> + </handle> + </item> + <item> + <handle> + <uid>{35301846-40c1-4814-8279-27e504981b6d}</uid> + <target> + <instance type="MComponent"> + <MComponent> + <base-MObject> + <MObject> + <base-MElement> + <MElement> + <uid>{35301846-40c1-4814-8279-27e504981b6d}</uid> + </MElement> + </base-MElement> + <name>Qt WebBrowser</name> + <relations> + <handles> + <handles> + <qlist> + <item> + <handle> + <uid>{a2469a49-9150-43c6-95f9-46a9df37d5a2}</uid> + <target> + <instance type="MDependency"> + <MDependency> + <base-MRelation> + <MRelation> + <base-MElement> + <MElement> + <uid>{a2469a49-9150-43c6-95f9-46a9df37d5a2}</uid> + </MElement> + </base-MElement> + <a>{35301846-40c1-4814-8279-27e504981b6d}</a> + <b>{0b5ebe96-6859-435b-a13a-e1520b3feeb5}</b> + </MRelation> + </base-MRelation> + </MDependency> + </instance> + </target> + </handle> + </item> + <item> + <handle> + <uid>{74e1c3d1-48e0-4f6e-98c7-5775be6ff115}</uid> + <target> + <instance type="MDependency"> + <MDependency> + <base-MRelation> + <MRelation> + <base-MElement> + <MElement> + <uid>{74e1c3d1-48e0-4f6e-98c7-5775be6ff115}</uid> + </MElement> + </base-MElement> + <a>{35301846-40c1-4814-8279-27e504981b6d}</a> + <b>{152e2926-742b-4266-a67d-0badd705cd90}</b> + </MRelation> + </base-MRelation> + </MDependency> + </instance> + </target> + </handle> + </item> + <item> + <handle> + <uid>{c0b38869-5ee2-4ceb-a90c-f1f0e8958253}</uid> + <target> + <instance type="MDependency"> + <MDependency> + <base-MRelation> + <MRelation> + <base-MElement> + <MElement> + <uid>{c0b38869-5ee2-4ceb-a90c-f1f0e8958253}</uid> + </MElement> + </base-MElement> + <a>{35301846-40c1-4814-8279-27e504981b6d}</a> + <b>{a6df659c-bbb2-4109-b0e6-60918263837d}</b> + </MRelation> + </base-MRelation> + </MDependency> + </instance> + </target> + </handle> + </item> + </qlist> + </handles> + </handles> + </relations> + </MObject> + </base-MObject> + </MComponent> + </instance> + </target> + </handle> + </item> + <item> + <handle> + <uid>{0b5ebe96-6859-435b-a13a-e1520b3feeb5}</uid> + <target> + <instance type="MComponent"> + <MComponent> + <base-MObject> + <MObject> + <base-MElement> + <MElement> + <uid>{0b5ebe96-6859-435b-a13a-e1520b3feeb5}</uid> + </MElement> + </base-MElement> + <name>Qt Quick</name> + </MObject> + </base-MObject> + </MComponent> + </instance> + </target> + </handle> + </item> + <item> + <handle> + <uid>{152e2926-742b-4266-a67d-0badd705cd90}</uid> + <target> + <instance type="MComponent"> + <MComponent> + <base-MObject> + <MObject> + <base-MElement> + <MElement> + <uid>{152e2926-742b-4266-a67d-0badd705cd90}</uid> + </MElement> + </base-MElement> + <name>Qt WebEngine</name> + <relations> + <handles> + <handles> + <qlist> + <item> + <handle> + <uid>{80706f71-fbfb-4a87-b090-6384b2226b55}</uid> + <target> + <instance type="MDependency"> + <MDependency> + <base-MRelation> + <MRelation> + <base-MElement> + <MElement> + <uid>{80706f71-fbfb-4a87-b090-6384b2226b55}</uid> + </MElement> + </base-MElement> + <a>{152e2926-742b-4266-a67d-0badd705cd90}</a> + <b>{0b5ebe96-6859-435b-a13a-e1520b3feeb5}</b> + </MRelation> + </base-MRelation> + </MDependency> + </instance> + </target> + </handle> + </item> + </qlist> + </handles> + </handles> + </relations> + </MObject> + </base-MObject> + </MComponent> + </instance> + </target> + </handle> + </item> + <item> + <handle> + <uid>{a6df659c-bbb2-4109-b0e6-60918263837d}</uid> + <target> + <instance type="MComponent"> + <MComponent> + <base-MObject> + <MObject> + <base-MElement> + <MElement> + <uid>{a6df659c-bbb2-4109-b0e6-60918263837d}</uid> + </MElement> + </base-MElement> + <name>Qt VirtualKeyboard</name> + <relations> + <handles> + <handles> + <qlist> + <item> + <handle> + <uid>{e736c99c-a627-4731-a8dc-0a14f8b48354}</uid> + <target> + <instance type="MDependency"> + <MDependency> + <base-MRelation> + <MRelation> + <base-MElement> + <MElement> + <uid>{e736c99c-a627-4731-a8dc-0a14f8b48354}</uid> + </MElement> + </base-MElement> + <a>{a6df659c-bbb2-4109-b0e6-60918263837d}</a> + <b>{0b5ebe96-6859-435b-a13a-e1520b3feeb5}</b> + </MRelation> + </base-MRelation> + </MDependency> + </instance> + </target> + </handle> + </item> + </qlist> + </handles> + </handles> + </relations> + </MObject> + </base-MObject> + </MComponent> + </instance> + </target> + </handle> + </item> + </qlist> + </handles> + </handles> + </children> + </MObject> + </base-MObject> + </MPackage> + </instance> + </root-package> + </project> +</qmt> diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/virtualkeyboard.png b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/virtualkeyboard.png Binary files differnew file mode 100644 index 0000000..ad40d3f --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/virtualkeyboard.png diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/webbrowser.png b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/webbrowser.png Binary files differnew file mode 100644 index 0000000..b111dcd --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/images/webbrowser.png diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/online/qtwebbrowser.qdocconf b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/online/qtwebbrowser.qdocconf new file mode 100644 index 0000000..9aff055 --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/online/qtwebbrowser.qdocconf @@ -0,0 +1,16 @@ +include(../qtwebbrowser-project.qdocconf) + +HTML.footer = \ + " </div>\n" \ + " <p class=\"copy-notice\">\n" \ + " <acronym title=\"Copyright\">©</acronym> 2017 The Qt Company Ltd.\n" \ + " Documentation contributions included herein are the copyrights of\n" \ + " their respective owners. " \ + " The documentation provided herein is licensed under the terms of the" \ + " <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU Free Documentation" \ + " License version 1.3</a> as published by the Free Software Foundation. " \ + " Qt and respective logos are trademarks of The Qt Company Ltd " \ + " in Finland and/or other countries worldwide. All other trademarks are property\n" \ + " of their respective owners. </p>\n" + +include($QT_INSTALL_DOCS/global/qt-html-templates-online.qdocconf) diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/qtwebbrowser-project.qdocconf b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/qtwebbrowser-project.qdocconf new file mode 100644 index 0000000..3fe897c --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/qtwebbrowser-project.qdocconf @@ -0,0 +1,36 @@ +project = "QtWebBrowser" +description = "Qt WebBrowser Manual" + +sourcedirs += src +imagedirs += images + +sources.fileextensions = "*.qdoc" + +qhp.projects = QtWebBrowser +qhp.QtWebBrowser.file = qtwebbrowser.qhp +qhp.QtWebBrowser.namespace = org.qt-project.qtwebbrowser.$$QT_VERSION_TAG +qhp.QtWebBrowser.virtualFolder = qtwebbrowser +qhp.QtWebBrowser.indexTitle = Qt WebBrowser +qhp.QtWebBrowser.filterAttributes = qtwebbrowser +qhp.QtWebBrowser.customFilters.QtWebBrowser.name = Qt WebBrowser $QT_VERSION +qhp.QtWebBrowser.customFilters.QtWebBrowser.filterAttributes = qtwebbrowser $QT_VERSION +qhp.QtWebBrowser.indexRoot = + +qhp.QtWebBrowser.subprojects = manual +qhp.QtWebBrowser.subprojects.manual.indexTitle = Qt WebBrowser +qhp.QtWebBrowser.subprojects.manual.title = Qt WebBrowser +qhp.QtWebBrowser.subprojects.manual.type = manual + +#indexes += $QT_INSTALL_DOCS/qtlocation/qtlocation.index \ +# $QT_INSTALL_DOCS/qtquick/qtquick.index \ +# $QT_INSTALL_DOCS/qtvirtualkeyboard/qtvirtualkeyboard.index \ +# $QT_INSTALL_DOCS/qtwebengine/qtwebengine.index + +depends += qtquick qtlocation qtwebengine qtvirtualkeyboard + +# Doxygen compatibility commands +macro.see = "\\sa" +macro.function = "\\fn" + +navigation.homepage = "Qt WebBrowser Manual" +buildversion = "Qt WebBrowser $QT_VERSION" diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/qtwebbrowser.qdocconf b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/qtwebbrowser.qdocconf new file mode 100644 index 0000000..383d83a --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/qtwebbrowser.qdocconf @@ -0,0 +1,2 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults-offline.qdocconf) +include(qtwebbrowser-project.qdocconf) diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/src/external-resources.qdoc b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/src/external-resources.qdoc new file mode 100644 index 0000000..8a5cc00 --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/src/external-resources.qdoc @@ -0,0 +1,53 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt WebBrowser application. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \externalpage https://www.chromium.org/ + \title Chromium Project +*/ + +/*! + \externalpage https://www.google.com/ + \title Google +*/ + +/*! + \externalpage https://doc.qt.io/qt-5/qtwebengine-debugging.html + \title Qt WebEngine Debugging and Profiling +*/ + +/* + This prevents autolinking of each occurrence of 'WebEngine' + To link to the WebEngine QML type, use explicit linking: + \l [QML] WebEngine + \sa {QtWebEngine::}{WebEngine} +*/ +/*! +\externalpage nolink +\title WebEngine +\internal +*/ diff --git a/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/src/qtwebbrowser.qdoc b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/src/qtwebbrowser.qdoc new file mode 100644 index 0000000..08496a0 --- /dev/null +++ b/basicsuite/qtwebbrowser/tqtc-qtwebbrowser/doc/src/qtwebbrowser.qdoc @@ -0,0 +1,185 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt WebBrowser application. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\page qtwebbrowser-index.html + +\title Qt WebBrowser + +The Qt WebBrowser (codename \c{Roadtrip}) is a browser for embedded +devices developed using the capabilities of Qt and \l{Qt WebEngine}. +Using recent \l{Chromium Project}{Chromium}, it features up-to-date +HTML technologies behind a minimal but slick touch-friendly +user interface written in \l{Qt Quick}. + +\image webbrowser.png + +\section1 User Interface + +The user interface of the browser is designed for embedded devices +using a touch screen. It uses flat icons and minimalistic transitions to +provide a contemporary look and feel. + +All central actions are conveniently accessible in the menu bar at the +top. When the user scrolls down a page, the menu bar disappears to +leave more screen space for content. It appears again if +the user scrolls upwards. + +\image menubar.png + +The \uicontrol Back button (1) and \uicontrol Forward button (2) navigate +through the history of pages already visited. +The input bar (3) allows the user to type and edit URL's, +or search for text. It also allows to reload a page, or stop a page currently +loading. +Pages can be bookmarked with the \uicontrol Bookmark button (6), +the bookmarked pages are accessible through the \uicontrol Home button (4). +The \uicontrol Pages button (5) allows the user to manage the pages +currently opened. The \uicontrol Settings button (7) brings up a view of +the current settings. + +\section2 Opening Pages + +The input bar supports typing in either a full URL or a query +that is automatically passed to \l{Google}. Url suggestions of visited pages +matching the text are suggested during typing. The current text can be +cleared by pressing the \uicontrol Cancel button on the right. + +\image inputhelp.png + +When the user finishes editing, a blue line serves as a progress indicator +for the page currently loading. The loading can be stopped by pressing +the \uicontrol Cancel button. After the page finished loading +this button is replaced by a \uicontrol Reload button, that forces a reload +of the page when pressed. + +\section2 Page Scrolling + +The view of the page can be moved around by pressing and moving a finger. + +\section2 Page Zooming + +Zoom in or out a particular section of the page by pinching fingers. + +\section2 Bookmark Management + +Individual pages can be bookmarked by pressing the \uicontrol Bookmark +button. By pressing the same button again the page is removed from the +bookmarks. + +The \uicontrol Home button lets the user browse the bookmarked pages +in a multi-page grid. Each page is represented by its name and icon, +if available. + +\image bookmarks.png + +\section2 Page Management + +The \uicontrol Pages button enables the user to open new pages and to +switch between them using the Carousel UI pattern: + +\image pageselection.png + +The number of pages that can be opened simultaneously is intentionally +limited to 10. + +\section2 User Settings + +A settings page is available by pressing the \uicontrol Settings button. +The page contains options for enabling a \e {private browsing} mode +that does not leave traces in the history and cookies. + +\image settings.png + +\section2 Virtual Keyboard + +The integrated \l{Qt Virtual Keyboard} +slides in whenever text input is required. It enables typing text in a +great variety of different languages. + +\image virtualkeyboard.png + +\section1 Features + +Qt WebEngine leverages \l{Chromium Project}{Chromium} to provide +a state-of-the art, high performance HTML5 web engine. + +\image html5test.png + +\section2 Video and Audio + +Chromium and therefore Qt WebEngine directly +integrate with OS services to access video and audio devices. +After the user acknowledges access to them, solutions using WebRTC, such as +video and audio conferencing, work out-of-the-box, provided that the +required codecs are available. + +\section2 Location Information + +Qt WebEngine uses \l {Qt Location} to provide pages with location +information. Again, the users have to explicitly give their consent to each +page attempting to access this information. + +\section2 Fullscreen Mode + +Videos can be played in fullscreen mode. + +\section1 Developer Features + +\section2 Developer Tools + +Qt WebEngine supports remotely accessing the built-in Chromium Developer +Tools. This allows debugging and optimizing individual pages on the device. + +For more information, see the \l{Qt WebEngine} documentation on +\l{Qt WebEngine Debugging and Profiling}{Debugging and Profiling}. + +\section2 Simulation of Touch Input + +While the Qt WebBrowser is optimized for touch devices, +it can also be tested on all the desktop operating systems. +Keyboard and mouse input works out of the box. Touch input +can be simulated by using several mouse buttons +while pressing the \c Ctrl key. + +\section1 Platform Requirements + +Qt WebBrowser requires the \l{Qt WebEngine}, +\l{Qt Quick} and +\l{Qt Virtual Keyboard} modules in version 5.7 or +newer. + +\image block-diagram.png + +At minimum 1 GB of RAM is advised to provide a seamless experience +for different pages. Depending on the exact configuration and the +pages visited this can be further optimized. + +Qt Quick and Qt WebEngine use OpenGL for rendering. Best performance +therefore requires dedicated graphics hardware with drivers supporting +OpenGL. +*/ |
