summaryrefslogtreecommitdiffstats
path: root/examples/sensors/qmlqtsensors/qmlqtsensors.qdoc
blob: 37318b82f2dc8db34a8c22c591fb1f0de258f611 (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) 2012 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** 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$
**
****************************************************************************/

/*!
    \example sensors/qmlqtsensors
    \title QML QtSensors example
    \ingroup qtsensors-examples
    \brief The QML QtSensors example demonstrates the QML sensors elements in the QtSensors 5 import.
    \image qmlqtsensors.jpg

\section1 Overview
    To write a QML application that will use the QML sensors elements in the QtSensors 5 import you need to to the following steps:

    Import the QtSensors 5.x declarative plugin:

\snippet ../examples/sensors/qmlqtsensors/main.qml 0

    Add the Sensor QML elements into your qml file.

    In this example we use the TiltSensor:

\snippet ../examples/sensors/qmlqtsensors/main.qml 1

    The Tilt-, AmbientLight- and the Proximity QML element sensor have the 'enabled' property in common.
    To start or stop the sensor set this property to true or false.

\snippet ../examples/sensors/qmlqtsensors/main.qml 2

    Reading the data can be done for each sensor type like following:

    \l {QtSensors5::TiltSensor} {TiltSensor}

\snippet ../examples/sensors/qmlqtsensors/main.qml 3
\snippet ../examples/sensors/qmlqtsensors/main.qml 4

    \l {QtSensors5::AmbientLightSensor} {AmbientLightSensor}

\snippet ../examples/sensors/qmlqtsensors/main.qml 5

    \l {QtSensors5::ProximitySensor} {ProximitySensor}

\snippet ../examples/sensors/qmlqtsensors/main.qml 6
*/