1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2016 The Qt Company Ltd. |
4 | ** Contact: https://www.qt.io/licensing/ |
5 | ** |
6 | ** This file is part of the QtSensors module of the Qt Toolkit. |
7 | ** |
8 | ** $QT_BEGIN_LICENSE:LGPL$ |
9 | ** Commercial License Usage |
10 | ** Licensees holding valid commercial Qt licenses may use this file in |
11 | ** accordance with the commercial license agreement provided with the |
12 | ** Software or, alternatively, in accordance with the terms contained in |
13 | ** a written agreement between you and The Qt Company. For licensing terms |
14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
15 | ** information use the contact form at https://www.qt.io/contact-us. |
16 | ** |
17 | ** GNU Lesser General Public License Usage |
18 | ** Alternatively, this file may be used under the terms of the GNU Lesser |
19 | ** General Public License version 3 as published by the Free Software |
20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
21 | ** packaging of this file. Please review the following information to |
22 | ** ensure the GNU Lesser General Public License version 3 requirements |
23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
24 | ** |
25 | ** GNU General Public License Usage |
26 | ** Alternatively, this file may be used under the terms of the GNU |
27 | ** General Public License version 2.0 or (at your option) the GNU General |
28 | ** Public license version 3 or any later version approved by the KDE Free |
29 | ** Qt Foundation. The licenses are as published by the Free Software |
30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
31 | ** included in the packaging of this file. Please review the following |
32 | ** information to ensure the GNU General Public License requirements will |
33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
35 | ** |
36 | ** $QT_END_LICENSE$ |
37 | ** |
38 | ****************************************************************************/ |
39 | |
40 | #include "qsensorplugin.h" |
41 | |
42 | QT_BEGIN_NAMESPACE |
43 | |
44 | /*! |
45 | \class QSensorPluginInterface |
46 | \ingroup sensors_backend |
47 | \inmodule QtSensors |
48 | \since 5.1 |
49 | \brief The QSensorPluginInterface class is the pure virtual interface to sensor plugins. |
50 | |
51 | The QSensorPluginInterface class is implemented in sensor plugins to register sensor |
52 | backends with QSensorManager. |
53 | |
54 | \sa {Creating a sensor plugin} |
55 | */ |
56 | |
57 | /*! |
58 | \internal |
59 | */ |
60 | QSensorPluginInterface::~QSensorPluginInterface() |
61 | { |
62 | } |
63 | |
64 | /*! |
65 | \fn QSensorPluginInterface::registerSensors() |
66 | |
67 | This function is called when the plugin is loaded. The plugin should register |
68 | sensor backends by calling QSensorManager::registerBackend(). Any backends |
69 | that utilise other sensors should be registered in the |
70 | QSensorPluginInterface::sensorsChanged() method instead. |
71 | |
72 | \sa {Creating a sensor plugin} |
73 | */ |
74 | |
75 | /*! |
76 | \class QSensorChangesInterface |
77 | \ingroup sensors_backend |
78 | \inmodule QtSensors |
79 | \since 5.1 |
80 | \brief The QSensorChangesInterface class is the pure virtual interface to sensor plugins. |
81 | |
82 | The QSensorChangesInterface class is implemented in sensor plugins to receive notification |
83 | that registered sensor backends have changed. |
84 | |
85 | \sa {Creating a sensor plugin} |
86 | */ |
87 | |
88 | /*! |
89 | \internal |
90 | */ |
91 | QSensorChangesInterface::~QSensorChangesInterface() |
92 | { |
93 | } |
94 | |
95 | /*! |
96 | \fn QSensorChangesInterface::sensorsChanged() |
97 | |
98 | This function is called when the registered backends have changed. |
99 | Any backends that depend on the presence of other sensors should be |
100 | registered or unregistered in here. |
101 | |
102 | \sa {Creating a sensor plugin} |
103 | */ |
104 | |
105 | QT_END_NAMESPACE |
106 | |