summaryrefslogtreecommitdiffstats
path: root/src/imports/sensors2/qsensor2ambientlight.cpp
blob: ae4f54df5c44984533f3caa17e24c8e605373a28 (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
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** 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 "qsensor2ambientlight.h"
#include <QtCore/QDebug>

QT_BEGIN_NAMESPACE

/*!
    \qmlclass AmbientLightSensor QSensor2AmbientLight
    \inherits QtSensors5::Sensor
    \inqmlmodule QtSensors 5
    \ingroup qml-QtSensors5
    \since QtSensors 5.0
    \brief Provides access to the current ambient light level.

    This element provides easy access to determine the ambient light by using the ambient light sensor.
    For example brightening the screen according to whether the device is in full sunlight or not.

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

    The \l {QML Qt Sensors example} is an example how to use this QML element.
*/
QSensor2AmbientLight::QSensor2AmbientLight(QObject* parent)
    : qsensor2common(parent)
    , _lightLevel(QSensor2AmbientLight::Unknown)
{
    _ambientLight = new QAmbientLightSensor(this);
    _ambientLight->addFilter(this);
}


QSensor2AmbientLight::~QSensor2AmbientLight()
{
}

/*!
    \qmlproperty enumeration QtSensors5::AmbientLightSensor::lightLevel
    Holds the ambient light level in the form of the LightLevel enum:

    \table
    \row
        \li AmbientLightSensor.Unknown
        \li Ambient light value is not set yet.
    \row
        \li AmbientLightSensor.Dark
        \li It is dark.
    \row
        \li AmbientLightSensor.Twilight
        \li It is moderately dark.
    \row
        \li AmbientLightSensor.Light
        \li It is light (internal lights).
    \row
        \li AmbientLightSensor.Bright
        \li It is bright (outside but in the shade).
    \row
        \li AmbientLightSensor.Sunny
        \li It is very bright (direct sunlight).
    \endtable
*/
QSensor2AmbientLight::LightLevel QSensor2AmbientLight::lightLevel()
{
    return _lightLevel;
}

bool QSensor2AmbientLight::filter(QAmbientLightReading *reading)
{
    QSensor2AmbientLight::LightLevel lv = (QSensor2AmbientLight::LightLevel)reading->lightLevel();
    if (lv != _lightLevel){
        _lightLevel = lv;
        emit lightLevelChanged();
    }
    return false;
}

QT_END_NAMESPACE