summaryrefslogtreecommitdiffstats
path: root/examples/webview/minibrowser/doc/src/minibrowser.qdoc
blob: 35328612940170f545e0beaad31597828714c789 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/****************************************************************************
**
** Copyright (C) 2017 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$
**
****************************************************************************/

/*!
    \title Qt WebView Examples - Minibrowser
    \example minibrowser
    \brief Minibrowser example demonstrates how to use the Qt WebView module with Qt Quick.
    \image webview-example.jpg
    \ingroup qtwebview-examples

    Minibrowser uses Qt Quick Controls and Qt WebView to provide basic
    browsing experience. Besides the addressbar for the URL, it has a
    couple of controls to navigate through the browsing history.

    \note When using the Qt WebView module it is necessary to call QtWebView::initialize()
    right after creating the QGuiApplication instance. Calling QtWebView::initialize() will
    ensure that the necessary pre-setup steps are run.

    \snippet minibrowser/main.cpp 0

    \include examples-run.qdocinc
*/