summaryrefslogtreecommitdiffstats
path: root/examples/webenginequick/minimal/doc
diff options
context:
space:
mode:
authorBalazs Egedi <egedib@inf.u-szeged.hu>2021-08-17 12:59:28 +0200
committerBalazs Egedi <egedib@inf.u-szeged.hu>2021-09-13 10:25:48 +0200
commita32ef7057c01fbcadcf451e7f2b785f7b3dd3942 (patch)
tree15258c16f6369ad9f3318101102d7da1b3002927 /examples/webenginequick/minimal/doc
parent498c4ac362cb6cbee8a30c8cc46fa4253bf93ee0 (diff)
Rename Quick examples' folder from webengine to webenginequick
Fix webengine directory path in project files and comments Pick-to: 6.2 6.2.0 Change-Id: I06ed9ee41111e7135fa9feb152ad2a5eb2262b76 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Diffstat (limited to 'examples/webenginequick/minimal/doc')
-rw-r--r--examples/webenginequick/minimal/doc/src/minimal.qdoc87
1 files changed, 87 insertions, 0 deletions
diff --git a/examples/webenginequick/minimal/doc/src/minimal.qdoc b/examples/webenginequick/minimal/doc/src/minimal.qdoc
new file mode 100644
index 000000000..c4b3afef9
--- /dev/null
+++ b/examples/webenginequick/minimal/doc/src/minimal.qdoc
@@ -0,0 +1,87 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://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 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$
+**
+****************************************************************************/
+
+/*!
+ \example webenginequick/minimal
+ \title WebEngine Qt Quick Minimal Example
+ \ingroup webengine-examples
+ \brief Displays a web page using the Qt Quick integration of \QWE.
+
+ \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{QtWebEngineQuick::initialize}.
+
+ \quotefromfile webenginequick/minimal/main.cpp
+ \skipto #include
+ \printto main
+
+ In the \c main function we first set the
+ \l{QCoreApplication::organizationName} property. This affects the locations
+ where \QWE stores persistent and cached data (see also
+ \l{WebEngineProfile::cachePath} and
+ \l{WebEngineProfile::persistentStoragePath}).
+
+ Next, we call \l{QtWebEngineQuick::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 the \l{Qt Homepage}.
+
+ \quotefromfile webenginequick/minimal/main.qml
+ \skipto import
+ \printuntil }
+ \printline }
+
+ \section1 Requirements
+
+ The example requires a working internet connection to render the
+ \l{Qt Homepage}.
+ An optional system proxy should be picked up automatically.
+*/