MTMW-98 QML API Version 2

Change-Id: I10c610ae22974d291fad663088c5a11449a86b05
Reviewed-on: http://codereview.qt-project.org/4107
Reviewed-by: Wolfgang Beck <wolfgang.beck@nokia.com>

2 files changed, 199 insertions, 0 deletions

diff --git a/doc/src/imports/qml-qtsensors5.qdoc b/doc/src/imports/qml-qtsensors5.qdoc
new file mode 100644
index 00000000..a7ba0786
--- /dev/null
+++ b/doc/src/imports/qml-qtsensors5.qdoc
@@ -0,0 +1,100 @@
+/****************************************************************************
+**
+** 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 Sensors QML Plugin for Qt 5
+    \brief A QML plugin for the Qt 5 Project Sensors API.
+*/
+
+/*!
+    \page qmlqtsensors5.html
+    \title Sensors 5 QML Plugin example
+    \example qmlqtsensors5
+*/
+
+/*!
+    \page qml-sensors5.html
+    \title Sensors 5 QML Plugin
+
+    \brief A QML plugin for the Qt Project Sensors 5 API.
+
+    \section1 Overview
+
+    The identifying string for this component is \i {"Qt.QtSensors"}.
+    Use this in the QML \i {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
+    \annotatedlist qml-QtSensors5
+
+    \section1 QML QtSensors Example
+    The \l {qmlqtsensors5}{qmlqtsensors5} example shows you how to use all those diferent QML elements.
+*/
+
+
diff --git a/doc/src/imports/qml-sensors.qdoc b/doc/src/imports/qml-sensors.qdoc
new file mode 100644
index 00000000..e547daa9
--- /dev/null
+++ b/doc/src/imports/qml-sensors.qdoc
@@ -0,0 +1,99 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+    \group qml-sensors
+    \title QML Sensors API Plugin
+    QML Support for the QtMobility Project Sensors API.
+*/
+
+/*!
+    \page qml-sensors.html
+
+    \title Sensors QML Plugin
+
+    \brief A QML plugin for the QtMobility Project Sensors API.
+
+    \section1 Overview
+
+    The QML Sensors 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 access functions to read values
+    from them. As an example consider the orientation sensor. The orientation
+    example simply displays text on-screen to show the current orientation.
+
+    The QML code that reads the value is quite simple. Here we see a QML component
+    \i orientation declared which is an \l OrientationSensor element. First
+    the sensor is started by setting the \l {Sensor::active}{active} property
+    to \i true. The element receives a signal when the reading changes and it
+    is picked up by the \i onReadingChanged slot. Now the
+    \l {OrientationSensor::reading}{reading} property of this element can be
+    used to extract the current orientation so that it can be compared against
+    the defined values of various orientations in the \l OrientationReading
+    element.
+
+    \qml
+        OrientationSensor {
+            id: orientation
+            active: true
+
+            onReadingChanged: {
+
+                if (reading.orientation == OrientationReading.FaceUp)
+                    content.state = "FaceUp";
+
+                // ... more tests for different orientations ...
+            }
+        }
+
+    \endqml
+
+    Other sensors can be treated in a similar manner. For example, the \l Compass
+    sensor could have almost identical coding
+
+    \qml
+        Compass {
+            id: compass
+            active: true
+
+            onReadingChanged: {
+                compassHeading.text = reading.azimuth;
+
+                // ...
+            }
+        }
+    \endqml
+
+    \section1 QML Elements
+    \annotatedlist qml-sensors_type
+    \annotatedlist qml-sensors_reading
+
+*/
+
+