summaryrefslogtreecommitdiffstats
path: root/doc/src
diff options
context:
space:
mode:
authorWolfgang Beck <wolfgang.beck@nokia.com>2011-12-02 10:13:29 +1000
committerQt by Nokia <qt-info@nokia.com>2011-12-05 01:48:33 +0100
commit3953c936b2259ddc7a3c394f124849e1a64e1952 (patch)
treef7fdbe46a0c376d7bdf4fb83d44bffc7d628de68 /doc/src
parent527e76a5693be3bfc7c699ddbe8410e84a4e2983 (diff)
Write a tutorial doc for the sensor gesture example
Change-Id: If30a0561ed943fd32a2543be1388e61adfb5bf9c 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.qdoc8
-rw-r--r--doc/src/qmlsensorgtestures.qdoc61
2 files changed, 61 insertions, 8 deletions
diff --git a/doc/src/examples/sensors.qdoc b/doc/src/examples/sensors.qdoc
index 7d4ee4c2..9de40042 100644
--- a/doc/src/examples/sensors.qdoc
+++ b/doc/src/examples/sensors.qdoc
@@ -69,14 +69,6 @@
*/
/*!
- \example sensors/qmlsensorgestures/qml_app
- \title SensorGesture QML Element example
- \ingroup qtsensors-examples
-
- This example demonstrates use of the SensorGesture QML element.
-*/
-
-/*!
\example sensors/maze
\title Maze
\brief The Maze example demonstrates the TiltSensor QML element
diff --git a/doc/src/qmlsensorgtestures.qdoc b/doc/src/qmlsensorgtestures.qdoc
new file mode 100644
index 00000000..0ed4d7ad
--- /dev/null
+++ b/doc/src/qmlsensorgtestures.qdoc
@@ -0,0 +1,61 @@
+/****************************************************************************
+**
+** 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/qmlsensorgestures/qml_app
+ \title SensorGesture QML Element example
+ \ingroup qtsensors-examples
+
+ This example demonstrates use of the SensorGesture QML element.
+
+\section1 Overview
+ To write a QML application that will use the gesture plugin you need to to the following steps:
+
+ Import the QtSensors 5.x declarative plugin:
+
+\snippet ../examples/sensors/qmlsensorgestures/qml_app/GestureView.qml 0
+
+ Add the SensorGesture QML element into your qml file.
+
+\snippet ../examples/sensors/qmlsensorgestures/qml_app/GestureView.qml 1
+
+ Each SensorGesture QML element contains a property called gestures.
+
+ In this example an alias 'gestureid' for this property is used.
+
+\snippet ../examples/sensors/qmlsensorgestures/qml_app/GestureView.qml 2
+
+ By using this alias property you define which gestures should be used:
+
+\snippet ../examples/sensors/qmlsensorgestures/qml_app/Gesture.qml 3
+
+ A list of all available gestures can be created by calling the 'availableGestures' property:
+
+\snippet ../examples/sensors/qmlsensorgestures/qml_app/GestureList.qml 4
+
+*/
+