summaryrefslogtreecommitdiffstats
path: root/doc/global/includes/module-use.qdocinc
blob: 234d79c3054e579587f768ba75b0493a5cbae898 (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
62
63
64
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

//! [using qt module]

    \section1 Using the Module

    Using a Qt module requires linking against the module library, either
    directly or through other dependencies. Several build tools have dedicated
    support for this, including \l{CMake Documentation}{CMake} and
    \l{qmake}.

    \section2 Building with CMake

    Use the \c{find_package()} command to locate the needed module components in
    the \c{Qt6} package:

//! [using qt module]

//! [using the c++ api]
    Using a Qt module's C++ API requires linking against the module library,
    either directly or through other dependencies. Several build tools have
    dedicated support for this, including \l{CMake Documentation}{CMake} and
    \l{qmake}.
//! [using the c++ api]

//! [using the qml api]
    The QML types of the module are available through the \c \1 import. To use
    the types, add the following import statement to your .qml file:

    \qml
    import \1
    \endqml
//! [using the qml api]

//! [building with qmake]

    \section2 Building with qmake

    To configure the module for building with qmake, add the module as a value
    of the \c QT variable in the project's .pro file:

//! [building with qmake]

//! [building_with_qmake]
    To configure the module for building with qmake, add the module as a value
    of the \c QT variable in the project's .pro file:

    \code
    QT += \1
    \endcode
//! [building_with_qmake]

//! [building with cmake]
    Use the \c {find_package()} command to locate the needed module component
    in the \c {Qt6} package:

    \code
    find_package(Qt6 REQUIRED COMPONENTS \1)
    target_link_libraries(mytarget PRIVATE Qt6::\1)
    \endcode

    For more details, see the \l {Build with CMake} overview.
//! [building with cmake]