summaryrefslogtreecommitdiffstats
path: root/src/webenginequick/doc/src/qtwebengine-qmlmodule.qdoc
blob: ac1fff80bb8b1ffc8d3d900f0a2a933b0a136e5c (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
47
48
49
/****************************************************************************
**
** Copyright (C) 2018 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$
**
****************************************************************************/

/*!
    \qmlmodule QtWebEngine
    \title Qt WebEngine QML Types
    \brief Provides QML types for rendering web content within a QML application.
    \ingroup qtwebengine-modules
    \ingroup qmlmodules

    The QML types can be imported into your application using the following import statements in
    your .qml file:

    \snippet qtwebengine_build_snippet.qdoc 1

    To link against the module using build with qmake,
    add the following QT variable to your qmake .pro file:

    \snippet qtwebengine_build_snippet.qdoc 0

    For build with CMake use the \c find_package() command to locate the needed module components
    in the Qt6 package and \c target_link_libraries() to link against the module:

    \snippet qtwebengine_build_snippet.qdoc 2
*/