summaryrefslogtreecommitdiffstats
path: root/doc/src
diff options
context:
space:
mode:
authorWolfgang Beck <wolfgang.beck@nokia.com>2011-12-02 12:03:42 +1000
committerQt by Nokia <qt-info@nokia.com>2011-12-05 01:49:15 +0100
commit44255a0b3042633aec46cae0a6fc192d19389fb3 (patch)
tree30f84fe3f597faf43a98be153fb50f24bdf5b5a6 /doc/src
parent3953c936b2259ddc7a3c394f124849e1a64e1952 (diff)
Tutorial doc for tilt abl and proxi qml sensors
Change-Id: Ie7aac8003aea91e7cef5a3db336e736500fd7949 Sanity-Review: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Lorn Potter <lorn.potter@nokia.com> Reviewed-by: Wolfgang Beck <wolfgang.beck@nokia.com>
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/examples/sensors.qdoc10
-rw-r--r--doc/src/qmlqtsensors5.qdoc68
2 files changed, 68 insertions, 10 deletions
diff --git a/doc/src/examples/sensors.qdoc b/doc/src/examples/sensors.qdoc
index 9de40042..91d4735a 100644
--- a/doc/src/examples/sensors.qdoc
+++ b/doc/src/examples/sensors.qdoc
@@ -59,16 +59,6 @@
*/
/*!
- \example sensors/qmlqtsensors5
- \title QtSensors 5 QML API example
- \ingroup qtsensors-examples
-
- The QtSensors 5 QML API example demonstrates the QML elements in the QtSensors 5 import.
-
- \sa QtSensors
-*/
-
-/*!
\example sensors/maze
\title Maze
\brief The Maze example demonstrates the TiltSensor QML element
diff --git a/doc/src/qmlqtsensors5.qdoc b/doc/src/qmlqtsensors5.qdoc
new file mode 100644
index 00000000..7f40a974
--- /dev/null
+++ b/doc/src/qmlqtsensors5.qdoc
@@ -0,0 +1,68 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 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/qmlqtsensors5
+ \title QtSensors 5 QML API example
+ \ingroup qtsensors-examples
+
+ The QtSensors 5 QML API example demonstrates the QML sensors elements in the QtSensors 5 import.
+
+\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/qmlqtsensors5/main.qml 0
+
+ Add the Sensor QML elements into your qml file.
+
+ In this example we use the TiltSensor:
+
+\snippet ../examples/sensors/qmlqtsensors5/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/qmlqtsensors5/main.qml 2
+
+ Reading the data can be done for each sensor type like following:
+
+ \l {QtSensors5::TiltSensor} {TiltSensor}
+
+\snippet ../examples/sensors/qmlqtsensors5/main.qml 3
+\snippet ../examples/sensors/qmlqtsensors5/main.qml 4
+
+ \l {QtSensors5::AmbientLightSensor} {AmbientLightSensor}
+
+\snippet ../examples/sensors/qmlqtsensors5/main.qml 5
+
+ \l {QtSensors5::ProximitySensor} {ProximitySensor}
+
+\snippet ../examples/sensors/qmlqtsensors5/main.qml 6
+*/
+