aboutsummaryrefslogtreecommitdiffstats
path: root/examples/qml/qmlextensionplugins/doc/src/qmlpluginex.qdoc
blob: 80f39e36cec4fb51239b4933e9b33583eac20826 (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
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \title QML Plugin Example
    \example qmlextensionplugins

    \brief This example creates a C++ plugin extension by subclassing QQmlEngineExtensionPlugin.

    \image qml-plugins-example.png

    To run this example, use the following commands on the prompt:

    \if defined(onlinedocs)
        \tab {build-qt-app}{tab-cmake}{CMake}{checked}
        \tab {build-qt-app}{tab-qmake}{qmake}{}
        \tabcontent {tab-cmake}
    \else
        \section1 Using CMake
    \endif
        \badcode \QtVersion
            cmake -DCMAKE_PREFIX_PATH=path/to/Qt/\1/your_platform -S <source-dir> -B <build-dir> -G Ninja
            cd path/to/build/dir
            ninja
            qml -I imports plugins.qml
        \endcode
        For more information about building on the command line using CMake,
        see \l {Building projects on the command line}.
    \if defined(onlinedocs)
        \endtabcontent
        \tabcontent {tab-qmake}
    \else
        \section1 Using qmake
    \endif
        \badcode
            qmake
            make
            qml -I imports plugins.qml
        \endcode
    \if defined(onlinedocs)
        \endtabcontent
    \endif
*/