summaryrefslogtreecommitdiffstats
path: root/src/imports/sensors2/qsensor2proximity.cpp
blob: 840d9b219b6df554cb9d6ab5de8e496f0bf2d5e2 (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
93
94
95
96
97
98
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtSensors module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qsensor2proximity.h"
#include <QtCore/QDebug>

QT_BEGIN_NAMESPACE

/*!
    \qmltype ProximitySensor
    \instantiates QSensor2Proximity
    \inherits QtSensors5::Sensor
    \inqmlmodule QtSensors 5.0
    \since QtSensors 5.0
    \brief Provides access to the proximity sensor.

    This type allows determining if something is held in close proximity to the device, such
    as determining if the user is holding the device to their ear.

    This type is part of the \b{QtSensors 5} module.

    The \l {Qt Sensors - QML example} is an example how to use this QML type.

*/

QSensor2Proximity::QSensor2Proximity(QObject* parent)
    : qsensor2common(parent)
    , _near(false)
{
    _proximity = new QProximitySensor(this);
    _proximity->addFilter(this);
}

QSensor2Proximity::~QSensor2Proximity()
{
}

/*!
    \qmlproperty bool QtSensors5::ProximitySensor::near
    This property holds whether the sensor has detected something in close proximity.
    The definition of close proximity is device dependent, but it
    typically stands for a distance of 1-2 cm.
*/
bool QSensor2Proximity::near()
{
    return _near;
}

bool QSensor2Proximity::filter(QProximityReading *reading)
{
    bool cl = reading->close();
    if (_near != cl){
        _near = cl;
        emit nearChanged();
    }

    return false;
}

QT_END_NAMESPACE