From 6f390c5d4abd460e80c6c07cc0c885d53db865c1 Mon Sep 17 00:00:00 2001 From: Peter Yard Date: Tue, 30 Aug 2011 10:18:10 +1000 Subject: Import sensors docs from Mobility. Also bring in some examples that are referenced in the docs. Change-Id: I74560c62be447dda06ccfd8996818225df007c2e Reviewed-on: http://codereview.qt.nokia.com/3828 Reviewed-by: Lincoln Ramsay --- doc/src/snippets/sensors/creating.cpp | 64 ++++++++++++++++++++++++++++++++ doc/src/snippets/sensors/main.cpp | 46 +++++++++++++++++++++++ doc/src/snippets/sensors/mybackend.h | 59 ++++++++++++++++++++++++++++++ doc/src/snippets/sensors/plugin.cpp | 69 +++++++++++++++++++++++++++++++++++ doc/src/snippets/sensors/sensors.pro | 9 +++++ doc/src/snippets/sensors/start.cpp | 59 ++++++++++++++++++++++++++++++ doc/src/snippets/snippets.pro | 3 ++ 7 files changed, 309 insertions(+) create mode 100644 doc/src/snippets/sensors/creating.cpp create mode 100644 doc/src/snippets/sensors/main.cpp create mode 100644 doc/src/snippets/sensors/mybackend.h create mode 100644 doc/src/snippets/sensors/plugin.cpp create mode 100644 doc/src/snippets/sensors/sensors.pro create mode 100644 doc/src/snippets/sensors/start.cpp create mode 100644 doc/src/snippets/snippets.pro (limited to 'doc/src/snippets') diff --git a/doc/src/snippets/sensors/creating.cpp b/doc/src/snippets/sensors/creating.cpp new file mode 100644 index 00000000..98e7d5df --- /dev/null +++ b/doc/src/snippets/sensors/creating.cpp @@ -0,0 +1,64 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the Qt Mobility Components. +** +** $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 +#include +#include + +class MyWidget : public QWidget +{ + void create(); +}; + +void MyWidget::create() +{ +//! [Creating a sensor] +// On the heap (deleted when this object is deleted) +QAccelerometer *sensor = new QAccelerometer(this); + +// On the stack (deleted when the current scope ends) +QOrientationSensor orient_sensor; +//! [Creating a sensor] + + Q_UNUSED(sensor) + Q_UNUSED(orient_sensor); +} + diff --git a/doc/src/snippets/sensors/main.cpp b/doc/src/snippets/sensors/main.cpp new file mode 100644 index 00000000..81e526cb --- /dev/null +++ b/doc/src/snippets/sensors/main.cpp @@ -0,0 +1,46 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the Qt Mobility Components. +** +** $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$ +** +****************************************************************************/ + +int main(int /*argc*/, char ** /*argv*/) +{ + return 0; +} + diff --git a/doc/src/snippets/sensors/mybackend.h b/doc/src/snippets/sensors/mybackend.h new file mode 100644 index 00000000..7a99caa5 --- /dev/null +++ b/doc/src/snippets/sensors/mybackend.h @@ -0,0 +1,59 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the Qt Mobility Components. +** +** $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$ +** +****************************************************************************/ + +#ifndef MYBACKEND_H +#define MYBACKEND_H + +#include +#include + +class MyBackend : public QSensorBackend +{ +public: + MyBackend(QSensor *sensor) : QSensorBackend(sensor) {} + void stop() {} + void start() {} + void poll() {} + + static const char *id; +}; + +#endif diff --git a/doc/src/snippets/sensors/plugin.cpp b/doc/src/snippets/sensors/plugin.cpp new file mode 100644 index 00000000..7d548b77 --- /dev/null +++ b/doc/src/snippets/sensors/plugin.cpp @@ -0,0 +1,69 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the Qt Mobility Components. +** +** $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 "mybackend.h" +#include +#include + +const char *MyBackend::id = "mybackend"; + +//! [Plugin] +class MyPluginClass : public QObject, QSensorPluginInterface, public QSensorBackendFactory +{ + Q_OBJECT + Q_INTERFACES(QSensorPluginInterface) +public: + void registerSensors() + { + QSensorManager::registerBackend(QAccelerometer::type, MyBackend::id, this); + } + + QSensorBackend *createBackend(QSensor *sensor) + { + if (sensor->identifier() == MyBackend::id) + return new MyBackend(sensor); + return 0; + } +}; +//! [Plugin] + +//Q_EXPORT_PLUGIN2(libmy_plugin_file_name, MyPluginClass); +#include "plugin.moc" diff --git a/doc/src/snippets/sensors/sensors.pro b/doc/src/snippets/sensors/sensors.pro new file mode 100644 index 00000000..61a00955 --- /dev/null +++ b/doc/src/snippets/sensors/sensors.pro @@ -0,0 +1,9 @@ +TEMPLATE=app +TARGET=sensorsdocsnippet +QT += sensors +SOURCES+=main.cpp\ + creating.cpp\ + start.cpp\ + plugin.cpp +HEADERS+=mybackend.h +LIBS+=-rdynamic diff --git a/doc/src/snippets/sensors/start.cpp b/doc/src/snippets/sensors/start.cpp new file mode 100644 index 00000000..85fe1ed7 --- /dev/null +++ b/doc/src/snippets/sensors/start.cpp @@ -0,0 +1,59 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the Qt Mobility Components. +** +** $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 + +void start() +{ +//! [Starting a sensor] +// start the sensor +QSensor sensor("QAccelerometer"); +sensor.start(); + +// later +QSensorReading *reading = sensor.reading(); +qreal x = reading->property("x").value(); +qreal y = reading->value(1).value(); +//! [Starting a sensor] + + Q_UNUSED(x) + Q_UNUSED(y) +} diff --git a/doc/src/snippets/snippets.pro b/doc/src/snippets/snippets.pro new file mode 100644 index 00000000..0685c62c --- /dev/null +++ b/doc/src/snippets/snippets.pro @@ -0,0 +1,3 @@ +TEMPLATE = subdirs + +SUBDIRS += sensors -- cgit v1.2.3