blob: 73b609e322e3b05b3418d1e9fd4b189db42c2175 (
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qproximitysensor.h"
#include "qproximitysensor_p.h"
QT_BEGIN_NAMESPACE
IMPLEMENT_READING(QProximityReading)
/*!
\class QProximityReading
\ingroup sensors_reading
\inmodule QtSensors
\since 5.1
\brief The QProximityReading class represents one reading from the
proximity sensor.
\target QProximityReading_Units
The proximity sensor can only indicate if an object is close or not.
The distance at which an object is considered close is device-specific. This
distance may be available in the QSensor::outputRanges property.
*/
/*!
\property QProximityReading::close
\brief a value indicating if something is close.
Set to true if something is close.
Set to false is nothing is close.
\sa QProximityReading_Units
*/
bool QProximityReading::close() const
{
return d->close;
}
/*!
Sets the close value to \a close.
*/
void QProximityReading::setClose(bool close)
{
d->close = close;
}
// =====================================================================
/*!
\class QProximityFilter
\ingroup sensors_filter
\inmodule QtSensors
\since 5.1
\brief The QProximityFilter class is a convenience wrapper around QSensorFilter.
The only difference is that the filter() method features a pointer to QProximityReading
instead of QSensorReading.
*/
/*!
\fn QProximityFilter::filter(QProximityReading *reading)
Called when \a reading changes. Returns false to prevent the reading from propagating.
\sa QSensorFilter::filter()
*/
bool QProximityFilter::filter(QSensorReading *reading)
{
return filter(static_cast<QProximityReading*>(reading));
}
char const * const QProximitySensor::sensorType("QProximitySensor");
/*!
\class QProximitySensor
\ingroup sensors_type
\inmodule QtSensors
\since 5.1
\brief The QProximitySensor class is a convenience wrapper around QSensor.
The only behavioural difference is that this class sets the type properly.
This class also features a reading() function that returns a QProximityReading instead of a QSensorReading.
For details about how the sensor works, see \l QProximityReading.
\sa QProximityReading
*/
/*!
Construct the sensor as a child of \a parent.
*/
QProximitySensor::QProximitySensor(QObject *parent)
: QSensor(QProximitySensor::sensorType, parent)
{
}
/*!
Destroy the sensor. Stops the sensor if it has not already been stopped.
*/
QProximitySensor::~QProximitySensor()
{
}
/*!
\fn QProximitySensor::reading() const
Returns the reading class for this sensor.
\sa QSensor::reading()
*/
QProximityReading *QProximitySensor::reading() const
{
return static_cast<QProximityReading*>(QSensor::reading());
}
QT_END_NAMESPACE
#include "moc_qproximitysensor.cpp"
|
