Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QPlaceManagerEngine Class Reference

\inmodule QtLocation More...

#include <qplacemanagerengine.h>

+ Inheritance diagram for QPlaceManagerEngine:
+ Collaboration diagram for QPlaceManagerEngine:

Signals

void finished (QPlaceReply *reply)
 This signal is emitted when reply has finished processing.
 
void errorOccurred (QPlaceReply *, QPlaceReply::Error error, const QString &errorString=QString())
 This signal is emitted when an error has been detected in the processing of reply.
 
void placeAdded (const QString &placeId)
 This signal is emitted if a place has been added to the manager engine's datastore.
 
void placeUpdated (const QString &placeId)
 This signal is emitted if a place has been modified in the manager engine's datastore.
 
void placeRemoved (const QString &placeId)
 This signal is emitted if a place has been removed from the manager engine's datastore.
 
void categoryAdded (const QPlaceCategory &category, const QString &parentCategoryId)
 This signal is emitted if a category has been added to the manager engine's datastore.
 
void categoryUpdated (const QPlaceCategory &category, const QString &parentCategoryId)
 This signal is emitted if a category has been modified in the manager engine's datastore.
 
void categoryRemoved (const QString &categoryId, const QString &parentCategoryId)
 This signal is emitted when the category corresponding to categoryId has been removed from the manager engine's datastore.
 
void dataChanged ()
 This signal is emitted by the engine if there are large scale changes to its underlying datastore and the engine considers these changes radical enough to require clients to reload all data.
 
- 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

 QPlaceManagerEngine (const QVariantMap &parameters, QObject *parent=nullptr)
 Constructs a new engine with the specified parent, using parameters to pass any implementation specific data to the engine.
 
virtual ~QPlaceManagerEngine ()
 Destroys this engine.
 
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.
 
virtual QPlaceDetailsReplygetPlaceDetails (const QString &placeId)
 Retrieves details of place corresponding to the given placeId.
 
virtual QPlaceContentReplygetPlaceContent (const QPlaceContentRequest &request)
 Retrieves content for a place according to the parameters specified in request.
 
virtual QPlaceSearchReplysearch (const QPlaceSearchRequest &request)
 Searches for places according to the parameters specified in request.
 
virtual QPlaceSearchSuggestionReplysearchSuggestions (const QPlaceSearchRequest &request)
 Requests a set of search term suggestions according to the parameters specified in request.
 
virtual QPlaceIdReplysavePlace (const QPlace &place)
 Saves a specified place to the manager engine's datastore.
 
virtual QPlaceIdReplyremovePlace (const QString &placeId)
 Removes the place corresponding to placeId from the manager engine's datastore.
 
virtual QPlaceIdReplysaveCategory (const QPlaceCategory &category, const QString &parentId)
 Saves a category that is a child of the category specified by parentId.
 
virtual QPlaceIdReplyremoveCategory (const QString &categoryId)
 Removes the category corresponding to categoryId from the manager engine's datastore.
 
virtual QPlaceReplyinitializeCategories ()
 Initializes the categories of the manager engine.
 
virtual QString parentCategoryId (const QString &categoryId) const
 Returns the parent category identifier of the category corresponding to categoryId.
 
virtual QStringList childCategoryIds (const QString &categoryId) const
 Returns the child category identifiers of the category corresponding to categoryId.
 
virtual QPlaceCategory category (const QString &categoryId) const
 Returns the category corresponding to the given categoryId.
 
virtual QList< QPlaceCategorychildCategories (const QString &parentId) const
 Returns a list of categories that are children of the category corresponding to parentId.
 
virtual QList< QLocalelocales () const
 Returns a list of preferred locales.
 
virtual void setLocales (const QList< QLocale > &locales)
 Set the list of preferred locales.
 
virtual QUrl constructIconUrl (const QPlaceIcon &icon, const QSize &size) const
 QUrl QPlaceManagerEngine::constructIconUrl(const QPlaceIcon &icon, const QSize &size)
 
virtual QPlace compatiblePlace (const QPlace &original) const
 Returns a pruned or modified version of the original place which is suitable to be saved by the manager engine.
 
virtual QPlaceMatchReplymatchingPlaces (const QPlaceMatchRequest &request)
 Returns a reply which contains a list of places which correspond/match those specified in request.
 
