summaryrefslogtreecommitdiffstats
path: root/doc/src/imports/qtmobilitysensors1.qdoc
blob: b4906ed2f30f51594449f2b152cf597b47228df1 (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
69
70
71
72
73
74
75
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** GNU Free Documentation License
** 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.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms
** and conditions contained in a signed written agreement between you
** and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \qmlmodule QtMobility.sensors 1
    \title QtMobility.sensors 1.x
    \brief Legacy QML import for QtSensors

    \section1 Overview

    This is the legacy QML import. It exists for compatibility with the QtMobiltiy 1.2 release
    and is not recommended for new applications.

    The QtMobility.sensors import has the Qt Sensors C++ classes directly exported into the QML environment.
    This causes some limitations due to the use of types that do not work in the QML environment.
    See \l{QtMobility.sensors QML Limitations}{below} for a list of the known limitations.

    See \l Qt Sensors for more information about the Sensors API.

    \section1 QtMobility.sensors QML Limitations

    The following limitations affect all versions of the QtMobility.sensors import.

    \list 1
    \li The QSensor::sensorid property cannot be set because QML does not support QByteArray.
       This means that it is not possible to specify a particular sensor when two or more have
       been registered with the same type.
    \li The QSensor::availableDataRates property cannot be used because QML does not support \l qrangelist.
    \li The QSensor::outputRanges property cannot be used because QML does not support \l qoutputrangelist.
    \li The QLightSensor::fieldOfView property cannot be used because QML cannot access dynamic properties.
    \li The QMagnetometer::returnGeoValues property cannot be used because QML cannot access dynamic properties.
    \li The QRotationSensor::hasZ property cannot be used because QML cannot access dynamic properties.
    \li The QTapSensor::returnDoubleTapEvents property cannot be used because QML cannot access dynamic properties.
    \endlist

    \section1 QML Sensor Elements

    These elements represent specific types of sensors.

    \annotatedlist qml-sensors_type

    \section1 QML Reading Elements

    The data from a sensor comes through a reading class.

    \annotatedlist qml-sensors_reading

    \section1 Alphabetical Listing of QML Elements

*/