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
QGeoMappingManager Class Reference

\inmodule QtLocation More...

#include <qgeomappingmanager_p.h>

+ Inheritance diagram for QGeoMappingManager:
+ Collaboration diagram for QGeoMappingManager:

Signals

void initialized ()
 This signal is emitted when the mapping manager has been initialized and is ready to be used.
 
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

 ~QGeoMappingManager ()
 Destroys this mapping manager.
 
QString managerName () const
 Returns the name of the engine which implements the behaviour of this mapping manager.
 
int managerVersion () const
 Returns the version of the engine which implements the behaviour of this mapping manager.
 
QGeoMapcreateMap (QObject *parent)
 Returns a new QGeoMap instance which will be managed by this manager.
 
QList< QGeoMapTypesupportedMapTypes () const
 
bool isInitialized () const
 Return whether the manager has been initialized (will be done automatically but may take some time).
 
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.
 
- 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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

 QGeoMappingManager (QGeoMappingManagerEngine *engine, QObject *parent=nullptr)
 Constructs a new manager with the specified parent and with the implementation provided by engine.
 
- Protected Member Functions inherited from QObject
QObjectsender () 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< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

\inmodule QtLocation

Since
5.6

The QGeoMappingManager class provides support for displaying and interacting with maps.

Definition at line 34 of file qgeomappingmanager_p.h.

Constructor & Destructor Documentation

◆ ~QGeoMappingManager()

QGeoMappingManager::~QGeoMappingManager ( )

Destroys this mapping manager.

Definition at line 56 of file qgeomappingmanager.cpp.

◆ QGeoMappingManager()

QGeoMappingManager::QGeoMappingManager ( QGeoMappingManagerEngine * engine,
QObject * parent = nullptr )
protected

Constructs a new manager with the specified parent and with the implementation provided by engine.

This constructor is used internally by QGeoServiceProviderFactory. Regular users should acquire instances of QGeoMappingManager with QGeoServiceProvider::mappingManager()

Definition at line 37 of file qgeomappingmanager.cpp.

References QObject::connect(), engine, QGeoMappingManagerPrivate::engine, initialized(), QGeoMappingManagerEngine::initialized(), qFatal, Qt::QueuedConnection, supportedMapTypesChanged(), and QGeoMappingManagerEngine::supportedMapTypesChanged().

+ Here is the call graph for this function:

Member Function Documentation

◆ createMap()

QGeoMap * QGeoMappingManager::createMap ( QObject * parent)

Returns a new QGeoMap instance which will be managed by this manager.

Definition at line 95 of file qgeomappingmanager.cpp.

References QGeoMappingManagerEngine::createMap(), QGeoMappingManagerPrivate::engine, QObject::parent(), and Q_UNUSED.

+ Here is the call graph for this function:

◆ initialized

void QGeoMappingManager::initialized ( )
signal

This signal is emitted when the mapping manager has been initialized and is ready to be used.

Referenced by QGeoMappingManager().

+ Here is the caller graph for this function:

◆ isInitialized()

bool QGeoMappingManager::isInitialized ( ) const

Return whether the manager has been initialized (will be done automatically but may take some time).

Definition at line 111 of file qgeomappingmanager.cpp.

References QGeoMappingManagerPrivate::engine, and QGeoMappingManagerEngine::isInitialized().

+ Here is the call graph for this function:

◆ locale()

QLocale QGeoMappingManager::locale ( ) const

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

Definition at line 133 of file qgeomappingmanager.cpp.

References QGeoMappingManagerPrivate::engine, and QGeoMappingManagerEngine::locale().

Referenced by setLocale().

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

◆ managerName()

QString QGeoMappingManager::managerName ( ) const

Returns the name of the engine which implements the behaviour of this mapping manager.

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

Definition at line 75 of file qgeomappingmanager.cpp.

References QGeoMappingManagerPrivate::engine, and QGeoMappingManagerEngine::managerName().

+ Here is the call graph for this function:

◆ managerVersion()

int QGeoMappingManager::managerVersion ( ) const

Returns the version of the engine which implements the behaviour of this mapping manager.

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

Definition at line 87 of file qgeomappingmanager.cpp.

References QGeoMappingManagerPrivate::engine, and QGeoMappingManagerEngine::managerVersion().

+ Here is the call graph for this function:

◆ setLocale()

void QGeoMappingManager::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 124 of file qgeomappingmanager.cpp.

References QGeoMappingManagerPrivate::engine, locale(), and QGeoMappingManagerEngine::setLocale().

+ Here is the call graph for this function:

◆ supportedMapTypes()

QList< QGeoMapType > QGeoMappingManager::supportedMapTypes ( ) const

Definition at line 101 of file qgeomappingmanager.cpp.

References QGeoMappingManagerPrivate::engine, and QGeoMappingManagerEngine::supportedMapTypes().

+ Here is the call graph for this function:

◆ supportedMapTypesChanged

void QGeoMappingManager::supportedMapTypesChanged ( )
signal

Referenced by QGeoMappingManager().

+ Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QGeoServiceProvider

friend class QGeoServiceProvider
friend

Definition at line 64 of file qgeomappingmanager_p.h.

◆ QGeoServiceProviderPrivate

friend class QGeoServiceProviderPrivate
friend

Definition at line 65 of file qgeomappingmanager_p.h.


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