Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qgeoserviceproviderfactory.cpp
Go to the documentation of this file.
1// Copyright (C) 2022 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 "qgeoserviceproviderfactory.h"
5
6QT_BEGIN_NAMESPACE
7
8/*!
9 \class QGeoServiceProviderFactory
10 \inmodule QtLocation
11 \ingroup QtLocation-impl
12 \since 5.6
13 \deprecated
14
15 \brief The QGeoServiceProviderFactory class is a factory class used as the
16 plugin interface for services related to geographical information.
17
18 \note There are no source or binary compatibility guarantees for the
19 backend classes. The API is only guaranteed to work with the Qt version it
20 was developed against. API changes will however only be made in minor
21 releases. (6.6, 6.7, and so on.)
22
23 Implementers must provide a unique combination of providerName() and
24 providerVersion() per plugin.
25
26 The other functions should be overridden if the plugin supports the
27 associated set of functionality.
28*/
29
30/*!
31 \fn QGeoServiceProviderFactory::~QGeoServiceProviderFactory()
32
33 Destroys this QGeoServiceProviderFactory instance.
34*/
35
36/*!
37 Returns a new QGeoCodingManagerEngine instance, initialized with \a
38 parameters, which implements the location geocoding functionality.
39
40 If \a error is not \nullptr it should be set to QGeoServiceProvider::NoError on
41 success or an appropriate QGeoServiceProvider::Error on failure.
42
43 If \a errorString is not \nullptr it should be set to a string describing any
44 error which occurred.
45
46 The default implementation returns \nullptr, which causes a
47 QGeoServiceProvider::NotSupportedError in QGeoServiceProvider.
48*/
49QGeoCodingManagerEngine *
50QGeoServiceProviderFactory::createGeocodingManagerEngine(const QVariantMap &parameters,
51 QGeoServiceProvider::Error *error,
52 QString *errorString) const
53{
54 Q_UNUSED(parameters);
55 Q_UNUSED(error);
56 Q_UNUSED(errorString);
57
58 return nullptr;
59}
60
61/*!
62 Returns a new QGeoMappingManagerEngine instance, initialized with \a
63 parameters, which implements mapping functionality.
64
65 If \a error is not \nullptr it should be set to QGeoServiceProvider::NoError on
66 success or an appropriate QGeoServiceProvider::Error on failure.
67
68 If \a errorString is not \nullptr it should be set to a string describing any
69 error which occurred.
70
71 The default implementation returns \nullptr, which causes a
72 QGeoServiceProvider::NotSupportedError in QGeoServiceProvider.
73
74 \internal
75*/
76QGeoMappingManagerEngine *
77QGeoServiceProviderFactory::createMappingManagerEngine(const QVariantMap &parameters,
78 QGeoServiceProvider::Error *error,
79 QString *errorString) const
80{
81 Q_UNUSED(parameters);
82 Q_UNUSED(error);
83 Q_UNUSED(errorString);
84
85 return nullptr;
86}
87
88/*!
89 Returns a new QGeoRoutingManagerEngine instance, initialized with \a
90 parameters, which implements routing functionality.
91
92 If \a error is not \nullptr it should be set to QGeoServiceProvider::NoError on
93 success or an appropriate QGeoServiceProvider::Error on failure.
94
95 If \a errorString is not \nullptr it should be set to a string describing any
96 error which occurred.
97
98 The default implementation returns \nullptr, which causes a
99 QGeoServiceProvider::NotSupportedError in QGeoServiceProvider.
100*/
101QGeoRoutingManagerEngine *
102QGeoServiceProviderFactory::createRoutingManagerEngine(const QVariantMap &parameters,
103 QGeoServiceProvider::Error *error,
104 QString *errorString) const
105
106{
107 Q_UNUSED(parameters);
108 Q_UNUSED(error);
109 Q_UNUSED(errorString);
110
111 return nullptr;
112}
113
114/*!
115 Returns a new QPlaceManagerEngine instance, initialized with \a
116 parameters, which implements the place searching functionality.
117
118 If \a error is not \nullptr it should be set to QGeoServiceProvider::NoError on
119 success or an appropriate QGeoServiceProvider::Error on failure.
120
121 If \a errorString is not \nullptr it should be set to a string describing any
122 error which occurred.
123
124 The default implementation returns \nullptr, which causes a
125 QGeoServiceProvider::NotSupportedError in QGeoServiceProvider.
126*/
127QPlaceManagerEngine *
128QGeoServiceProviderFactory::createPlaceManagerEngine(const QVariantMap &parameters,
129 QGeoServiceProvider::Error *error,
130 QString *errorString) const
131{
132 Q_UNUSED(parameters);
133 Q_UNUSED(error);
134 Q_UNUSED(errorString);
135
136 return nullptr;
137}
138
139/*!
140 Notify the plugin when the qml \a engine is ready. In this moment the plugins can use it
141 to register Image Providers.
142
143 The default implementation does nothing.
144 \since 5.12
145*/
146void QGeoServiceProviderFactory::setQmlEngine(QQmlEngine *engine)
147{
148 Q_UNUSED(engine);
149}
150
151QT_END_NAMESPACE