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
Signals | Public Member Functions | Protected Member Functions | Friends | List of all members
QGeoMappingManagerEngine Class Referenceabstract

\inmodule QtLocation More...

#include <qgeomappingmanagerengine_p.h>

+ Inheritance diagram for QGeoMappingManagerEngine:
+ Collaboration diagram for QGeoMappingManagerEngine:

Signals

void initialized ()
 
void supportedMapTypesChanged ()
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QGeoMappingManagerEngine (QObject *parent=nullptr)
 Constructs a new engine with the specified parent.
 
virtual ~QGeoMappingManagerEngine ()
 Destroys this engine.
 
virtual QGeoMap * createMap ()=0
 
QVariantMap parameters () const
 
QString managerName () const
 Returns the name which this engine implementation uses to distinguish itself from the implementations provided by other plugins.
 
int managerVersion () const
 Returns the version of this engine implementation.
 
QList< QGeoMapType > supportedMapTypes () const
 
QGeoCameraCapabilities cameraCapabilities (int mapId=0) const
 
void setLocale (const QLocale &locale)
 Sets the locale to be used by the this manager to locale.
 
QLocale locale () const
 Returns the locale used to hint to this mapping manager about what language to use for map labels.
 
bool isInitialized () const
 Return whether the engine has been initialized and is ready to be used.
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QString > bindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThread * thread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectList & children () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Protected Member Functions

void setSupportedMapTypes (const QList< QGeoMapType > &supportedMapTypes)
 Sets the list of map types supported by this engine to mapTypes.
 
void setCameraCapabilities (const QGeoCameraCapabilities &capabilities)
 
void engineInitialized ()
 Marks the engine as initialized.
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Friends

class QGeoServiceProvider
 
class QGeoServiceProviderPrivate
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

\inmodule QtLocation

Since
5.6

Provides support functionality for map display with QGeoServiceProvider.

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.

Definition at line 37 of file qgeomappingmanagerengine_p.h.

Constructor & Destructor Documentation

◆ QGeoMappingManagerEngine()

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

Constructs a new engine with the specified parent.

Definition at line 35 of file qgeomappingmanagerengine.cpp.

◆ ~QGeoMappingManagerEngine()

QGeoMappingManagerEngine::~QGeoMappingManagerEngine ( )
virtual

Destroys this engine.

Definition at line 42 of file qgeomappingmanagerengine.cpp.

References d.

Member Function Documentation

◆ cameraCapabilities()

QGeoCameraCapabilities QGeoMappingManagerEngine::cameraCapabilities ( int mapId = 0) const

Definition at line 125 of file qgeomappingmanagerengine.cpp.

References QList< T >::at(), QGeoMapType::cameraCapabilities, d, Q_UNUSED, and supportedMapTypes().

Referenced by QGeoMapPrivate::QGeoMapPrivate().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ createMap()

virtual QGeoMap * QGeoMappingManagerEngine::createMap ( )
pure virtual

Implemented in QGeoTiledMappingManagerEngine, GeoTiledMappingManagerEngineEsri, QGeoMappingManagerEngineItemsOverlay, QGeoTiledMappingManagerEngineMapbox, QGeoMappingManagerEngineMapboxGL, QGeoTiledMappingManagerEngineNokia, and QGeoTiledMappingManagerEngineOsm.

Referenced by QGeoMappingManager::createMap().

+ Here is the caller graph for this function:

◆ engineInitialized()

void QGeoMappingManagerEngine::engineInitialized ( )
protected

Marks the engine as initialized.

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

Definition at line 53 of file qgeomappingmanagerengine.cpp.

References d, emit, and initialized().

Referenced by QGeoMappingManagerEngineItemsOverlay::QGeoMappingManagerEngineItemsOverlay(), QGeoMappingManagerEngineMapboxGL::QGeoMappingManagerEngineMapboxGL(), and QGeoTiledMappingManagerEngine::setTileFetcher().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initialized

void QGeoMappingManagerEngine::initialized ( )
signal

Referenced by QGeoMappingManager::QGeoMappingManager(), and engineInitialized().

+ Here is the caller graph for this function:

◆ isInitialized()

bool QGeoMappingManagerEngine::isInitialized ( ) const

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

Definition at line 148 of file qgeomappingmanagerengine.cpp.

References d.

Referenced by QGeoMappingManager::isInitialized().

+ Here is the caller graph for this function:

◆ locale()

QLocale QGeoMappingManagerEngine::locale ( ) const

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

Definition at line 171 of file qgeomappingmanagerengine.cpp.

