qt-everywhere-src-5.15.1/qtsensors/examples/sensors/qmlqtsensors/doc/src/qmlqtsensors.qdoc

/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \example qmlqtsensors
    \title Qt Sensors - QML example
    \ingroup qtsensors-examples
    \image qmlqtsensors.png

    \section2 Qt Sensors in QML
    \brief The QtSensors - QML example demonstrates the QML sensors types in the QtSensors 5 import.


    To write a QML application that will use the QML sensors types in the QtSensors 5 import you need to to the following steps:

    Import the QtSensors 5.x declarative plugin:

    \snippet qmlqtsensors/qmlqtsensors.qml 0

    Add the Sensor QML types into your qml file.

    In this example we use the TiltSensor:

    \snippet qmlqtsensors/qmlqtsensors.qml 1

    The Tilt-, AmbientLight- and the Proximity QML sensor types have the 'enabled' property in common.
    To start or stop the sensor set this property to true or false.

    \snippet qmlqtsensors/qmlqtsensors.qml 2

    Reading the data can be done for each sensor type like following:

    \l {TiltSensor} {TiltSensor}

    \snippet qmlqtsensors/qmlqtsensors.qml 3
    \snippet qmlqtsensors/qmlqtsensors.qml 4

    \l {AmbientLightSensor} {AmbientLightSensor}

    \snippet qmlqtsensors/qmlqtsensors.qml 5

    \l {ProximitySensor} {ProximitySensor}

    \snippet qmlqtsensors/qmlqtsensors.qml 6
*/