summaryrefslogtreecommitdiffstats
path: root/src/sensors/doc/src/qtsensors.qdoc
blob: 62959fbdea539bf2bb718f81cd8bcf76a44e00c0 (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
65
66
67
68
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \page qtsensors-index.html
    \title Qt Sensors
    \brief Provides access to sensors via QML and C++ interfaces.
    \since 5.1

    The Qt Sensors module provides access to sensor hardware via QML and C++
    interfaces.

    Currently, the API is supported on \l{Qt for Android}{Android},
    \l{Qt for iOS}{iOS}, and \l {Qt for Windows}{Windows (MSVC)}.

    \section1 Using the Module

    \section2 QML API

    \include {module-use.qdocinc} {using the qml api} {QtSensors}

    \section2 C++ API

    \include {module-use.qdocinc} {using the c++ api}

    \section3 Building with CMake

    \include {module-use.qdocinc} {building with cmake} {Sensors}

    \section3 Building with qmake

    \include {module-use.qdocinc} {building_with_qmake} {sensors}

    \section1 Articles and Guides

    \list
        \li \l {Qt Sensors C++ Overview}
        \li \l {Generic Backend} {Generic Backend}
        \li \l {Qt Sensors Backend}
        \li \l {Compatibility Map} {Compatibility Map}
        \li \l {How to create your own Sensor}
    \endlist

    \section1 Examples

    \list
        \li \l {Qt Sensors Examples} {Examples}
    \endlist

    \section1 API Reference

    \list
        \li \l {Qt Sensors QML Types} {QML Types}
        \li \l {Qt Sensors C++ Classes} {C++ Classes}
    \endlist

    \section1 Module Evolution
    \l{Changes to Qt Sensors} lists important changes in the module API
       and functionality that were made for the Qt 6 series of Qt.

    \section1 Licenses

    The Qt Sensors module is available under commercial licenses from
    \l{The Qt Company}. In addition, it is available under free software licenses:
       The \l{GNU Lesser General Public License, version 3}, or
       the \l{GNU General Public License, version 2}.
       See \l{Qt Licensing} for further details.
*/