summaryrefslogtreecommitdiffstats
path: root/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc
blob: b88d7af36096b507f3e2f2b609469ce7909cc41c (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
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \module QtWebEngineWidgets
    \title Qt WebEngine Widgets C++ Classes
    \brief Provides C++ classes for rendering web content in a QWidget based application.
    \ingroup modules
    \ingroup qtwebengine-modules
    \qtvariable webenginewidgets
    \qtcmakepackage WebEngineWidgets

    The \QWE Widgets module provides a web browser engine as well as C++ classes to render
    and interact with web content.

    To include the definitions of the module's classes, use the
    following directive:

    \snippet qtwebenginewidgets_build_snippet.qdoc 1

    \if !defined(qtforpython)
    To link against the module using build with qmake,
    add the following QT variable to your qmake .pro file:

    \snippet qtwebenginewidgets_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 qtwebenginewidgets_build_snippet.qdoc 2
    \endif
*/