#include <qplacemanagerenginemapbox.h>

Inheritance diagram for QPlaceManagerEngineMapbox:

Collaboration diagram for QPlaceManagerEngineMapbox:

Public Member Functions
	QPlaceManagerEngineMapbox (const QVariantMap &parameters, QGeoServiceProvider::Error , QString errorString)

	~QPlaceManagerEngineMapbox ()

QPlaceSearchReply *	search (const QPlaceSearchRequest &) override
	Searches for places according to the parameters specified in request.

QPlaceSearchSuggestionReply *	searchSuggestions (const QPlaceSearchRequest &) override
	Requests a set of search term suggestions according to the parameters specified in request.

QPlaceReply *	initializeCategories () override
	Initializes the categories of the manager engine.

QString	parentCategoryId (const QString &categoryId) const override
	Returns the parent category identifier of the category corresponding to categoryId.

QStringList	childCategoryIds (const QString &categoryId) const override
	Returns the child category identifiers of the category corresponding to categoryId.

QPlaceCategory	category (const QString &categoryId) const override
	Returns the category corresponding to the given categoryId.

QList< QPlaceCategory >	childCategories (const QString &parentId) const override
	Returns a list of categories that are children of the category corresponding to parentId.

QList< QLocale >	locales () const override
	Returns a list of preferred locales.

void	setLocales (const QList< QLocale > &locales) override
	Set the list of preferred locales.

Public Member Functions inherited from QPlaceManagerEngine
	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 QPlaceDetailsReply *	getPlaceDetails (const QString &placeId)
	Retrieves details of place corresponding to the given placeId.

virtual QPlaceContentReply *	getPlaceContent (const QPlaceContentRequest &request)
	Retrieves content for a place according to the parameters specified in request.

virtual QPlaceSearchReply *	search (const QPlaceSearchRequest &request)
	Searches for places according to the parameters specified in request.

virtual QPlaceSearchSuggestionReply *	searchSuggestions (const QPlaceSearchRequest &request)
	Requests a set of search term suggestions according to the parameters specified in request.

virtual QPlaceIdReply *	savePlace (const QPlace &place)
	Saves a specified place to the manager engine's datastore.

virtual QPlaceIdReply *	removePlace (const QString &placeId)
	Removes the place corresponding to placeId from the manager engine's datastore.

virtual QPlaceIdReply *	saveCategory (const QPlaceCategory &category, const QString &parentId)
	Saves a category that is a child of the category specified by parentId.

virtual QPlaceIdReply *	removeCategory (const QString &categoryId)
	Removes the category corresponding to categoryId from the manager engine's datastore.

virtual QPlaceReply *	initializeCategories ()
	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< QPlaceCategory >	childCategories (const QString &parentId) const
	Returns a list of categories that are children of the category corresponding to parentId.

