From 7553fe500a0059ca2975e291b9acde6e372c002d Mon Sep 17 00:00:00 2001
From: Lincoln Ramsay <lincoln.ramsay@nokia.com>
Date: Tue, 27 Sep 2011 16:34:20 +1000
Subject: Getting some structure into the sensors docs.

QtSensors is a landing page (from the Modules index).
There's a QtSensors Examples page that has all the examples on it.
The QtSensors page links off to the C++ and QML API pages.
More to do but this is a good start.

Change-Id: I2b795a759490e712137024101a630193d2d26033
Reviewed-on: http://codereview.qt-project.org/5589
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Lincoln Ramsay <lincoln.ramsay@nokia.com>
---
 doc/src/imports/qtsensors5.qdoc | 85 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 85 insertions(+)
 create mode 100644 doc/src/imports/qtsensors5.qdoc

(limited to 'doc/src/imports/qtsensors5.qdoc')

diff --git a/doc/src/imports/qtsensors5.qdoc b/doc/src/imports/qtsensors5.qdoc
new file mode 100644
index 00000000..ed28985c
--- /dev/null
+++ b/doc/src/imports/qtsensors5.qdoc
@@ -0,0 +1,85 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+    \qmlmodule QtSensors 5
+    \title QtSensors 5.x
+    \brief The QML import for QtSensors
+    \ingroup qtsensors
+
+    \section1 Overview
+
+    The identifying string for this component is \e QtSensors.
+    Use this in the QML \e import  statement.
+
+    The QML Sensors 5 Plugin provides an easy to use interface to the Sensors API.
+    It enables us to receive sensor events and to read current values from
+    sensors.
+
+    The plugin contains many sensor types and properties to read values
+    from them. As an example consider the tilt sensor. The qmlsensors2
+    simply displays text on-screen to show the current tilt.
+
+    The QML code that reads the value is quite simple. Here we see a QML component
+    tilt declared which is an \l TiltSensor element. First
+    the sensor is started by setting the running property
+    to true. The element receives a signal when the x and y rotation changes and it
+    can be picked up by the onXRotationChanged and onYRotationChanged slot. Now the
+    xRotation and yRotation property of this element can be
+    used to extract the current tilt so that it can be used for further calulations.
+
+    \qml
+        TiltSensor {
+            id: tilt
+            radian: false
+            measureFrom: TiltSensor.FaceUp
+            running: false
+        }
+    \endqml
+
+    \qml
+        Text {
+            x:5
+            y:160
+            text: "X Rotation: " + tilt.xRotation
+        }
+    \endqml
+
+    \qml
+        Text {
+            x:5
+            y:180
+            text: "Y Rotation: " + tilt.yRotation
+        }
+
+    \endqml
+
+    \section1 QML Elements
+
+*/
+
+
-- 
cgit v1.2.3