References QGeoMappingManagerEnginePrivate::locale.

Referenced by QGeoMappingManager::locale(), and setLocale().

+ Here is the caller graph for this function:

◆ managerName()

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.

Definition at line 79 of file qgeomappingmanagerengine.cpp.

References QGeoMappingManagerEnginePrivate::managerName.

Referenced by QGeoMappingManager::managerName(), and QGeoTiledMappingManagerEngine::tileCache().

+ Here is the caller graph for this function:

◆ managerVersion()

int QGeoMappingManagerEngine::managerVersion ( ) const

Returns the version of this engine implementation.

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

Definition at line 101 of file qgeomappingmanagerengine.cpp.

References QGeoMappingManagerEnginePrivate::managerVersion.

Referenced by QGeoMappingManager::managerVersion().

+ Here is the caller graph for this function:

◆ parameters()

QVariantMap QGeoMappingManagerEngine::parameters ( ) const

Referenced by GeoTiledMappingManagerEngineEsri::GeoTiledMappingManagerEngineEsri(), QGeoMappingManagerEngineItemsOverlay::QGeoMappingManagerEngineItemsOverlay(), QGeoMappingManagerEngineMapboxGL::QGeoMappingManagerEngineMapboxGL(), QGeoTiledMappingManagerEngineMapbox::QGeoTiledMappingManagerEngineMapbox(), QGeoTiledMappingManagerEngineNokia::QGeoTiledMappingManagerEngineNokia(), and QGeoTiledMappingManagerEngineOsm::QGeoTiledMappingManagerEngineOsm().

+ Here is the caller graph for this function:

◆ setCameraCapabilities()

void QGeoMappingManagerEngine::setCameraCapabilities ( const QGeoCameraCapabilities & capabilities)
protected

Definition at line 138 of file qgeomappingmanagerengine.cpp.

References d.

Referenced by GeoTiledMappingManagerEngineEsri::GeoTiledMappingManagerEngineEsri(), QGeoMappingManagerEngineItemsOverlay::QGeoMappingManagerEngineItemsOverlay(), QGeoMappingManagerEngineMapboxGL::QGeoMappingManagerEngineMapboxGL(), QGeoTiledMappingManagerEngineMapbox::QGeoTiledMappingManagerEngineMapbox(), QGeoTiledMappingManagerEngineNokia::QGeoTiledMappingManagerEngineNokia(), and QGeoTiledMappingManagerEngineOsm::QGeoTiledMappingManagerEngineOsm().

+ Here is the caller graph for this function:

◆ setLocale()

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.

Definition at line 162 of file qgeomappingmanagerengine.cpp.

References locale(), and QGeoMappingManagerEnginePrivate::locale.

Referenced by QGeoMappingManager::setLocale().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setSupportedMapTypes()

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

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.

Definition at line 118 of file qgeomappingmanagerengine.cpp.

References d, emit, supportedMapTypes(), and supportedMapTypesChanged().

Referenced by GeoTiledMappingManagerEngineEsri::GeoTiledMappingManagerEngineEsri(), QGeoMappingManagerEngineItemsOverlay::QGeoMappingManagerEngineItemsOverlay(), QGeoMappingManagerEngineMapboxGL::QGeoMappingManagerEngineMapboxGL(), QGeoTiledMappingManagerEngineMapbox::QGeoTiledMappingManagerEngineMapbox(), QGeoTiledMappingManagerEngineNokia::QGeoTiledMappingManagerEngineNokia(), and QGeoTiledMappingManagerEngineOsm::updateMapTypes().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ supportedMapTypes()

QList< QGeoMapType > QGeoMappingManagerEngine::supportedMapTypes ( ) const

Definition at line 106 of file qgeomappingmanagerengine.cpp.

References d.

Referenced by cameraCapabilities(), setSupportedMapTypes(), QGeoMappingManager::supportedMapTypes(), and QGeoTiledMappingManagerEngineOsm::updateMapTypes().

+ Here is the caller graph for this function:

◆ supportedMapTypesChanged

void QGeoMappingManagerEngine::supportedMapTypesChanged ( )
signal

Referenced by QGeoMappingManager::QGeoMappingManager(), and setSupportedMapTypes().

+ Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QGeoServiceProvider

friend class QGeoServiceProvider
friend

Definition at line 81 of file qgeomappingmanagerengine_p.h.

◆ QGeoServiceProviderPrivate

friend class QGeoServiceProviderPrivate
friend

Definition at line 82 of file qgeomappingmanagerengine_p.h.

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