diff options
author | Wolfgang Beck <wolfgang.beck@nokia.com> | 2011-12-02 10:13:29 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2011-12-05 01:48:33 +0100 |
commit | 3953c936b2259ddc7a3c394f124849e1a64e1952 (patch) | |
tree | f7fdbe46a0c376d7bdf4fb83d44bffc7d628de68 | |
parent | 527e76a5693be3bfc7c699ddbe8410e84a4e2983 (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>
-rw-r--r-- | doc/src/examples/sensors.qdoc | 8 | ||||
-rw-r--r-- | doc/src/qmlsensorgtestures.qdoc | 61 | ||||
-rw-r--r-- | examples/sensors/qmlsensorgestures/qml_app/Gesture.qml | 2 | ||||
-rw-r--r-- | examples/sensors/qmlsensorgestures/qml_app/GestureList.qml | 3 | ||||
-rw-r--r-- | examples/sensors/qmlsensorgestures/qml_app/GestureView.qml | 21 |
5 files changed, 79 insertions, 16 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 + +*/ + diff --git a/examples/sensors/qmlsensorgestures/qml_app/Gesture.qml b/examples/sensors/qmlsensorgestures/qml_app/Gesture.qml index 0e41578a..1050bdd5 100644 --- a/examples/sensors/qmlsensorgestures/qml_app/Gesture.qml +++ b/examples/sensors/qmlsensorgestures/qml_app/Gesture.qml @@ -86,9 +86,11 @@ Rectangle { anchors.top: viewArea.top anchors.right: viewArea.right height: viewArea.height / 2 +//! [3] onSelectedGestureChanged: { gesture.enabled = false; gesture.gestureid = gestureList.selectedGesture; +//! [3] gesture.gesturetitle = gestureList.selectedGesture; } } diff --git a/examples/sensors/qmlsensorgestures/qml_app/GestureList.qml b/examples/sensors/qmlsensorgestures/qml_app/GestureList.qml index 6edfd4c9..540c80c8 100644 --- a/examples/sensors/qmlsensorgestures/qml_app/GestureList.qml +++ b/examples/sensors/qmlsensorgestures/qml_app/GestureList.qml @@ -95,6 +95,7 @@ Rectangle { anchors.bottom: gesturerect.bottom anchors.margins: 5 +//! [4] ListView { id: gestureList anchors.fill: gestureListRect @@ -104,7 +105,7 @@ Rectangle { currentIndex: -1 delegate: gestureListDelegate } - +//! [4] Component { id: gestureListDelegate diff --git a/examples/sensors/qmlsensorgestures/qml_app/GestureView.qml b/examples/sensors/qmlsensorgestures/qml_app/GestureView.qml index 324b90e2..196d8df7 100644 --- a/examples/sensors/qmlsensorgestures/qml_app/GestureView.qml +++ b/examples/sensors/qmlsensorgestures/qml_app/GestureView.qml @@ -40,7 +40,10 @@ //Import the declarative plugins import QtQuick 2.0 + +//! [0] import QtSensors 5.0 +//! [0] /* Layout gesturerect @@ -73,14 +76,17 @@ Rectangle { id: gesturerect border.width: 1 anchors.margins: 5 - property alias gestureid: sensorGuesture.gestures +//! [2] + property alias gestureid: sensorGesture.gestures +//! [2] property alias gesturetitle: titleText.text - property alias enabled: sensorGuesture.enabled + property alias enabled: sensorGesture.enabled property string oldgesture: "" property int count: 0 +//! [1] SensorGesture { - id: sensorGuesture + id: sensorGesture enabled: false onDetected:{ if (gesture !== oldgesture) @@ -93,6 +99,7 @@ Rectangle { valueText.text = "" } } +//! [1] Text { id: titleText @@ -123,7 +130,7 @@ Rectangle { horizontalAlignment: Text.AlignHCenter font.pixelSize: 15 text: ("") - visible: sensorGuesture.enabled + visible: sensorGesture.enabled } Button{ @@ -132,14 +139,14 @@ Rectangle { anchors.bottom: gesturerect.bottom height: 30 width: 100 - buttonText: (sensorGuesture.enabled ? "Stop" : "Start") + buttonText: (sensorGesture.enabled ? "Stop" : "Start") enabled: true; onClicked: { if (gestureStartStopButton.buttonText === "Start") { - sensorGuesture.enabled = true; + sensorGesture.enabled = true; } else { - sensorGuesture.enabled = false; + sensorGesture.enabled = false; } } } |