\inmodule QtLocation More...

#include <qplacemanager.h>

Inheritance diagram for QPlaceManager:

Collaboration diagram for QPlaceManager:

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's datastore.

void	placeRemoved (const QString &placeId)
	This signal is emitted if a place has been removed from the manager's datastore.

void	categoryAdded (const QPlaceCategory &category, const QString &parentId)
	This signal is emitted if a category has been added to the manager's datastore.

void	categoryUpdated (const QPlaceCategory &category, const QString &parentId)
	This signal is emitted if a category has been modified in the manager's datastore.

void	categoryRemoved (const QString &categoryId, const QString &parentId)
	This signal is emitted when the category corresponding to categoryId has been removed from the manager's datastore.

void	dataChanged ()
	This signal is emitted by the manager if there are large scale changes to its underlying datastore and the manager 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
	~QPlaceManager ()
	Destroys the manager.

QString	managerName () const
	Returns the name of the manager.

int	managerVersion () const
	Returns the manager version.

QPlaceDetailsReply *	getPlaceDetails (const QString &placeId) const
	Retrieves a details of place corresponding to the given placeId.

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

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

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

QPlaceIdReply *	savePlace (const QPlace &place)
	Saves a specified place.

QPlaceIdReply *	removePlace (const QString &placeId)
	Removes the place corresponding to placeId from the manager.

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

QPlaceIdReply *	removeCategory (const QString &categoryId)
	Removes the category corresponding to categoryId from the manager.

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

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

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

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

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

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

void	setLocale (const QLocale &locale)
	Convenience function which sets the manager's list of preferred locales to a single locale.

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

QPlace	compatiblePlace (const QPlace &place) const
	Returns a pruned or modified version of the original place which is suitable to be saved into this manager.

QPlaceMatchReply *	matchingPlaces (const QPlaceMatchRequest &request) const
	Returns a reply which contains a list of places which correspond/match those specified in the 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.

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

Friends
class	QGeoServiceProvider

class	QGeoServiceProviderPrivate

class	QPlaceIcon

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

\inmodule QtLocation

Since: 5.6

The QPlaceManager class provides the interface which allows clients to access places stored in a particular backend.

The following table gives an overview of the functionality provided by the QPlaceManager \table \header

Functionality
Description \row
Searching for places
Using set of parameters such as a search term and search area, relevant places can be returned to the user. \row
Categories
Places can be classified as belonging to different categories. The manager supports access to these categories. \row
Search term suggestions
Given a partially complete search term, a list of potential search terms can be given. \row
Recommendations
Given an existing place, a set of similar recommended places can be suggested to the user. \row
Rich Content
Rich content such as images, reviews etc can be retrieved in a paged fashion. \row
Place or Category management
Places and categories may be saved and removed. It is possible for notifications to be given when this happens. \row
Localization
Different locales may be specified to return place data in different languages. \endtable

Definition at line 31 of file qplacemanager.h.

Constructor & Destructor Documentation

◆ ~QPlaceManager()

QPlaceManager::~QPlaceManager ( )

Destroys the manager.

This destructor is used internally by QGeoServiceProvider and should never need to be called in application code.

Definition at line 159 of file qplacemanager.cpp.

Member Function Documentation

◆ category()

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

Returns the category corresponding to the given categoryId.

Definition at line 293 of file qplacemanager.cpp.

◆ categoryAdded

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

signal

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

The parent of the category is specified by parentId.

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

See also: dataChanged()

◆ categoryRemoved

void QPlaceManager::categoryRemoved	(	const QString &	categoryId,
		const QString &	parentId )

signal

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

The parent of the removed category is specified by parentId.

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

See also: dataChanged()

◆ categoryUpdated

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

signal

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

The parent of the modified category is specified by parentId.

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

See also: dataChanged()

◆ childCategories()

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

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.

Definition at line 302 of file qplacemanager.cpp.

◆ childCategoryIds()

QStringList QPlaceManager::childCategoryIds ( const QString & parentId = QString() ) const

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

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

Definition at line 285 of file qplacemanager.cpp.

◆ compatiblePlace()

QPlace QPlaceManager::compatiblePlace ( const QPlace & original ) const

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

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 357 of file qplacemanager.cpp.

◆ dataChanged

void QPlaceManager::dataChanged ( )

signal

This signal is emitted by the manager if there are large scale changes to its underlying datastore and the manager 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.

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

◆ errorOccurred

void QPlaceManager::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 QPlaceManager::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 * QPlaceManager::getPlaceContent ( const QPlaceContentRequest & request ) const

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

See \l {Fetching Rich Content} for an example of usage.

Definition at line 195 of file qplacemanager.cpp.

◆ getPlaceDetails()

QPlaceDetailsReply * QPlaceManager::getPlaceDetails ( const QString & placeId ) const

Retrieves a details of place corresponding to the given placeId.