- 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

QPlaceManagermanager () const
 Returns the manager instance used to create this 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 QGeoServiceProviderPrivate
 
class QPlaceManager
 

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 QPlaceManagerEngine class provides an interface for implementers of QGeoServiceProvider plugins who want to provide access to place functionality.

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

Application developers need not concern themselves with the QPlaceManagerEngine. Backend implementers however will need to derive from QPlaceManagerEngine and provide implementations for the abstract virtual functions.

For more information on writing a backend see the \l {Places Backend} documentation.

See also
QPlaceManager

Definition at line 18 of file qplacemanagerengine.h.

Constructor & Destructor Documentation

◆ QPlaceManagerEngine()

QPlaceManagerEngine::QPlaceManagerEngine ( const QVariantMap & parameters,
QObject * parent = nullptr )
explicit

Constructs a new engine with the specified parent, using parameters to pass any implementation specific data to the engine.

Definition at line 50 of file qplacemanagerengine.cpp.

◆ ~QPlaceManagerEngine()

QPlaceManagerEngine::~QPlaceManagerEngine ( )
virtual

Destroys this engine.

Definition at line 62 of file qplacemanagerengine.cpp.

Member Function Documentation

◆ category()

QPlaceCategory QPlaceManagerEngine::category ( const QString & categoryId) const
virtual

Returns the category corresponding to the given categoryId.

Reimplemented in PlaceManagerEngineEsri, QPlaceManagerEngineMapbox, QPlaceManagerEngineNokiaV2, and QPlaceManagerEngineOsm.

Definition at line 238 of file qplacemanagerengine.cpp.

◆ categoryAdded

void QPlaceManagerEngine::categoryAdded ( const QPlaceCategory & category,
const QString & parentId )
signal

This signal is emitted if a category has been added to the manager engine's datastore.

The parent of the category is specified by parentId.

This signal is only emitted by manager engines that support the QPlaceManager::NotificationsFeature.

See also
dataChanged()

◆ categoryRemoved

void QPlaceManagerEngine::categoryRemoved ( const QString & categoryId,
const QString & parentId )
signal

This signal is emitted when the category corresponding to categoryId has been removed from the manager engine's datastore.

The parent of the removed category is specified by parentId.

This signal is only emitted by manager engines that support the QPlaceManager::NotificationsFeature.

See also
dataChanged()

◆ categoryUpdated

void QPlaceManagerEngine::categoryUpdated ( const QPlaceCategory & category,
const QString & parentId )
signal

This signal is emitted if a category has been modified in the manager engine's datastore.

The parent of the modified category is specified by parentId.

This signal is only emitted by manager engines that support the QPlaceManager::NotificationsFeature.

See also
dataChanged()

◆ childCategories()

QList< QPlaceCategory > QPlaceManagerEngine::childCategories ( const QString & parentId) const
virtual

Returns a list of categories that are children of the category corresponding to parentId.

If parentId is empty, all the top level categories are returned.

Reimplemented in PlaceManagerEngineEsri, QPlaceManagerEngineMapbox, QPlaceManagerEngineNokiaV2, and QPlaceManagerEngineOsm.

Definition at line 249 of file qplacemanagerengine.cpp.

◆ childCategoryIds()

QStringList QPlaceManagerEngine::childCategoryIds ( const QString & categoryId) const
virtual

Returns the child category identifiers of the category corresponding to categoryId.

If categoryId is empty then all top level category identifiers are returned.

Reimplemented in PlaceManagerEngineEsri, QPlaceManagerEngineMapbox, QPlaceManagerEngineNokiaV2, and QPlaceManagerEngineOsm.

Definition at line 228 of file qplacemanagerengine.cpp.

◆ compatiblePlace()

QPlace QPlaceManagerEngine::compatiblePlace ( const QPlace & original) const
virtual

Returns a pruned or modified version of the original place which is suitable to be saved by the manager engine.

Only place details that are supported by this manager is present in the modified version. Manager specific data such as the place id, is not copied over from the original.

Definition at line 297 of file qplacemanagerengine.cpp.

◆ constructIconUrl()

QUrl QPlaceManagerEngine::constructIconUrl ( const QPlaceIcon & icon,
const QSize & size ) const
virtual

