summaryrefslogtreecommitdiffstats
path: root/doc/src/examples/qmlqtsensors.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/examples/qmlqtsensors.qdoc')
-rw-r--r--doc/src/examples/qmlqtsensors.qdoc68
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/src/examples/qmlqtsensors.qdoc b/doc/src/examples/qmlqtsensors.qdoc
new file mode 100644
index 00000000..4e997c8a
--- /dev/null
+++ b/doc/src/examples/qmlqtsensors.qdoc
@@ -0,0 +1,68 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \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
+*/
+