summaryrefslogtreecommitdiffstats
path: root/src/webenginequick/doc/src/qtwebengine-qmlmodule.qdoc
blob: ecf3a4a6edc34fddc8123509f62cde43d13d7aec (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
// Copyright (C) 2018 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

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

    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

    The minimal amount of code needed to load and display an HTML page using the QML engine
    requires a proper initialization:

    \snippet minimal/main.cpp Minimal Example

    Where the content of main.qml is simply:

    \snippet minimal/main.qml Minimal Example
*/