From 193a2aaabfb45bedee5e9d6e9771d539af56c7d0 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Mon, 22 Feb 2016 16:15:41 +0100 Subject: Add minimal examples Task-number: QTBUG-51383 Change-Id: I872bdae7267e7dbf2a93a831d435517bcd4bad64 Reviewed-by: Leena Miettinen Reviewed-by: Michal Klocek Reviewed-by: Joerg Bornemann --- examples/webengine/minimal/doc/src/minimal.qdoc | 82 +++++++++++++++++++++++++ examples/webengine/minimal/main.cpp | 55 +++++++++++++++++ examples/webengine/minimal/main.qml | 53 ++++++++++++++++ examples/webengine/minimal/minimal.pro | 10 +++ examples/webengine/minimal/qml.qrc | 6 ++ 5 files changed, 206 insertions(+) create mode 100644 examples/webengine/minimal/doc/src/minimal.qdoc create mode 100644 examples/webengine/minimal/main.cpp create mode 100644 examples/webengine/minimal/main.qml create mode 100644 examples/webengine/minimal/minimal.pro create mode 100644 examples/webengine/minimal/qml.qrc (limited to 'examples/webengine') diff --git a/examples/webengine/minimal/doc/src/minimal.qdoc b/examples/webengine/minimal/doc/src/minimal.qdoc new file mode 100644 index 000000000..8dcaa3bb4 --- /dev/null +++ b/examples/webengine/minimal/doc/src/minimal.qdoc @@ -0,0 +1,82 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $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 http://www.qt.io/terms-conditions. For further +** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example webengine/minimal + \title WebEngine Qt Quick Minimal Example + \ingroup webengine-examples + \brief Displays a web page using the Qt Quick integration of Qt WebEngine + + \image minimal-example.png + + \e {WebEngine Qt Quick Minimal Example} demonstrates how to use the + \l{WebEngineView} item to render a web page. It shows the minimum amount of + code needed to load and display an HTML page, and can be used as a basis for + further experimentation. + + \include examples-run.qdocinc + + \section1 C++ Code + + In \c main.cpp we use only the QGuiApplication and QQmlApplicationEngine + classes. We also include \c qtwebengineglobal.h to be able to use + \l{QtWebEngine::initialize}. + + \quotefromfile webengine/minimal/main.cpp + \skipto #include + \printto main + + In the main function we first instantiate a QGuiApplication object. + We then call \l{QtWebEngine::initialize}, which makes sure that OpenGL + contexts can be shared between the main process and the dedicated renderer + process (\c QtWebEngineProcess). This method needs to be called before + any OpenGL context is created. + + Then we create a QQmlApplicationEngine, and tell it to load \c main.qml + from the \l{The Qt Resource System}{Qt Resource System}. + + Finally, QGuiApplication::exec() launches the main event loop. + + \printuntil } + + \section1 QML Code + + In \c main.qml we create the top level window, set a sensible default size + and make it visible. The window will be filled by a WebEngineView item + loading \l{http://www.qt.io}{the Qt homepage}. + + \quotefromfile webengine/minimal/main.qml + \skipto import + \printuntil } + \printline } + + \section1 Requirements + + The example requires a working internet connection to render + \l{http://www.qt.io}{the Qt homepage}. + An optional system proxy should be picked up automatically. +*/ diff --git a/examples/webengine/minimal/main.cpp b/examples/webengine/minimal/main.cpp new file mode 100644 index 000000000..cc5a1f61e --- /dev/null +++ b/examples/webengine/minimal/main.cpp @@ -0,0 +1,55 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the examples of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include +#include +#include + +int main(int argc, char *argv[]) +{ + QGuiApplication app(argc, argv); + QtWebEngine::initialize(); + + QQmlApplicationEngine engine; + engine.load(QUrl(QStringLiteral("qrc:/main.qml"))); + + return app.exec(); +} + diff --git a/examples/webengine/minimal/main.qml b/examples/webengine/minimal/main.qml new file mode 100644 index 000000000..f2d9f40b1 --- /dev/null +++ b/examples/webengine/minimal/main.qml @@ -0,0 +1,53 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the examples of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +import QtQuick 2.0 +import QtQuick.Window 2.0 +import QtWebEngine 1.0 + +Window { + width: 1024 + height: 750 + visible: true + WebEngineView { + anchors.fill: parent + url: "http://www.qt.io" + } +} diff --git a/examples/webengine/minimal/minimal.pro b/examples/webengine/minimal/minimal.pro new file mode 100644 index 000000000..23ce01d5b --- /dev/null +++ b/examples/webengine/minimal/minimal.pro @@ -0,0 +1,10 @@ +TEMPLATE = app + +QT += webengine + +SOURCES += main.cpp + +RESOURCES += qml.qrc + +target.path = $$[QT_INSTALL_EXAMPLES]/webengine/minimal +INSTALLS += target diff --git a/examples/webengine/minimal/qml.qrc b/examples/webengine/minimal/qml.qrc new file mode 100644 index 000000000..0ff3892d9 --- /dev/null +++ b/examples/webengine/minimal/qml.qrc @@ -0,0 +1,6 @@ + + + main.qml + + + -- cgit v1.2.3