diff options
author | Wolfgang Beck <wolfgang.beck@nokia.com> | 2012-05-17 12:27:18 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-05-24 03:06:56 +0200 |
commit | 17d908ba5205513e9ed0be33aebeb3736bda0326 (patch) | |
tree | da04213540ee61853aab6b4260721f1badd703b2 /doc/src/examples/sensor_explorer.qdoc | |
parent | 32e2d98ea438041e7e0c4df7e67053c5ee7527a7 (diff) |
Unfork the examples.
Some examples were forked off and updated. Unfork by bringing
these changes back (a later update will bring the other examples
in line with this new style).
The changes are primarily made up of file renaming.
Also, JPG files have been converted to PNG.
Some documentation updates have been done.
Change-Id: Ib090abb5ebea2003d479d2336a23317f52b8c4d8
Reviewed-by: Lincoln Ramsay <lincoln.ramsay@nokia.com>
Diffstat (limited to 'doc/src/examples/sensor_explorer.qdoc')
-rw-r--r-- | doc/src/examples/sensor_explorer.qdoc | 57 |
1 files changed, 32 insertions, 25 deletions
diff --git a/doc/src/examples/sensor_explorer.qdoc b/doc/src/examples/sensor_explorer.qdoc index d8c6a5f2..1f8e022c 100644 --- a/doc/src/examples/sensor_explorer.qdoc +++ b/doc/src/examples/sensor_explorer.qdoc @@ -26,60 +26,67 @@ ****************************************************************************/ /*! - \example sensors/sensor_explorer - \title Sensor Explorer example + \example QtSensors/QtSensors_sensor_explorer + \title Qt Sensors - Explorer QML example \ingroup qtsensors-examples - \brief The Sensor Explorer example demonstrates how to read the meta-data of available sensors. - \image sensorexplorer.jpg - -\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. + \image sensorexplorer.png - \section1 Sensor Explorer QML Import + \section2 Sensor Explorer in QML + \brief The Sensor Explorer example demonstrates how to read the meta-data of available sensors. - 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. + This example is divided into two parts: - It consists of the code under the \c{import/} directory. + \list + \li A \l{Sensor Explorer QML Import}{C++ plug-in} that provides QML alternatives for QSensorExplorer, QPropertyInfo and the QSensorItem classes. + \li A QML Application that uses the QML alternatives to read the sensors meta-data and present it. + \endlist - \section1 Sensor Explorer QML Application This is a pure QML application that can be run from Qt Creator or directly using the - \c qmlscene binary. This app won't work if it cannot locate its related import. + \c qmlscene binary. You should install the other C++ plug-in before trying to run + this example, otherwise it will not find its dependencies. \code qmlscene main.qml \endcode -\section2 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 + \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 0 Create a SensorExplorer QML item: - \snippet ../examples/sensors/sensor_explorer/qml_app/main.qml 1 + \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 1 You can retrieve a list of all available sensors using the SensorExplorer: - \snippet ../examples/sensors/sensor_explorer/qml_app/main.qml 2 + \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 2 To retrieve the properties of a SensorItem use: - \snippet ../examples/sensors/sensor_explorer/qml_app/main.qml 3 + \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 3 Changing a property value can be done like: - \snippet ../examples/sensors/sensor_explorer/qml_app/main.qml 4 + \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 4 + + Starting and stopping a sensor can be done like: - Starting and stoping a sesnor can be done like: + \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 5 +*/ + +/*! + \example QtSensors/QtSensors_sensor_explorer/import + \title Sensor Explorer QML Import + + \section2 Sensor Explorer Declarative Plugin + \brief The Sensor Explorer QML import exports the QSensorExplorer, QPropertyInfo and the QSensorItem class as a QML element. - \snippet ../examples/sensors/sensor_explorer/qml_app/main.qml 5 + This example creates the \e {Explorer 1.0} import. + + \sa {Qt Sensors - Explorer QML example} */ + |