From 3b8c985084be2698745386f9618f26b04d475367 Mon Sep 17 00:00:00 2001
From: Wolfgang Beck <wolfgang.beck@nokia.com>
Date: Thu, 8 Dec 2011 13:28:43 +1000
Subject: Add tutorial for cubehouse example

Change-Id: I6058e9f5965d99e669ac845357916943d370f734
Sanity-Review: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Lincoln Ramsay <lincoln.ramsay@nokia.com>
Reviewed-by: Wolfgang Beck <wolfgang.beck@nokia.com>
---
 doc/src/cubehouse.qdoc        | 60 +++++++++++++++++++++++++++++++++++++++++++
 doc/src/examples/sensors.qdoc | 11 --------
 2 files changed, 60 insertions(+), 11 deletions(-)
 create mode 100644 doc/src/cubehouse.qdoc

(limited to 'doc/src')

diff --git a/doc/src/cubehouse.qdoc b/doc/src/cubehouse.qdoc
new file mode 100644
index 00000000..3a2b9410
--- /dev/null
+++ b/doc/src/cubehouse.qdoc
@@ -0,0 +1,60 @@
+/****************************************************************************
+**
+** 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/cubehouse
+    \title Cube House QML Accelerometer example
+    \ingroup qtsensors-examples
+    \brief The Cube House example demonstrates the use of the accelerometer to drive a camera to create a pseudo-3D effect.
+    \image cubehouse.png
+
+\section1 Overview
+    To write a QML application that will use the QML Accelerometer element from the QtMobility.sensors import you need to to the following steps:
+
+    Import the QtMobility.sensors declarative plugin:
+
+\snippet ../examples/sensors/cubehouse/Cubehouse.qml 0
+
+    Add the Accelerometer QML elements into your qml file.
+
+\snippet ../examples/sensors/cubehouse/Cubehouse.qml 1
+
+    In additional two properties are added to save the calculated pitch and roll values:
+
+\snippet ../examples/sensors/cubehouse/Cubehouse.qml 2
+
+    Reading out the Accelerometer data can be done by implementing the 'onReadingChanged' slot and
+    accessing the 'reading' property from the Accelerometer element:
+
+\snippet ../examples/sensors/cubehouse/Cubehouse.qml 3
+
+    By using a timer the view can be rotated using the pitch and roll properties from the Accelerometer element:
+
+\snippet ../examples/sensors/cubehouse/Cubehouse.qml 4
+
+*/
+
diff --git a/doc/src/examples/sensors.qdoc b/doc/src/examples/sensors.qdoc
index 91d4735a..98bf0e0e 100644
--- a/doc/src/examples/sensors.qdoc
+++ b/doc/src/examples/sensors.qdoc
@@ -36,17 +36,6 @@
     \generatelist related
 */
 
-/*!
-    \example sensors/cubehouse
-    \title Cube House QML Accelerometer example
-    \ingroup qtsensors-examples
-
-    \image cubehouse.png
-
-    The Cube House example demonstrates the use of the accelerometer to drive a camera
-    to create a pseudo-3D effect.
-*/
-
 /*!
     \example sensors/sensor_explorer
     \title Sensor Explorer
-- 
cgit v1.2.3