summaryrefslogtreecommitdiffstats
path: root/src/core/doc/src/qtwebenginecore-module.qdoc
blob: 033d8111653515ee465ad5d3fb701a8f2b94f55f (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
50
51
52
53
54
55
56
57
58
59
60
61
/****************************************************************************
**
** Copyright (C) 2016 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$
**
****************************************************************************/


/*!
    \module QtWebEngineCore
    \title Qt WebEngine Core C++ Classes
    \brief Provides public API shared by both QtWebEngine and QtWebEngineWidgets.
    \since 5.6
    \ingroup qtwebengine-modules
    \ingroup modules
    \qtvariable webenginecore
    \qtcmakepackage WebEngineCore

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

    \snippet qtwebenginecore_build_snippet.qdoc 1

    If you use qmake to build your projects, \QWE Core is usually
    indirectly included through the \l{Qt WebEngine QML Types}{Qt WebEngine} or
    \l{Qt WebEngine Widgets C++ Classes}{Qt WebEngine Widgets} modules.

    \if !defined(qtforpython)
    To link against the module using build with qmake,
    add this line to your qmake project file:

    \snippet qtwebenginecore_build_snippet.qdoc 0

    However, \c webenginecore is implied by adding \c webenginequick or \c webenginewidgets.

    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 qtwebenginecore_build_snippet.qdoc 2
    \endif
*/