See \l {QML Places API#Fetching Place Details}{Fetching Place Details} for an example of usage.

Definition at line 185 of file qplacemanager.cpp.

◆ initializeCategories()

QPlaceReply * QPlaceManager::initializeCategories ( )

Initializes the categories of the manager.

See \l {Using Categories} for an example of usage.

Definition at line 268 of file qplacemanager.cpp.

◆ locales()

QList< QLocale > QPlaceManager::locales ( ) const

Returns a list of preferred locales.

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

If the first specified locale cannot be accommodated, the manager falls back to the next and so forth. Some manager backends may not support a set of locales which are rigidly defined. An arbitrary example is that some places in France could have French and English localizations, while certain areas in America may only have the English localization available. In this example, the set of supported locales is context dependent on the search location.

If the manager cannot accommodate any of the preferred locales, the manager falls back to using a supported language that is backend specific.

Support for locales may vary from provider to provider. For those that do support it, by default, the global default locale is set as the manager's only locale.

For managers that do not support locales, the locale list is always empty.

Definition at line 325 of file qplacemanager.cpp.

◆ managerName()

QString QPlaceManager::managerName ( ) const

Returns the name of the manager.

Definition at line 167 of file qplacemanager.cpp.

◆ managerVersion()

int QPlaceManager::managerVersion ( ) const

Returns the manager version.

Definition at line 175 of file qplacemanager.cpp.

◆ matchingPlaces()

QPlaceMatchReply * QPlaceManager::matchingPlaces ( const QPlaceMatchRequest & request ) const

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

The places specified in the request come from a different manager.

Definition at line 367 of file qplacemanager.cpp.

◆ parentCategoryId()

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

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

Definition at line 276 of file qplacemanager.cpp.

◆ placeAdded

void QPlaceManager::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 managers that support the QPlaceManager::NotificationsFeature.

See also: dataChanged()

◆ placeRemoved

void QPlaceManager::placeRemoved ( const QString & placeId )

signal

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

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

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

See also: dataChanged()

◆ placeUpdated

void QPlaceManager::placeUpdated ( const QString & placeId )

signal

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

The particular modified place is specified by placeId.

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

See also: dataChanged()

◆ removeCategory()

QPlaceIdReply * QPlaceManager::removeCategory ( const QString & categoryId )

Removes the category corresponding to categoryId from the manager.

See \l {Removing a category} for an example of usage.

Definition at line 258 of file qplacemanager.cpp.

◆ removePlace()

QPlaceIdReply * QPlaceManager::removePlace ( const QString & placeId )

Removes the place corresponding to placeId from the manager.

See \l {Removing a place cpp} for an example of usage.

Definition at line 237 of file qplacemanager.cpp.

◆ saveCategory()

QPlaceIdReply * QPlaceManager::saveCategory	(	const QPlaceCategory &	category,
		const QString &	parentId = QString() )

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.

See \l {Saving a category} for an example of usage.

Definition at line 248 of file qplacemanager.cpp.

◆ savePlace()

QPlaceIdReply * QPlaceManager::savePlace ( const QPlace & place )

Saves a specified place.

See \l {Saving a place cpp} for an example of usage.

Definition at line 227 of file qplacemanager.cpp.

◆ search()

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

Searches for places according to the parameters specified in request.

See \l {Discovery/Search} for an example of usage.

Definition at line 205 of file qplacemanager.cpp.

◆ searchSuggestions()

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

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

The request can hold the incomplete search term, along with other data such as a search area to narrow down relevant results.

See \l {Search Suggestions} for an example of usage.

Definition at line 217 of file qplacemanager.cpp.

◆ setLocale()

void QPlaceManager::setLocale ( const QLocale & locale )

Convenience function which sets the manager's list of preferred locales to a single locale.

Definition at line 334 of file qplacemanager.cpp.

◆ setLocales()

void QPlaceManager::setLocales ( const QList< QLocale > & locale )

Set the list of preferred locales.

Definition at line 344 of file qplacemanager.cpp.

Friends And Related Symbol Documentation

◆ QGeoServiceProvider

friend class QGeoServiceProvider

friend

Definition at line 89 of file qplacemanager.h.

◆ QGeoServiceProviderPrivate

friend class QGeoServiceProviderPrivate

friend

Definition at line 90 of file qplacemanager.h.

◆ QPlaceIcon

friend class QPlaceIcon

friend

Definition at line 91 of file qplacemanager.h.

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

qtlocation/src/location/places/qplacemanager.h (cd4db512ae08836f5fa1d746000052215cf70a9c)
qtlocation/src/location/places/qplacemanager.cpp (cd4db512ae08836f5fa1d746000052215cf70a9c)

Signals

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~QPlaceManager()

Member Function Documentation

◆ category()

◆ categoryAdded

◆ categoryRemoved

◆ categoryUpdated

◆ childCategories()

◆ childCategoryIds()

◆ compatiblePlace()

◆ dataChanged

◆ errorOccurred

◆ finished

◆ getPlaceContent()

◆ getPlaceDetails()

◆ initializeCategories()

◆ locales()

◆ managerName()

◆ managerVersion()

◆ matchingPlaces()

◆ parentCategoryId()

◆ placeAdded

◆ placeRemoved

◆ placeUpdated

◆ removeCategory()

◆ removePlace()

◆ saveCategory()

◆ savePlace()

◆ search()

◆ searchSuggestions()

◆ setLocale()

◆ setLocales()

Friends And Related Symbol Documentation

◆ QGeoServiceProvider

◆ QGeoServiceProviderPrivate

◆ QPlaceIcon