summaryrefslogtreecommitdiffstats
path: root/doc/src/examples/sensor_explorer.qdoc
blob: 1f8e022c1dd7315bf5dacb396f15213f0bfbe8ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** 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 QtSensors/QtSensors_sensor_explorer
    \title Qt Sensors - Explorer QML example
    \ingroup qtsensors-examples
    \image sensorexplorer.png

    \section2 Sensor Explorer in QML
    \brief The Sensor Explorer example demonstrates how to read the meta-data of available sensors.


    This example is divided into two parts:

    \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


    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 element you need to do the following steps:

    Import the Explorer 1.0 declarative plugin:

    \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 0

    Create a SensorExplorer QML item:

    \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/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 2

    To retrieve the properties of a SensorItem use:

    \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 3

    Changing a property value can be done like:

    \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 4

    Starting and stopping a sensor 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.

    This example creates the \e {Explorer 1.0} import.

    \sa {Qt Sensors - Explorer QML example}
*/