QUrl QPlaceManagerEngine::constructIconUrl(const QPlaceIcon &icon, const QSize &size)

Constructs an icon url from a given icon, size. The URL of the icon image that most closely matches the given parameters is returned.

Reimplemented in QPlaceManagerEngineNokiaV2.

Definition at line 320 of file qplacemanagerengine.cpp.

◆ dataChanged

void QPlaceManagerEngine::dataChanged ( )
signal

This signal is emitted by the engine if there are large scale changes to its underlying datastore and the engine considers these changes radical enough to require clients to reload all data.

If the signal is emitted, no other signals will be emitted for the associated changes.

◆ errorOccurred

void QPlaceManagerEngine::errorOccurred ( QPlaceReply * reply,
QPlaceReply::Error error,
const QString & errorString = QString() )
signal

This signal is emitted when an error has been detected in the processing of reply.

The QPlaceManager::finished() signal will probably follow.

The error will be described by the error code error. If errorString is not empty it will contain a textual description of the error meant for developers and not end users.

This signal and QPlaceReply::errorOccurred() will be emitted at the same time.

Note
Do not delete the reply object in the slot connected to this signal. Use deleteLater() instead.

◆ finished

void QPlaceManagerEngine::finished ( QPlaceReply * reply)
signal

This signal is emitted when reply has finished processing.

If reply->error() equals QPlaceReply::NoError then the processing finished successfully.

This signal and QPlaceReply::finished() will be emitted at the same time.

Note
Do not delete the reply object in the slot connected to this signal. Use deleteLater() instead.

◆ getPlaceContent()

QPlaceContentReply * QPlaceManagerEngine::getPlaceContent ( const QPlaceContentRequest & request)
virtual

Retrieves content for a place according to the parameters specified in request.

Reimplemented in QPlaceManagerEngineNokiaV2.

Definition at line 129 of file qplacemanagerengine.cpp.

◆ getPlaceDetails()

QPlaceDetailsReply * QPlaceManagerEngine::getPlaceDetails ( const QString & placeId)
virtual

Retrieves details of place corresponding to the given placeId.

Reimplemented in QPlaceManagerEngineNokiaV2.

Definition at line 119 of file qplacemanagerengine.cpp.

◆ initializeCategories()

QPlaceReply * QPlaceManagerEngine::initializeCategories ( )
virtual

Initializes the categories of the manager engine.

Reimplemented in PlaceManagerEngineEsri, QPlaceManagerEngineMapbox, QPlaceManagerEngineNokiaV2, and QPlaceManagerEngineOsm.

Definition at line 209 of file qplacemanagerengine.cpp.

◆ locales()

QList< QLocale > QPlaceManagerEngine::locales ( ) const
virtual

Returns a list of preferred locales.

The locales are used as a hint to the manager engine for what language place and category details should be returned in.

If the first specified locale cannot be accommodated, the manager engine falls back to the next and so forth.

Support for locales may vary from provider to provider. For those that do support it, by default, the \l {QLocale::setDefault()}{global default locale} will be used. If the manager engine has no locales assigned to it, it implicitly uses the global default locale. For engines that do not support locales, the locale list is always empty.

Reimplemented in PlaceManagerEngineEsri, QPlaceManagerEngineMapbox, QPlaceManagerEngineNokiaV2, and QPlaceManagerEngineOsm.

Definition at line 268 of file qplacemanagerengine.cpp.

◆ manager()

QPlaceManager * QPlaceManagerEngine::manager ( ) const
protected

Returns the manager instance used to create this engine.

Definition at line 284 of file qplacemanagerengine.cpp.

◆ managerName()

QString QPlaceManagerEngine::managerName ( ) const

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

The manager name is automatically set to be the same as the QGeoServiceProviderFactory::providerName().

Definition at line 88 of file qplacemanagerengine.cpp.

◆ managerVersion()

int QPlaceManagerEngine::managerVersion ( ) const

Returns the version of this engine implementation.

The manager version is automatically set to be the same as the QGeoServiceProviderFactory::providerVersion().

Definition at line 111 of file qplacemanagerengine.cpp.

◆ matchingPlaces()

