summaryrefslogtreecommitdiffstats
path: root/examples/webenginewidgets/minimal/doc/src/minimal.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/webenginewidgets/minimal/doc/src/minimal.qdoc')
-rw-r--r--examples/webenginewidgets/minimal/doc/src/minimal.qdoc66
1 files changed, 66 insertions, 0 deletions
diff --git a/examples/webenginewidgets/minimal/doc/src/minimal.qdoc b/examples/webenginewidgets/minimal/doc/src/minimal.qdoc
new file mode 100644
index 000000000..22f28e604
--- /dev/null
+++ b/examples/webenginewidgets/minimal/doc/src/minimal.qdoc
@@ -0,0 +1,66 @@
+/****************************************************************************
+**
+** 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 webenginewidgets/minimal
+ \title WebEngine Widgets Minimal Example
+ \ingroup webengine-widgetexamples
+ \brief Displays a web page using Qt WebEngine Widgets
+
+ \image minimal-example.png
+
+ \e {WebEngine Widgets Minimal Example} demonstrates how to use
+ \l{QWebEngineView} 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 The Code
+
+ In \c main.cpp we instantiate a QApplication and a QWebEngineView. The URL
+ to load is set by calling \l QWebEngineView::setUrl. The view widget is
+ given a reasonable default size, and shown.
+ Finally, QApplication::exec() launches the main event loop.
+
+ \quotefromfile webenginewidgets/minimal/main.cpp
+ \skipto #include
+
+ \printuntil }
+
+ \section1 Requirements
+
+ The example requires a working internet connection to render
+ the \l{Qt Homepage}.
+ An optional system proxy should be picked up automatically.
+ However, for proxies that require a username or password,
+ you need to connect to
+ QWebEnginePage::proxyAuthenticationRequired.
+
+ \l{Qt WebEngine Widgets} uses the \l{Qt Quick Scene Graph} to compose the
+ page. Therefore, OpenGL support is required.
+*/