virtual QList< QLocale >	locales () 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 QPlaceMatchReply *	matchingPlaces (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< 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.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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`.

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals inherited from QPlaceManagerEngine
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.

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 Member Functions inherited from QPlaceManagerEngine
QPlaceManager *	manager () const
	Returns the manager instance used to create this engine.

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)

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
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 14 of file qplacemanagerenginemapbox.h.

Constructor & Destructor Documentation

◆ QPlaceManagerEngineMapbox()

QPlaceManagerEngineMapbox::QPlaceManagerEngineMapbox	(	const QVariantMap &	parameters,
		QGeoServiceProvider::Error *	error,
		QString *	errorString
	)

Definition at line 58 of file qplacemanagerenginemapbox.cpp.

References QString::clear(), QMap< Key, T >::contains(), error, mapboxDefaultUserAgent, mapboxGeocodingApiPath, mapboxGeocodingEnterpriseApiPath, QGeoServiceProvider::NoError, QStringLiteral, QVariant::toBool(), QString::toLatin1(), QVariant::toString(), and QMap< Key, T >::value().

Here is the call graph for this function:

◆ ~QPlaceManagerEngineMapbox()

QPlaceManagerEngineMapbox::~QPlaceManagerEngineMapbox ( )

Definition at line 75 of file qplacemanagerenginemapbox.cpp.

Member Function Documentation

◆ category()

QPlaceCategory QPlaceManagerEngineMapbox::category ( const QString & categoryId ) const

overridevirtual

Returns the category corresponding to the given categoryId.

Reimplemented from QPlaceManagerEngine.

Definition at line 251 of file qplacemanagerenginemapbox.cpp.

References QHash< Key, T >::value().

Here is the call graph for this function:

◆ childCategories()

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

overridevirtual

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 from QPlaceManagerEngine.

Definition at line 256 of file qplacemanagerenginemapbox.cpp.

References QString::isEmpty(), and QHash< Key, T >::values().

Here is the call graph for this function:

◆ childCategoryIds()

QStringList QPlaceManagerEngineMapbox::childCategoryIds ( const QString & categoryId ) const

overridevirtual

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

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

Reimplemented from QPlaceManagerEngine.

Definition at line 242 of file qplacemanagerenginemapbox.cpp.

References QString::isEmpty(), and QHash< Key, T >::keys().

Here is the call graph for this function:

◆ initializeCategories()

QPlaceReply * QPlaceManagerEngineMapbox::initializeCategories ( )

overridevirtual

Initializes the categories of the manager engine.

Reimplemented from QPlaceManagerEngine.

Definition at line 210 of file qplacemanagerenginemapbox.cpp.

References category(), QObject::connect(), QPlaceReply::errorOccurred(), QPlaceReply::finished(), QMetaObject::invokeMethod(), QHash< Key, T >::isEmpty(), QMapboxCommon::mapboxNameForCategory(), QLocation::PublicVisibility, Qt::QueuedConnection, and reply.

Here is the call graph for this function:

◆ locales()

QList< QLocale > QPlaceManagerEngineMapbox::locales ( ) const

overridevirtual

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 from QPlaceManagerEngine.

Definition at line 265 of file qplacemanagerenginemapbox.cpp.

Referenced by setLocales().

Here is the caller graph for this function:

◆ parentCategoryId()

QString QPlaceManagerEngineMapbox::parentCategoryId ( const QString & categoryId ) const

overridevirtual

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

Reimplemented from QPlaceManagerEngine.

Definition at line 234 of file qplacemanagerenginemapbox.cpp.

References Q_UNUSED.

◆ search()

QPlaceSearchReply * QPlaceManagerEngineMapbox::search ( const QPlaceSearchRequest & request )

overridevirtual

Searches for places according to the parameters specified in request.

Reimplemented from QPlaceManagerEngine.

Definition at line 79 of file qplacemanagerenginemapbox.cpp.

References request.

◆ searchSuggestions()

QPlaceSearchSuggestionReply * QPlaceManagerEngineMapbox::searchSuggestions ( const QPlaceSearchRequest & request )

overridevirtual

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

Reimplemented from QPlaceManagerEngine.

Definition at line 84 of file qplacemanagerenginemapbox.cpp.

References request.

◆ setLocales()

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

overridevirtual

Set the list of preferred locales.

Reimplemented from QPlaceManagerEngine.

Definition at line 270 of file qplacemanagerenginemapbox.cpp.

References locales().

Here is the call graph for this function:

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

qtlocation/src/plugins/geoservices/mapbox/qplacemanagerenginemapbox.h
qtlocation/src/plugins/geoservices/mapbox/qplacemanagerenginemapbox.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QPlaceManagerEngineMapbox()

◆ ~QPlaceManagerEngineMapbox()

Member Function Documentation

◆ category()

◆ childCategories()

◆ childCategoryIds()

◆ initializeCategories()

◆ locales()

◆ parentCategoryId()

◆ search()

◆ searchSuggestions()

◆ setLocales()