QGeoMappingManagerEngine Class

Provides support functionality for map display with QGeoServiceProvider. More...

Header: #include <QGeoMappingManagerEngine>
Inherits: QObject

Public Functions

QGeoMappingManagerEngine(QObject *parent = nullptr)
virtual ~QGeoMappingManagerEngine()
bool isInitialized() const
QLocale locale() const
QString managerName() const
int managerVersion() const
void setLocale(const QLocale &locale)

Protected Functions

void engineInitialized()
void setSupportedMapTypes(const QList<QGeoMapType> &supportedMapTypes)

Detailed Description

\inmoduleQtLocation \ingroup QtLocation-impl \since 5.6 \internal

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

The QGeoMappingManagerEngine class provides an interface and convenience methods to implementors of QGeoServiceProvider plugins who want to provide support for displaying and interacting with maps.

Member Function Documentation

[explicit] QGeoMappingManagerEngine::QGeoMappingManagerEngine(QObject *parent = nullptr)

Constructs a new engine with the specified parent.

[virtual noexcept] QGeoMappingManagerEngine::~QGeoMappingManagerEngine()

Destroys this engine.

[protected] void QGeoMappingManagerEngine::engineInitialized()

Marks the engine as initialized. Subclasses of QGeoMappingManagerEngine are to call this method after performing implementation-specific initializatioin within the constructor.

bool QGeoMappingManagerEngine::isInitialized() const

Return whether the engine has been initialized and is ready to be used.

QLocale QGeoMappingManagerEngine::locale() const

Returns the locale used to hint to this mapping manager about what language to use for map labels.

See also setLocale().

QString QGeoMappingManagerEngine::managerName() const

Returns the name which this engine implementation uses to distinguish itself from the implementations provided by other plugins.

The combination of managerName() and managerVersion() should be unique amongst plugin implementations.

int QGeoMappingManagerEngine::managerVersion() const

Returns the version of this engine implementation.

The combination of managerName() and managerVersion() should be unique amongst plugin implementations.

void QGeoMappingManagerEngine::setLocale(const QLocale &locale)

Sets the locale to be used by the this manager to locale.

If this mapping manager supports returning map labels in different languages, they will be returned in the language of locale.

The locale used defaults to the system locale if this is not set.

See also locale().

[protected] void QGeoMappingManagerEngine::setSupportedMapTypes(const QList<QGeoMapType> &supportedMapTypes)

Sets the list of map types supported by this engine to mapTypes.

Subclasses of QGeoMappingManagerEngine should use this function to ensure that supportedMapTypes() provides accurate information.