QPlaceMatchReply * QPlaceManagerEngine::matchingPlaces ( const QPlaceMatchRequest & request)
virtual

Returns a reply which contains a list of places which correspond/match those specified in request.

Definition at line 307 of file qplacemanagerengine.cpp.

◆ parentCategoryId()

QString QPlaceManagerEngine::parentCategoryId ( const QString & categoryId) const
virtual

Returns the parent category identifier of the category corresponding to categoryId.

Reimplemented in PlaceManagerEngineEsri, QPlaceManagerEngineMapbox, QPlaceManagerEngineNokiaV2, and QPlaceManagerEngineOsm.

Definition at line 217 of file qplacemanagerengine.cpp.

◆ placeAdded

void QPlaceManagerEngine::placeAdded ( const QString & placeId)
signal

This signal is emitted if a place has been added to the manager engine's datastore.

The particular added place is specified by placeId.

This signal is only emitted by manager engines that support the QPlaceManager::NotificationsFeature.

See also
dataChanged()

◆ placeRemoved

void QPlaceManagerEngine::placeRemoved ( const QString & placeId)
signal

This signal is emitted if a place has been removed from the manager engine's datastore.

The particular place that has been removed is specified by placeId.

This signal is only emitted by manager engines that support the QPlaceManager::NotificationsFeature.

See also
dataChanged()

◆ placeUpdated

void QPlaceManagerEngine::placeUpdated ( const QString & placeId)
signal

This signal is emitted if a place has been modified in the manager engine's datastore.

The particular modified place is specified by placeId.

This signal is only emitted by manager engines that support the QPlaceManager::NotificationsFeature.

See also
dataChanged()

◆ removeCategory()

QPlaceIdReply * QPlaceManagerEngine::removeCategory ( const QString & categoryId)
virtual

Removes the category corresponding to categoryId from the manager engine's datastore.

Definition at line 198 of file qplacemanagerengine.cpp.

◆ removePlace()

QPlaceIdReply * QPlaceManagerEngine::removePlace ( const QString & placeId)
virtual

Removes the place corresponding to placeId from the manager engine's datastore.

Definition at line 172 of file qplacemanagerengine.cpp.

◆ saveCategory()

QPlaceIdReply * QPlaceManagerEngine::saveCategory ( const QPlaceCategory & category,
const QString & parentId )
virtual

Saves a category that is a child of the category specified by parentId.

An empty parentId means category is saved as a top level category.

Definition at line 184 of file qplacemanagerengine.cpp.

◆ savePlace()

QPlaceIdReply * QPlaceManagerEngine::savePlace ( const QPlace & place)
virtual

Saves a specified place to the manager engine's datastore.

Definition at line 161 of file qplacemanagerengine.cpp.

◆ search()

QPlaceSearchReply * QPlaceManagerEngine::search ( const QPlaceSearchRequest & request)
virtual

Searches for places according to the parameters specified in request.

Reimplemented in PlaceManagerEngineEsri, QPlaceManagerEngineMapbox, QPlaceManagerEngineNokiaV2, and QPlaceManagerEngineOsm.

Definition at line 139 of file qplacemanagerengine.cpp.

◆ searchSuggestions()

QPlaceSearchSuggestionReply * QPlaceManagerEngine::searchSuggestions ( const QPlaceSearchRequest & request)
virtual

Requests a set of search term suggestions according to the parameters specified in request.

Reimplemented in QPlaceManagerEngineMapbox, and QPlaceManagerEngineNokiaV2.

Definition at line 150 of file qplacemanagerengine.cpp.

◆ setLocales()

void QPlaceManagerEngine::setLocales ( const QList< QLocale > & locales)
virtual

Set the list of preferred locales.

Reimplemented in PlaceManagerEngineEsri, QPlaceManagerEngineMapbox, QPlaceManagerEngineNokiaV2, and QPlaceManagerEngineOsm.

Definition at line 276 of file qplacemanagerengine.cpp.

Friends And Related Symbol Documentation

◆ QGeoServiceProviderPrivate

friend class QGeoServiceProviderPrivate
friend

Definition at line 83 of file qplacemanagerengine.h.

◆ QPlaceManager

friend class QPlaceManager
friend

Definition at line 84 of file qplacemanagerengine.h.


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