blob: d9438d74d1ee4dc7392db6020c24f8aeda728fb0 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtLocation module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later 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 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qgeoserviceproviderfactory.h"
QT_BEGIN_NAMESPACE
/*!
\class QGeoServiceProviderFactory
\inmodule QtLocation
\ingroup QtLocation-impl
\since 5.6
\deprecated
\brief The QGeoServiceProviderFactory class is a factory class used as the
plugin interface for services related to geographical information.
Implementers must provide a unique combination of providerName() and
providerVersion() per plugin.
The other functions should be overridden if the plugin supports the
associated set of functionality.
\sa QGeoServiceProviderFactoryV2
*/
/*!
\fn QGeoServiceProviderFactory::~QGeoServiceProviderFactory()
Destroys this QGeoServiceProviderFactory instance.
*/
/*!
Returns a new QGeoCodingManagerEngine instance, initialized with \a
parameters, which implements the location geocoding functionality.
If \a error is not 0 it should be set to QGeoServiceProvider::NoError on
success or an appropriate QGeoServiceProvider::Error on failure.
If \a errorString is not 0 it should be set to a string describing any
error which occurred.
The default implementation returns 0, which causes a
QGeoServiceProvider::NotSupportedError in QGeoServiceProvider.
*/
QGeoCodingManagerEngine *QGeoServiceProviderFactory::createGeocodingManagerEngine(const QVariantMap &parameters,
QGeoServiceProvider::Error *error,
QString *errorString) const
{
Q_UNUSED(parameters);
Q_UNUSED(error);
Q_UNUSED(errorString);
return 0;
}
/*!
Returns a new QGeoMappingManagerEngine instance, initialized with \a
parameters, which implements mapping functionality.
If \a error is not 0 it should be set to QGeoServiceProvider::NoError on
success or an appropriate QGeoServiceProvider::Error on failure.
If \a errorString is not 0 it should be set to a string describing any
error which occurred.
The default implementation returns 0, which causes a
QGeoServiceProvider::NotSupportedError in QGeoServiceProvider.
\internal
*/
QGeoMappingManagerEngine *QGeoServiceProviderFactory::createMappingManagerEngine(const QVariantMap &parameters,
QGeoServiceProvider::Error *error,
QString *errorString) const
{
Q_UNUSED(parameters);
Q_UNUSED(error);
Q_UNUSED(errorString);
return 0;
}
/*!
Returns a new QGeoRoutingManagerEngine instance, initialized with \a
parameters, which implements routing functionality.
If \a error is not 0 it should be set to QGeoServiceProvider::NoError on
success or an appropriate QGeoServiceProvider::Error on failure.
If \a errorString is not 0 it should be set to a string describing any
error which occurred.
The default implementation returns 0, which causes a
QGeoServiceProvider::NotSupportedError in QGeoServiceProvider.
*/
QGeoRoutingManagerEngine *QGeoServiceProviderFactory::createRoutingManagerEngine(const QVariantMap &parameters,
QGeoServiceProvider::Error *error,
QString *errorString) const
{
Q_UNUSED(parameters);
Q_UNUSED(error);
Q_UNUSED(errorString);
return 0;
}
/*!
Returns a new QPlaceManagerEngine instance, initialized with \a
parameters, which implements the place searching functionality.
If \a error is not 0 it should be set to QGeoServiceProvider::NoError on
success or an appropriate QGeoServiceProvider::Error on failure.
If \a errorString is not 0 it should be set to a string describing any
error which occurred.
The default implementation returns 0, which causes a
QGeoServiceProvider::NotSupportedError in QGeoServiceProvider.
*/
QPlaceManagerEngine *QGeoServiceProviderFactory::createPlaceManagerEngine(const QVariantMap &parameters,
QGeoServiceProvider::Error *error,
QString *errorString) const
{
Q_UNUSED(parameters);
Q_UNUSED(error);
Q_UNUSED(errorString);
return 0;
}
/*!
\class QGeoServiceProviderFactoryV2
\inmodule QtLocation
\ingroup QtLocation-impl
\since 5.11
\brief The QGeoServiceProviderFactoryV2 class is a factory class used as the
plugin interface for services related to geographical information.
Implementers must provide a unique combination of providerName() and
providerVersion() per plugin.
The other functions should be overridden if the plugin supports the
associated set of functionality.
*/
/*!
\fn QGeoServiceProviderFactoryV2::~QGeoServiceProviderFactoryV2()
Destroys this QGeoServiceProviderFactoryV2 instance.
*/
/*!
Returns a new QNavigationManagerEngine instance, initialized with \a
parameters, which implements navigation functionality.
If \a error is not nullptr, it should be set to QGeoServiceProvider::NoError on
success or an appropriate QGeoServiceProvider::Error on failure.
If \a errorString is not nullptr, it should be set to a string describing any
error which occurred.
The default implementation returns nullptr, which causes a
QGeoServiceProvider::NotSupportedError in QGeoServiceProvider.
*/
QNavigationManagerEngine *QGeoServiceProviderFactoryV2::createNavigationManagerEngine(const QVariantMap &parameters, QGeoServiceProvider::Error *error, QString *errorString) const
{
Q_UNUSED(parameters);
Q_UNUSED(error);
Q_UNUSED(errorString);
return 0;
}
/*!
Notify the plugin when the qml engine is ready. In this moment the plugins can use it
to register Image Providers.
The default implementation does nothing.
\since 5.12
*/
void QGeoServiceProviderFactoryV3::setQmlEngine(QQmlEngine *engine)
{
Q_UNUSED(engine);
}
QT_END_NAMESPACE