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 QtPositioning 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 "qgeopositioninfosourcefactory.h"
41
42QT_BEGIN_NAMESPACE
43
44/*!
45 \class QGeoPositionInfoSourceFactory
46 \inmodule QtPositioning
47 \since 5.2
48
49 \brief The QGeoPositionInfoSourceFactory class is a factory class used
50 as the plugin interface for external providers of positioning data.
51
52 The other functions must be overridden by all plugins, other than
53 sourcePriority() which defaults to returning 0. Higher values of
54 priority will be preferred to lower ones.
55*/
56
57/*!
58 \fn QGeoPositionInfoSource *QGeoPositionInfoSourceFactory::positionInfoSource(QObject *parent)
59
60 Returns a new QGeoPositionInfoSource associated with this plugin
61 with parent \a parent. Can also return 0, in which case the plugin
62 loader will use the factory with the next highest priority.
63 */
64
65/*!
66 \fn QGeoSatelliteInfoSource *QGeoPositionInfoSourceFactory::satelliteInfoSource(QObject *parent)
67
68 Returns a new QGeoSatelliteInfoSource associated with this plugin
69 with parent \a parent. Can also return 0, in which case the plugin
70 loader will use the factory with the next highest priority.
71 */
72
73/*!
74 \fn QGeoAreaMonitorSource *QGeoPositionInfoSourceFactory::areaMonitor(QObject *parent);
75
76 Returns a new QGeoAreaMonitorSource associated with this plugin with parent \a parent.
77 Can also return 0, in which case the plugin loader will use the factory with the
78 next highest priority.
79 */
80
81/*!
82 Destroys the position info source factory.
83*/
84QGeoPositionInfoSourceFactory::~QGeoPositionInfoSourceFactory()
85{}
86
87/*!
88 \class QGeoPositionInfoSourceFactoryV2
89 \inmodule QtPositioning
90 \since 5.14
91
92 \brief The QGeoPositionInfoSourceFactoryV2 class extends
93 QGeoPositionInfoSourceFactory, adding factory methods taking a parameters argument.
94
95 This interface has the priority over the older one with plugins implementing it,
96 when creating a positioning source (position, satellite or area monitor)
97*/
98
99/*!
100 \fn QGeoPositionInfoSource *QGeoPositionInfoSourceFactoryV2::positionInfoSourceWithParameters(QObject *parent, const QVariantMap &parameters)
101
102 Returns a new QGeoPositionInfoSource associated with this plugin
103 with parent \a parent, and using \a parameters as configuration parameters.
104 Can also return 0, in which case the plugin loader will use the factory with
105 the next highest priority.
106 */
107
108/*!
109 \fn QGeoSatelliteInfoSource *QGeoPositionInfoSourceFactoryV2::satelliteInfoSourceWithParameters(QObject *parent, const QVariantMap &parameters)
110
111 Returns a new QGeoSatelliteInfoSource associated with this plugin
112 with parent \a parent, and using \a parameters as configuration parameters.
113 Can also return 0, in which case the plugin loader will use the factory with
114 the next highest priority.
115 */
116
117/*!
118 \fn QGeoAreaMonitorSource *QGeoPositionInfoSourceFactoryV2::areaMonitorWithParameters(QObject *parent, const QVariantMap &parameters);
119
120 Returns a new QGeoAreaMonitorSource associated with this plugin with parent
121 \a parent, and using \a parameters as configuration parameters.
122 Can also return 0, in which case the plugin loader will use the factory with
123 the next highest priority.
124 */
125
126QGeoPositionInfoSourceFactoryV2::~QGeoPositionInfoSourceFactoryV2()
127{}
128
129QT_END_NAMESPACE
130
131

source code of qtlocation/src/positioning/qgeopositioninfosourcefactory.cpp