diff options
author | Lincoln Ramsay <lincoln.ramsay@nokia.com> | 2011-08-23 11:21:42 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2011-08-25 07:59:15 +0200 |
commit | fd6f05aa763538309c4d26223f2111be8ec0f82d (patch) | |
tree | 503309c2369b1279eef94f810e45b03e574b7501 /src/qtmsensors/qlightsensor.cpp | |
parent | 85dc94873bd21d97cd472af77fefa25fecd8618e (diff) |
QtmSensors, legacy sensors library.
QtSensors will not remain source-compatible with Mobility.
QtmSensors exists to provide a source-compatible API.
QtmSensors is implemented as a wrapper over the QtSensors library.
Only front end functionality is supported. Backends must be ported
to QtSensors.
Change-Id: Ia7e45b719fb5f84637f899374990dbd680e259bd
Reviewed-on: http://codereview.qt.nokia.com/3348
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Zsolt Simon <zsolt.simon@nokia.com>
Diffstat (limited to 'src/qtmsensors/qlightsensor.cpp')
-rw-r--r-- | src/qtmsensors/qlightsensor.cpp | 154 |
1 files changed, 154 insertions, 0 deletions
diff --git a/src/qtmsensors/qlightsensor.cpp b/src/qtmsensors/qlightsensor.cpp new file mode 100644 index 00000000..355bbb7b --- /dev/null +++ b/src/qtmsensors/qlightsensor.cpp @@ -0,0 +1,154 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtSensors module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** GNU Lesser General Public License Usage +** 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, Nokia gives you certain additional +** rights. These rights are described in the Nokia 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. +** +** 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$ +** +****************************************************************************/ + +#include "qlightsensor.h" +#include "qlightsensor_p.h" + +QT_BEGIN_NAMESPACE +QTM_BEGIN_NAMESPACE + +IMPLEMENT_READING(QLightReading) + +/*! + \class QLightReading + \ingroup sensors_reading + + \since 1.2 + + \preliminary + \brief The QLightReading class represents one reading from the + light sensor. + + \section2 QLightReading Units + The light sensor returns the intensity of the light in lux. +*/ + +/*! + \property QLightReading::lux + \brief the light level. + + Measured as lux. + \sa {QLightReading Units} +*/ + +qreal QLightReading::lux() const +{ + return d->lux; +} + +/*! + Sets the light level to \a lux. +*/ +void QLightReading::setLux(qreal lux) +{ + d->lux = lux; +} + +// ===================================================================== + +/*! + \class QLightFilter + \ingroup sensors_filter + + \preliminary + \brief The QLightFilter class is a convenience wrapper around QSensorFilter. + + The only difference is that the filter() method features a pointer to QLightReading + instead of QSensorReading. +*/ + +/*! + \fn QLightFilter::filter(QLightReading *reading) + + Called when \a reading changes. Returns false to prevent the reading from propagating. + + \sa QSensorFilter::filter() +*/ + +char const * const QLightSensor::type("QLightSensor"); + +/*! + \class QLightSensor + \ingroup sensors_type + + \preliminary + \brief The QLightSensor 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 QLightReading instead of a QSensorReading. + + For details about how the sensor works, see \l QLightReading. + + \sa QLightReading +*/ + +/*! + \fn QLightSensor::QLightSensor(QObject *parent) + + Construct the sensor as a child of \a parent. +*/ + +/*! + \fn QLightSensor::~QLightSensor() + + Destroy the sensor. Stops the sensor if it has not already been stopped. +*/ + +/*! + \fn QLightSensor::reading() const + + Returns the reading class for this sensor. + + \sa QSensor::reading() +*/ + +/*! + \property QLightSensor::fieldOfView + \brief a value indicating the field of view. + + This is an angle that represents the field of view of the sensor. +*/ + +#include "moc_qlightsensor.cpp" +QTM_END_NAMESPACE +QT_END_NAMESPACE + |