summaryrefslogtreecommitdiffstats
path: root/doc/src/imports/qtsensors5.qdoc
blob: 32c46677d22ff2fa8590e50a63f93dc1b626fa25 (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
/****************************************************************************
**
** 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$
**
****************************************************************************/

/*!
    \qmlmodule QtSensors 5
    \title Qt Sensors QML API
    \brief The QML import for Qt Sensors

    \section1 Overview


    Mobile devices contains sensor hardware that allow detecting changes in various physical
    properties of the device itself or its immediate environment. Examples of device properties
    include the angle at which the device is held, whereas environmental properties include for
    example the current level of ambient light.

    These properties can be either actual values, such as the tilt angle in
    degrees, or approximations, like the enumeration describing brightness in
    relative terms using values such as AmbientLightSensor.Dark and AmbientLightSensor.Bright.

    The latter type of value is also based on a natural phenomenon (in the case
    of the ambient light sensor, the amount of visible light emitted by a source), but the value
    itself is descriptive instead of using any effective unit of measurement, such as lumen.

    The identifying string for this component is \e QtSensors.
    Use this in the QML import statement, as such: \e import QtSensors 5.0

    Qt Sensors QML API provides an easy to use interface to the Qt Sensors API.
    It enables the receiving of sensor events and reading current values from the
    sensors.

    The emulator supports simulating the Ambient Light, Orientation, Compass and Proximity sensors.

    The \l {Qt Sensors - QML example} contains code for using the the \l TiltSensor, \l AmbientLightSensor
    and ProximitySensor types.

    \section1 QML Types

*/