Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QGeoServiceProviderFactory Class Reference

\inmodule QtLocation More...

#include <qgeoserviceproviderfactory.h>

+ Inheritance diagram for QGeoServiceProviderFactory:
+ Collaboration diagram for QGeoServiceProviderFactory:

Public Member Functions

virtual ~QGeoServiceProviderFactory ()
 Destroys this QGeoServiceProviderFactory instance.
 
virtual QGeoCodingManagerEnginecreateGeocodingManagerEngine (const QVariantMap &parameters, QGeoServiceProvider::Error *error, QString *errorString) const
 Returns a new QGeoCodingManagerEngine instance, initialized with parameters, which implements the location geocoding functionality.
 
virtual QGeoMappingManagerEnginecreateMappingManagerEngine (const QVariantMap &parameters, QGeoServiceProvider::Error *error, QString *errorString) const
 Returns a new QGeoMappingManagerEngine instance, initialized with parameters, which implements mapping functionality.
 
virtual QGeoRoutingManagerEnginecreateRoutingManagerEngine (const QVariantMap &parameters, QGeoServiceProvider::Error *error, QString *errorString) const
 Returns a new QGeoRoutingManagerEngine instance, initialized with parameters, which implements routing functionality.
 
virtual QPlaceManagerEnginecreatePlaceManagerEngine (const QVariantMap &parameters, QGeoServiceProvider::Error *error, QString *errorString) const
 Returns a new QPlaceManagerEngine instance, initialized with parameters, which implements the place searching functionality.
 
virtual void setQmlEngine (QQmlEngine *engine)
 Notify the plugin when the qml engine is ready.
 

Detailed Description

\inmodule QtLocation

Since
5.6
Deprecated

The QGeoServiceProviderFactory class is a factory class used as the plugin interface for services related to geographical information.

Note
There are no source or binary compatibility guarantees for the backend classes. The API is only guaranteed to work with the Qt version it was developed against. API changes will however only be made in minor releases. (6.6, 6.7, and so on.)

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.

Definition at line 16 of file qgeoserviceproviderfactory.h.

Constructor & Destructor Documentation

◆ ~QGeoServiceProviderFactory()

QGeoServiceProviderFactory::~QGeoServiceProviderFactory ( )
inlinevirtual

Destroys this QGeoServiceProviderFactory instance.

Definition at line 19 of file qgeoserviceproviderfactory.h.

Member Function Documentation

◆ createGeocodingManagerEngine()

QGeoCodingManagerEngine * QGeoServiceProviderFactory::createGeocodingManagerEngine ( const QVariantMap & parameters,
QGeoServiceProvider::Error * error,
QString * errorString ) const
virtual

Returns a new QGeoCodingManagerEngine instance, initialized with parameters, which implements the location geocoding functionality.

If error is not \nullptr it should be set to QGeoServiceProvider::NoError on success or an appropriate QGeoServiceProvider::Error on failure.

If 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.

Reimplemented in QGeoServiceProviderFactoryNokia.

Definition at line 50 of file qgeoserviceproviderfactory.cpp.

References error, and Q_UNUSED.

Referenced by createEngine< QGeoCodingManagerEngine >().

+ Here is the caller graph for this function:

◆ createMappingManagerEngine()

QGeoMappingManagerEngine * QGeoServiceProviderFactory::createMappingManagerEngine ( const QVariantMap & parameters,
QGeoServiceProvider::Error * error,
QString * errorString ) const
virtual

Returns a new QGeoMappingManagerEngine instance, initialized with parameters, which implements mapping functionality.

If error is not \nullptr it should be set to QGeoServiceProvider::NoError on success or an appropriate QGeoServiceProvider::Error on failure.

If 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.

Reimplemented in GeoServiceProviderFactoryEsri, QGeoServiceProviderFactoryItemsOverlay, QGeoServiceProviderFactoryMapbox, QGeoServiceProviderFactoryNokia, and QGeoServiceProviderFactoryOsm.

Definition at line 77 of file qgeoserviceproviderfactory.cpp.

References error, and Q_UNUSED.

Referenced by createEngine< QGeoMappingManagerEngine >().

+ Here is the caller graph for this function:

◆ createPlaceManagerEngine()

QPlaceManagerEngine * QGeoServiceProviderFactory::createPlaceManagerEngine ( const QVariantMap & parameters,
QGeoServiceProvider::Error * error,
QString * errorString ) const
virtual

Returns a new QPlaceManagerEngine instance, initialized with parameters, which implements the place searching functionality.

If error is not \nullptr it should be set to QGeoServiceProvider::NoError on success or an appropriate QGeoServiceProvider::Error on failure.

If 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.

Reimplemented in GeoServiceProviderFactoryEsri, QGeoServiceProviderFactoryItemsOverlay, QGeoServiceProviderFactoryMapbox, QGeoServiceProviderFactoryNokia, and QGeoServiceProviderFactoryOsm.

Definition at line 128 of file qgeoserviceproviderfactory.cpp.

References error, and Q_UNUSED.

Referenced by createEngine< QPlaceManagerEngine >().

+ Here is the caller graph for this function:

◆ createRoutingManagerEngine()

QGeoRoutingManagerEngine * QGeoServiceProviderFactory::createRoutingManagerEngine ( const QVariantMap & parameters,
QGeoServiceProvider::Error * error,
QString * errorString ) const
virtual

Returns a new QGeoRoutingManagerEngine instance, initialized with parameters, which implements routing functionality.

If error is not \nullptr it should be set to QGeoServiceProvider::NoError on success or an appropriate QGeoServiceProvider::Error on failure.

If 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.

Reimplemented in GeoServiceProviderFactoryEsri, QGeoServiceProviderFactoryItemsOverlay, QGeoServiceProviderFactoryMapbox, QGeoServiceProviderFactoryNokia, and QGeoServiceProviderFactoryOsm.

Definition at line 102 of file qgeoserviceproviderfactory.cpp.

References error, and Q_UNUSED.

Referenced by createEngine< QGeoRoutingManagerEngine >().

+ Here is the caller graph for this function:

◆ setQmlEngine()

void QGeoServiceProviderFactory::setQmlEngine ( QQmlEngine * engine)
virtual

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

Definition at line 146 of file qgeoserviceproviderfactory.cpp.

References engine, and Q_UNUSED.

Referenced by QGeoServiceProviderPrivate::loadPlugin().

+ Here is the caller graph for this function:

The documentation for this class was generated from the following files: