Add QHolsterSensor

This adds a new QHolsterSensor plus the assorted reading and filter
classes, as well as a QML API.

Also implement the Blackberry backend for it.

Change-Id: I42e76c21ee74a39a65629e7ab6d9a18f23eae4d4
Reviewed-by: Thomas McGuire <thomas.mcguire@kdab.com>

5 files changed, 237 insertions, 0 deletions

diff --git a/src/imports/sensors/plugins.qmltypes b/src/imports/sensors/plugins.qmltypes
index 94db26d..541384a 100644
--- a/src/imports/sensors/plugins.qmltypes
+++ b/src/imports/sensors/plugins.qmltypes
@@ -70,6 +70,17 @@ Module {
         Property { name: "z"; type: "double"; isReadonly: true }
     }
     Component {
+        name: "QmlHolsterReading"
+        prototype: "QmlSensorReading"
+        exports: ["HolsterReading 5.1"]
+        Property { name: "holstered"; type: "bool"; isReadonly: true }
+    }
+    Component {
+        name: "QmlHolsterSensor"
+        prototype: "QmlSensor"
+        exports: ["HolsterSensor 5.1"]
+    }
+    Component {
         name: "QmlIRProximitySensor"
         prototype: "QmlSensor"
         exports: ["IRProximitySensor 5.0", "IRProximitySensor 5.1"]
diff --git a/src/imports/sensors/qmlholstersensor.cpp b/src/imports/sensors/qmlholstersensor.cpp
new file mode 100644
index 0000000..a1eae05
--- /dev/null
+++ b/src/imports/sensors/qmlholstersensor.cpp
@@ -0,0 +1,133 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Research In Motion
+** 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 "qmlholstersensor.h"
+#include <QHolsterSensor>
+
+/*!
+    \qmltype HolsterSensor
+    \instantiates QmlHolsterSensor
+    \ingroup qml-sensors_type
+    \inqmlmodule QtSensors 5.0
+    \since QtSensors 5.1
+    \inherits Sensor
+    \brief The HolsterSensor element reports on whether a device is holstered.
+
+    The HolsterSensor element reports on whether a device is holstered.
+
+    This element wraps the QHolsterSensor class. Please see the documentation for
+    QHolsterSensor for details.
+
+    \sa HolsterReading
+*/
+
+QmlHolsterSensor::QmlHolsterSensor(QObject *parent)
+    : QmlSensor(parent)
+    , m_sensor(new QHolsterSensor(this))
+{
+}
+
+QmlHolsterSensor::~QmlHolsterSensor()
+{
+}
+
+QmlSensorReading *QmlHolsterSensor::createReading() const
+{
+    return new QmlHolsterReading(m_sensor);
+}
+
+QSensor *QmlHolsterSensor::sensor() const
+{
+    return m_sensor;
+}
+
+/*!
+    \qmltype HolsterReading
+    \instantiates QmlHolsterReading
+    \ingroup qml-sensors_reading
+    \inqmlmodule QtSensors 5.0
+    \since QtSensors 5.1
+    \inherits SensorReading
+    \brief The HolsterReading element holds the most recent HolsterSensor reading.
+
+    The HolsterReading element holds the most recent HolsterSensor reading.
+
+    This element wraps the QHolsterReading class. Please see the documentation for
+    QHolsterReading for details.
+
+    This element cannot be directly created.
+*/
+
+QmlHolsterReading::QmlHolsterReading(QHolsterSensor *sensor)
+    : QmlSensorReading(sensor)
+    , m_sensor(sensor)
+    , m_holstered(false)
+{
+}
+
+QmlHolsterReading::~QmlHolsterReading()
+{
+}
+
+/*!
+    \qmlproperty qreal HolsterReading::holstered
+    This property holds whether the device is holstered.
+
+    Please see QHolsterReading::holstered for information about this property.
+*/
+
+bool QmlHolsterReading::holstered() const
+{
+    return m_holstered;
+}
+
+QSensorReading *QmlHolsterReading::reading() const
+{
+    return m_sensor->reading();
+}
+
+void QmlHolsterReading::readingUpdate()
+{
+    qreal holstered = m_sensor->reading()->holstered();
+    if (m_holstered != holstered) {
+        m_holstered = holstered;
+        Q_EMIT holsteredChanged();
+    }
+}
diff --git a/src/imports/sensors/qmlholstersensor.h b/src/imports/sensors/qmlholstersensor.h
new file mode 100644
index 0000000..95c7bfa
--- /dev/null
+++ b/src/imports/sensors/qmlholstersensor.h
@@ -0,0 +1,88 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Research In Motion
+** 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$
+**
+****************************************************************************/
+#ifndef QMLHOLSTERSENSOR_H
+#define QMLHOLSTERSENSOR_H
+
+#include "qmlsensor.h"
+
+QT_BEGIN_HEADER
+QT_BEGIN_NAMESPACE
+
+class QHolsterSensor;
+
+class QmlHolsterSensor : public QmlSensor
+{
+    Q_OBJECT
+public:
+    explicit QmlHolsterSensor(QObject *parent = 0);
+    ~QmlHolsterSensor();
+
+private:
+    QSensor *sensor() const Q_DECL_OVERRIDE;
+    QmlSensorReading *createReading() const Q_DECL_OVERRIDE;
+
+    QHolsterSensor *m_sensor;
+};
+
+class QmlHolsterReading : public QmlSensorReading
+{
+    Q_OBJECT
+    Q_PROPERTY(bool holstered READ holstered NOTIFY holsteredChanged)
+public:
+    explicit QmlHolsterReading(QHolsterSensor *sensor);
+    ~QmlHolsterReading();
+
+    bool holstered() const;
+
+Q_SIGNALS:
+    void holsteredChanged();
+
+private:
+    QSensorReading *reading() const Q_DECL_OVERRIDE;
+    void readingUpdate() Q_DECL_OVERRIDE;
+
+    QHolsterSensor *m_sensor;
+    bool m_holstered;
+};
+
+QT_END_NAMESPACE
+QT_END_HEADER
+#endif
diff --git a/src/imports/sensors/sensors.cpp b/src/imports/sensors/sensors.cpp
index 3f77431..52b436d 100644
--- a/src/imports/sensors/sensors.cpp
+++ b/src/imports/sensors/sensors.cpp
@@ -62,6 +62,7 @@
 #include "qmlambientlightsensor.h"
 #include "qmlcompass.h"
 #include "qmlgyroscope.h"
+#include "qmlholstersensor.h"
 #include "qmlirproximitysensor.h"
 #include "qmllightsensor.h"
 #include "qmlmagnetometer.h"
@@ -143,6 +144,8 @@ public:
         qmlRegisterUncreatableType<QmlCompassReading           >(package, major, minor, "CompassReading",       QLatin1String("Cannot create CompassReading"));
         qmlRegisterType           <QmlGyroscope                >(package, major, minor, "Gyroscope");
         qmlRegisterUncreatableType<QmlGyroscopeReading         >(package, major, minor, "GyroscopeReading",     QLatin1String("Cannot create GyroscopeReading"));
+        qmlRegisterType           <QmlHolsterSensor            >(package, major, minor, "HolsterSensor");
+        qmlRegisterUncreatableType<QmlHolsterReading           >(package, major, minor, "HolsterReading",       QLatin1String("Cannot create HolsterReading"));
         qmlRegisterType           <QmlIRProximitySensor        >(package, major, minor, "IRProximitySensor");
         qmlRegisterUncreatableType<QmlIRProximitySensorReading >(package, major, minor, "IRProximityReading",   QLatin1String("Cannot create IRProximityReading"));
         qmlRegisterType           <QmlLightSensor              >(package, major, minor, "LightSensor");
diff --git a/src/imports/sensors/sensors.pro b/src/imports/sensors/sensors.pro
index 8224151..102dd30 100644
--- a/src/imports/sensors/sensors.pro
+++ b/src/imports/sensors/sensors.pro
@@ -12,6 +12,7 @@ HEADERS += \
     qmlambientlightsensor.h \
     qmlcompass.h \
     qmlgyroscope.h \
+    qmlholstersensor.h \
     qmlirproximitysensor.h \
     qmllightsensor.h \
     qmlmagnetometer.h \
@@ -31,6 +32,7 @@ SOURCES += sensors.cpp \
     qmlambientlightsensor.cpp \
     qmlcompass.cpp \
     qmlgyroscope.cpp \
+    qmlholstersensor.cpp \
     qmlirproximitysensor.cpp \
     qmllightsensor.cpp \
     qmlmagnetometer.cpp \