diff options
| -rw-r--r-- | doc/src/examples/sensors.qdoc | 10 | ||||
| -rw-r--r-- | doc/src/qmlqtsensors5.qdoc | 68 | ||||
| -rw-r--r-- | examples/sensors/qmlqtsensors5/main.qml | 17 |
3 files changed, 85 insertions, 10 deletions
diff --git a/doc/src/examples/sensors.qdoc b/doc/src/examples/sensors.qdoc index 9de40042..91d4735a 100644 --- a/doc/src/examples/sensors.qdoc +++ b/doc/src/examples/sensors.qdoc @@ -59,16 +59,6 @@ */ /*! - \example sensors/qmlqtsensors5 - \title QtSensors 5 QML API example - \ingroup qtsensors-examples - - The QtSensors 5 QML API example demonstrates the QML elements in the QtSensors 5 import. - - \sa QtSensors -*/ - -/*! \example sensors/maze \title Maze \brief The Maze example demonstrates the TiltSensor QML element diff --git a/doc/src/qmlqtsensors5.qdoc b/doc/src/qmlqtsensors5.qdoc new file mode 100644 index 00000000..7f40a974 --- /dev/null +++ b/doc/src/qmlqtsensors5.qdoc @@ -0,0 +1,68 @@ +/**************************************************************************** +** +** 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/qmlqtsensors5 + \title QtSensors 5 QML API example + \ingroup qtsensors-examples + + The QtSensors 5 QML API example demonstrates the QML sensors elements in the QtSensors 5 import. + +\section1 Overview + To write a QML application that will use the QML sensors elements in the QtSensors 5 import you need to to the following steps: + + Import the QtSensors 5.x declarative plugin: + +\snippet ../examples/sensors/qmlqtsensors5/main.qml 0 + + Add the Sensor QML elements into your qml file. + + In this example we use the TiltSensor: + +\snippet ../examples/sensors/qmlqtsensors5/main.qml 1 + + The Tilt-, AmbientLight- and the Proximity QML element sensor have the 'enabled' property in common. + To start or stop the sensor set this property to true or false. + +\snippet ../examples/sensors/qmlqtsensors5/main.qml 2 + + Reading the data can be done for each sensor type like following: + + \l {QtSensors5::TiltSensor} {TiltSensor} + +\snippet ../examples/sensors/qmlqtsensors5/main.qml 3 +\snippet ../examples/sensors/qmlqtsensors5/main.qml 4 + + \l {QtSensors5::AmbientLightSensor} {AmbientLightSensor} + +\snippet ../examples/sensors/qmlqtsensors5/main.qml 5 + + \l {QtSensors5::ProximitySensor} {ProximitySensor} + +\snippet ../examples/sensors/qmlqtsensors5/main.qml 6 +*/ + diff --git a/examples/sensors/qmlqtsensors5/main.qml b/examples/sensors/qmlqtsensors5/main.qml index cf20a6a3..9190dcb4 100644 --- a/examples/sensors/qmlqtsensors5/main.qml +++ b/examples/sensors/qmlqtsensors5/main.qml @@ -40,7 +40,10 @@ //Import the declarative plugins import QtQuick 2.0 + +//! [0] import QtSensors 5.0 +//! [0] /* Layout tiltrect @@ -89,12 +92,14 @@ Rectangle { height: 270 border.width: 1 +//! [1] TiltSensor { id: tilt unit: TiltSensor.Degrees enabled: false accuracy: 1.0 } +//! [1] Text{ id: textAccuracy @@ -233,13 +238,17 @@ Rectangle { id: xrottext x:5 y:195 +//! [3] text: "X Rotation: " + tilt.xRotation +//! [3] } Text { id: yrottext x:5 y:220 +//! [4] text: "Y Rotation: " + tilt.yRotation +//! [4] } Button{ id: tiltStart @@ -252,7 +261,9 @@ Rectangle { checked: tilt.enabled onClicked:{ +//! [2] tilt.enabled = tiltStart.checked; +//! [2] if (tiltStart.checked) tiltStart.text = "running"; else @@ -273,8 +284,10 @@ Rectangle { id: ambientlight enabled: false onLightLevelChanged:{ +//! [5] if (ambientlight.lightLevel == AmbientLightSensor.Unknown) ambientlighttext.text = "Ambient light: Unknown"; +//! [5] else if (ambientlight.lightLevel == AmbientLightSensor.Dark) ambientlighttext.text = "Ambient light: Dark"; else if (ambientlight.lightLevel == AmbientLightSensor.Twilight) @@ -287,6 +300,7 @@ Rectangle { ambientlighttext.text = "Ambient light: Sunny"; } } + Text { id: ambientlighttext x: 5 @@ -325,6 +339,7 @@ Rectangle { id: proxi enabled: true } + Text { id: proxitext x: 5 @@ -335,7 +350,9 @@ Rectangle { id: proxiStart x: 5 y: 35 +//! [6] text: proxi.enabled ? "running" : "start" +//! [6] checkColor: "lightblue" unCheckColor: "lightyellow" color: proxi.enabled ? checkColor : unCheckColor |