diff options
author | Topi Reinio <topi.reinio@digia.com> | 2014-01-24 13:22:02 +0100 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@digia.com> | 2014-01-27 11:29:55 +0200 |
commit | ca01d5f9f5e960337a044be6e00de58fd4fbdb05 (patch) | |
tree | 3f2e25c5f05d5e5ba9bc44f2e5a09b86741c3fb5 /basicsuite/sensorexplorer/doc/src/sensor_explorer.qdoc | |
parent | 5a362f80d9da6d2d36efc127588f3c427211f98c (diff) |
Make basicsuite demos run stand-alone
This change will make the demos run standalone when built in
Qt Creator.
- Rename example directories to lowercase/non-whitespace
to avoid build & deployment problems
- Add title.txt files so titles remain displayed correctly
in the launcher
- Add a common shared source files used for the standalone
apps, and .pro-files for each example
- Remove .qmlproject files (not needed)
- Adjust documentation to match the new directory structure
Change-Id: Ib24e461952da3b2c88aab0363249115ea44ee0f2
Reviewed-by: Eirik Aavitsland <eirik.aavitsland@digia.com>
Diffstat (limited to 'basicsuite/sensorexplorer/doc/src/sensor_explorer.qdoc')
-rw-r--r-- | basicsuite/sensorexplorer/doc/src/sensor_explorer.qdoc | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/basicsuite/sensorexplorer/doc/src/sensor_explorer.qdoc b/basicsuite/sensorexplorer/doc/src/sensor_explorer.qdoc new file mode 100644 index 0000000..35f28d0 --- /dev/null +++ b/basicsuite/sensorexplorer/doc/src/sensor_explorer.qdoc @@ -0,0 +1,79 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** 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. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example sensorexplorer + \title Sensor Explorer + \brief The Sensor Explorer example demonstrates how to read the meta-data of available sensors. + \ingroup b2qt-demos + + \section2 Sensor Explorer in QML + + + This example is divided into two parts: + + \list + \li A 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 + + + 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 C++ plug-in before trying to run + this example, otherwise it will not find its dependencies. + + \code + qmlscene main.qml + \endcode + + To write a QML application that will use the Explorer QML type you need to do the following steps: + + Import the Explorer 1.0 declarative plugin: + + \snippet sensorexplorer/main.qml 0 + + Create a SensorExplorer QML item: + + \snippet sensorexplorer/main.qml 1 + + You can retrieve a list of all available sensors using the SensorExplorer: + + \snippet sensorexplorer/main.qml 2 + + To retrieve the properties of a SensorItem use: + + \snippet sensorexplorer/main.qml 3 + + Changing a property value can be done like: + + \snippet sensorexplorer/main.qml 4 + + Starting and stopping a sensor can be done like: + + \snippet sensorexplorer/main.qml 5 +*/ + |