| 1 | // Copyright (C) 2016 The Qt Company Ltd. |
| 2 | // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only |
| 3 | |
| 4 | #include "qsensorplugin.h" |
| 5 | |
| 6 | QT_BEGIN_NAMESPACE |
| 7 | |
| 8 | /*! |
| 9 | \class QSensorPluginInterface |
| 10 | \ingroup sensors_backend |
| 11 | \inmodule QtSensors |
| 12 | \since 5.1 |
| 13 | \brief The QSensorPluginInterface class is the pure virtual interface to sensor plugins. |
| 14 | |
| 15 | The QSensorPluginInterface class is implemented in sensor plugins to register sensor |
| 16 | backends with QSensorManager. |
| 17 | |
| 18 | \sa {Creating a sensor plugin} |
| 19 | */ |
| 20 | |
| 21 | /*! |
| 22 | \internal |
| 23 | */ |
| 24 | QSensorPluginInterface::~QSensorPluginInterface() |
| 25 | { |
| 26 | } |
| 27 | |
| 28 | /*! |
| 29 | \fn QSensorPluginInterface::registerSensors() |
| 30 | |
| 31 | This function is called when the plugin is loaded. The plugin should register |
| 32 | sensor backends by calling QSensorManager::registerBackend(). Any backends |
| 33 | that utilise other sensors should be registered in the |
| 34 | QSensorPluginInterface::sensorsChanged() method instead. |
| 35 | |
| 36 | \sa {Creating a sensor plugin} |
| 37 | */ |
| 38 | |
| 39 | /*! |
| 40 | \class QSensorChangesInterface |
| 41 | \ingroup sensors_backend |
| 42 | \inmodule QtSensors |
| 43 | \since 5.1 |
| 44 | \brief The QSensorChangesInterface class is the pure virtual interface to sensor plugins. |
| 45 | |
| 46 | The QSensorChangesInterface class is implemented in sensor plugins to receive notification |
| 47 | that registered sensor backends have changed. |
| 48 | |
| 49 | \sa {Creating a sensor plugin} |
| 50 | */ |
| 51 | |
| 52 | /*! |
| 53 | \internal |
| 54 | */ |
| 55 | QSensorChangesInterface::~QSensorChangesInterface() |
| 56 | { |
| 57 | } |
| 58 | |
| 59 | /*! |
| 60 | \fn QSensorChangesInterface::sensorsChanged() |
| 61 | |
| 62 | This function is called when the registered backends have changed. |
| 63 | Any backends that depend on the presence of other sensors should be |
| 64 | registered or unregistered in here. |
| 65 | |
| 66 | \sa {Creating a sensor plugin} |
| 67 | */ |
| 68 | |
| 69 | QT_END_NAMESPACE |
| 70 | |