summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWolfgang Beck <wolfgang.beck@nokia.com>2011-12-30 12:53:45 +1000
committerQt by Nokia <qt-info@nokia.com>2012-01-11 23:48:22 +0100
commit1a2c653e3ef82de04906e88bdf2ec5efada324f9 (patch)
tree6c08cc73ba134644fb7e0a02d918974c2d4dd2a2 /doc
parentf9672df5ea9872f911eb0011012f829309e11e71 (diff)
downloadqtsensors-1a2c653e3ef82de04906e88bdf2ec5efada324f9.tar.gz
Convert sensor explorer example into a QML based application
Change-Id: If8628363c4998dabf85cad4277df088be23e3ff4 Sanity-Review: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Zsolt Simon <zsolt.simon@nokia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/src/examples/sensors.qdoc11
-rw-r--r--doc/src/images/sensor_explorer.pngbin52889 -> 0 bytes
-rw-r--r--doc/src/sensor_explorer.qdoc94
3 files changed, 94 insertions, 11 deletions
diff --git a/doc/src/examples/sensors.qdoc b/doc/src/examples/sensors.qdoc
index 2f203b6..77bb6b6 100644
--- a/doc/src/examples/sensors.qdoc
+++ b/doc/src/examples/sensors.qdoc
@@ -36,16 +36,5 @@
\generatelist related
*/
-/*!
- \example sensors/sensor_explorer
- \title Sensor Explorer example
- \ingroup qtsensors-examples
-
- \image sensor_explorer.png
-
- \brief The Sensor Explorer example demonstrates how to read the meta-data of available sensors.
-
- It was designed as a debugging aid.
-*/
diff --git a/doc/src/images/sensor_explorer.png b/doc/src/images/sensor_explorer.png
deleted file mode 100644
index 91d255e..0000000
--- a/doc/src/images/sensor_explorer.png
+++ /dev/null
Binary files differ
diff --git a/doc/src/sensor_explorer.qdoc b/doc/src/sensor_explorer.qdoc
new file mode 100644
index 0000000..16982c7
--- /dev/null
+++ b/doc/src/sensor_explorer.qdoc
@@ -0,0 +1,94 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \page sensor_explorer.html
+ \title Sensor Explorer example
+ \brief The Sensor Explorer example demonstrates how to read the meta-data of available sensors.
+ \ingroup qtsensors-examples
+
+\section1 Overview
+ This example contains 2 projects.
+
+ A \l{Sensor Explorer QML Import} to make the sensors and their meta-data available to a QML application.
+
+ A \l{Sensor Explorer QML Application} that represents the \l{Sensor Explorer QML Import} information to the user interface.
+*/
+
+
+/*!
+ \example sensors/sensor_explorer/import
+ \title Sensor Explorer QML Import
+ \brief The Sensor Explorer QML import exports the QSensorExplorer, QPropertyInfo and the QSensorItem class as a QML element.
+
+ This example creates the \e {Explorer 1.0} import.
+
+ \sa {Sensor Explorer Example}
+*/
+
+/*!
+ \example sensors/sensor_explorer/qml_app
+ \title Sensor Explorer QML Application
+ \brief The Sensor Explorer QML application demonstrates use of the Explorer 1.0 import QML elements.
+
+ This is a pure QML application that can be run from Qt Creator or directly using the
+ \c qmlscene binary. You should install the other projects before trying to run
+ this example or it will not be able to find its dependencies.
+
+ \code
+ qmlscene main.qml
+ \endcode
+
+ \sa {Sensor Explorer Example}
+
+\section1 Overview
+ To write a QML application that will use the Explorer QML element you need to do the following steps:
+
+ Import the Explorer 1.0 declarative plugin:
+
+ \snippet ../examples/sensors/sensor_explorer/qml_app/main.qml 0
+
+ Create a SensorExplorer QML item:
+
+ \snippet ../examples/sensors/sensor_explorer/qml_app/main.qml 1
+
+ You can retrieve a list of all available sensors using the SensorExplorer:
+
+ \snippet ../examples/sensors/sensor_explorer/qml_app/main.qml 2
+
+ To retrieve the properties of a SensorItem use:
+
+ \snippet ../examples/sensors/sensor_explorer/qml_app/main.qml 3
+
+ Changing a property value can be done like:
+
+ \snippet ../examples/sensors/sensor_explorer/qml_app/main.qml 4
+
+ Starting and stoping a sesnor can be done like:
+
+ \snippet ../examples/sensors/sensor_explorer/qml_app/main.qml 5
+*/