summaryrefslogtreecommitdiffstats
path: root/src/sensors/doc/src/qtmobilitysensors1.qdoc
blob: f9ba814f6c1ffc198d029fbf2058a723517a8b5c (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
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/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: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \qmlmodule QtMobility.sensors 1.3
    \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.

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

    \section1 QML Module API

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

    If the module is imported into a namespace, some additional methods become available.

    \code
    import QtMobility.sensors 1.3 as Sensors
    ...
        Component.onCompleted: {
            var types = Sensors.sensorTypes();
            console.log(types.join(", "));
        }
    \endcode

    The documentation for the module API can be found in SensorGlobal.

    \section1 QML Sensor types

    These types represent specific types of sensors.

    Note that most properties come from the abstract \l{QtMobility.sensors1::Sensor}{Sensor} element.

    \annotatedlist qml-sensors_type

    \section1 QML Reading types

    The data from a sensor comes through a reading class.

    \annotatedlist qml-sensors_reading

    \section1 Alphabetical Listing of QML Types

*/