#include <qdeclarativeplace_p.h>

Inheritance diagram for QDeclarativePlace:

Collaboration diagram for QDeclarativePlace:

Public Types
enum	Status { Ready , Saving , Fetching , Removing , Error }

enum	Visibility { UnspecifiedVisibility = QLocation::UnspecifiedVisibility , DeviceVisibility = QLocation::DeviceVisibility , PrivateVisibility = QLocation::PrivateVisibility , PublicVisibility = QLocation::PublicVisibility }

Signals
void	pluginChanged ()

void	categoriesChanged ()

void	locationChanged ()

void	ratingsChanged ()

void	supplierChanged ()

void	iconChanged ()

void	nameChanged ()

void	placeIdChanged ()

void	attributionChanged ()

void	detailsFetchedChanged ()

void	reviewModelChanged ()

void	imageModelChanged ()

void	editorialModelChanged ()

void	primaryPhoneChanged ()

void	primaryFaxChanged ()

void	primaryEmailChanged ()

void	primaryWebsiteChanged ()

void	extendedAttributesChanged ()

void	contactDetailsChanged ()

void	statusChanged ()

void	visibilityChanged ()

void	favoriteChanged ()

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
	QDeclarativePlace (QObject *parent=nullptr)
	\qmltype Place \instantiates QDeclarativePlace \inqmlmodule QtLocation

	QDeclarativePlace (const QPlace &src, QDeclarativeGeoServiceProvider plugin, QObject parent=nullptr)

	~QDeclarativePlace ()

void	classBegin () override
	Invoked after class creation, but before any properties have been set.

void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.

void	setPlugin (QDeclarativeGeoServiceProvider *plugin)
	\qmlproperty Plugin Place::plugin

QDeclarativeGeoServiceProvider *	plugin () const

QDeclarativePlaceReviewModel *	reviewModel ()

QDeclarativePlaceImageModel *	imageModel ()

QDeclarativePlaceEditorialModel *	editorialModel ()

QPlace	place () const

void	setPlace (const QPlace &src)

QQmlListProperty< QDeclarativeCategory >	categories ()

QDeclarativeGeoLocation *	location () const

void	setLocation (QDeclarativeGeoLocation *location)
	\qmlproperty QtPositioning::Location Place::location

QPlaceRatings	ratings () const

void	setRatings (const QPlaceRatings &ratings)
	\qmlproperty Ratings Place::ratings

QPlaceSupplier	supplier () const

void	setSupplier (const QPlaceSupplier &supplier)
	\qmlproperty Supplier Place::supplier

QPlaceIcon	icon () const
	\qmlproperty Icon Place::icon

void	setIcon (const QPlaceIcon &icon)

QString	name () const

void	setName (const QString &name)
	\qmlproperty string Place::name

QString	placeId () const

void	setPlaceId (const QString &placeId)
	\qmlproperty string Place::placeId

QString	attribution () const

void	setAttribution (const QString &attribution)
	\qmlproperty string Place::attribution

bool	detailsFetched () const
	\qmlproperty bool Place::detailsFetched

Status	status () const

void	setStatus (Status status, const QString &errorString=QString())
	\qmlproperty enumeration Place::status

Q_INVOKABLE void	getDetails ()
	\qmlmethod void Place::getDetails()

Q_INVOKABLE void	save ()
	\qmlmethod void Place::save()

Q_INVOKABLE void	remove ()
	\qmlmethod void Place::remove()

Q_INVOKABLE QString	errorString () const
	\qmlmethod string Place::errorString()

QString	primaryPhone () const
	\qmlproperty string Place::primaryPhone

QString	primaryFax () const
	\qmlproperty string Place::primaryFax

QString	primaryEmail () const
	\qmlproperty string Place::primaryEmail

QUrl	primaryWebsite () const
	\qmlproperty string Place::primaryWebsite

QQmlPropertyMap *	extendedAttributes () const
	\qmlproperty ExtendedAttributes Place::extendedAttributes

QDeclarativeContactDetails *	contactDetails () const
	\qmlproperty ContactDetails Place::contactDetails

Visibility	visibility () const
	\qmlproperty enumeration Place::visibility

void	setVisibility (Visibility visibility)

QDeclarativePlace *	favorite () const
	\qmlproperty Place Place::favorite

void	setFavorite (QDeclarativePlace *favorite)

Q_INVOKABLE void	copyFrom (QDeclarativePlace *original)
	\qmlmethod void Place::copyFrom(Place original)

Q_INVOKABLE void	initializeFavorite (QDeclarativeGeoServiceProvider *plugin)
	\qmlmethod void Place::initializeFavorite(Plugin destinationPlugin)

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

Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()

virtual	~QQmlParserStatus ()

Static Public Member Functions
static void	category_append (QQmlListProperty< QDeclarativeCategory > prop, QDeclarativeCategory value)

static qsizetype	category_count (QQmlListProperty< QDeclarativeCategory > *prop)

static QDeclarativeCategory *	category_at (QQmlListProperty< QDeclarativeCategory > *prop, qsizetype index)

static void	category_clear (QQmlListProperty< QDeclarativeCategory > *prop)

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)

Properties
QPlace	place

QDeclarativeGeoServiceProvider *	plugin

QQmlListProperty< QDeclarativeCategory >	categories
	\qmlproperty list<Category> Place::categories

QDeclarativeGeoLocation *	location

QPlaceRatings	ratings

QPlaceSupplier	supplier

QPlaceIcon	icon

QString	name

QString	placeId

QString	attribution

QDeclarativePlaceReviewModel *	reviewModel
	\qmlproperty ReviewModel Place::reviewModel

QDeclarativePlaceImageModel *	imageModel
	\qmlproperty ImageModel Place::imageModel

QDeclarativePlaceEditorialModel *	editorialModel
	\qmlproperty EditorialModel Place::editorialModel

QObject *	extendedAttributes

QDeclarativeContactDetails *	contactDetails

bool	detailsFetched

Status	status

QString	primaryPhone

QString	primaryFax

QString	primaryEmail

QUrl	primaryWebsite

Visibility	visibility

QDeclarativePlace *	favorite

Properties inherited from QObject
QString	objectName
	the name of this object

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

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

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 38 of file qdeclarativeplace_p.h.

Member Enumeration Documentation

◆ Status

enum QDeclarativePlace::Status

Enumerator
Ready
Saving
Fetching
Removing
Error

Definition at line 80 of file qdeclarativeplace_p.h.

◆ Visibility

enum QDeclarativePlace::Visibility

Enumerator
UnspecifiedVisibility
DeviceVisibility
PrivateVisibility
PublicVisibility

Definition at line 81 of file qdeclarativeplace_p.h.

Constructor & Destructor Documentation

◆ QDeclarativePlace() [1/2]

QT_BEGIN_NAMESPACE QDeclarativePlace::QDeclarativePlace ( QObject * parent = nullptr )

explicit

\qmltype Place \instantiates QDeclarativePlace \inqmlmodule QtLocation

Since: QtLocation 5.5

The Place type represents a location that is a position of interest.

The Place type represents a physical location with additional metadata describing that location. Contrasted with \l Location, \l Address, and \l {coordinate} type which are used to describe where a location is. The basic properties of a Place are its \l name and \l location.

Place objects are typically obtained from a search model and will generally only have their basic properties set. The \l detailsFetched property can be used to test if further property values need to be fetched from the \l Plugin. This can be done by invoking the \l getDetails() method. Progress of the fetching operation can be monitored with the \l status property, which will be set to Place.Fetching when the details are being fetched.

The Place type has many properties holding information about the location. Details on how to contact the place are available from the \l contactDetails property. Convenience properties for obtaining the primary \l {primaryPhone}{phone}, \l {primaryFax}{fax}, \l {primaryEmail}{email} and \l {primaryWebsite}{website} are also available.

Each place is assigned zero or more \l categories. Categories are typically used when searching for a particular kind of place, such as a restaurant or hotel. Some places have a \l ratings object, which gives an indication of the quality of the place.

Place metadata is provided by a \l supplier who may require that an \l attribution message be displayed to the user when the place details are viewed.

Places have an associated \l icon which can be used to represent a place on a map or to decorate a delegate in a view.

Places may have additional rich content associated with them. The currently supported rich content include editorial descriptions, reviews and images. These are exposed as a set of models for retrieving the content. Editorial descriptions of the place are available from the \l editorialModel property. Reviews of the place are available from the \l reviewModel property. A gallery of pictures of the place can be accessed using the \l imageModel property.

Places may have additional attributes which are not covered in the formal API. The \l extendedAttributes property provides access to these. The type of extended attributes available is specific to each \l Plugin.

A Place is almost always tied to a \l plugin. The \l plugin property must be set before it is possible to call \l save(), \l remove() or \l getDetails(). The \l reviewModel, \l imageModel and \l editorialModel are only valid then the \l plugin property is set.

Definition at line 150 of file qdeclarativeplace.cpp.

References QObject::connect(), setPlace(), and QQmlPropertyMap::valueChanged().

Referenced by initializeFavorite().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ QDeclarativePlace() [2/2]

QDeclarativePlace::QDeclarativePlace	(	const QPlace &	src,
		QDeclarativeGeoServiceProvider *	plugin,
		QObject *	parent = nullptr )

Definition at line 161 of file qdeclarativeplace.cpp.

References QObject::connect(), plugin, Q_ASSERT, setPlace(), and QQmlPropertyMap::valueChanged().

Here is the call graph for this function:

◆ ~QDeclarativePlace()

QDeclarativePlace::~QDeclarativePlace ( )

Definition at line 175 of file qdeclarativeplace.cpp.

Member Function Documentation

◆ attribution()

QString QDeclarativePlace::attribution ( ) const

Definition at line 500 of file qdeclarativeplace.cpp.

References QPlace::attribution().

Here is the call graph for this function:

◆ attributionChanged

void QDeclarativePlace::attributionChanged ( )

signal

Referenced by setAttribution(), and setPlace().

Here is the caller graph for this function:

◆ categories()

QQmlListProperty< QDeclarativeCategory > QDeclarativePlace::categories ( )

◆ categoriesChanged

void QDeclarativePlace::categoriesChanged ( )

signal

Referenced by setPlace().

Here is the caller graph for this function:

◆ category_append()

void QDeclarativePlace::category_append	(	QQmlListProperty< QDeclarativeCategory > *	prop,
		QDeclarativeCategory *	value )

static

Definition at line 818 of file qdeclarativeplace.cpp.

References QList< T >::append(), emit, list, and QList< T >::removeAll().

Here is the call graph for this function:

◆ category_at()

QDeclarativeCategory * QDeclarativePlace::category_at	(	QQmlListProperty< QDeclarativeCategory > *	prop,
		qsizetype	index )

static

Definition at line 847 of file qdeclarativeplace.cpp.

◆ category_clear()

void QDeclarativePlace::category_clear ( QQmlListProperty< QDeclarativeCategory > * prop )

static

Definition at line 861 of file qdeclarativeplace.cpp.

References QList< T >::append(), category(), emit, QMetaObject::invokeMethod(), and Qt::QueuedConnection.

Here is the call graph for this function:

◆ category_count()

qsizetype QDeclarativePlace::category_count ( QQmlListProperty< QDeclarativeCategory > * prop )

static

Definition at line 839 of file qdeclarativeplace.cpp.

References QList< T >::count().

Here is the call graph for this function:

◆ classBegin()

void QDeclarativePlace::classBegin ( )

inlineoverridevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 89 of file qdeclarativeplace_p.h.

◆ componentComplete()

void QDeclarativePlace::componentComplete ( )

overridevirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 180 of file qdeclarativeplace.cpp.

◆ contactDetails()

QDeclarativeContactDetails * QDeclarativePlace::contactDetails ( ) const

\qmlproperty ContactDetails Place::contactDetails

This property holds the contact information for this place, for example a phone number or a website URL. This property is a map of \l contactDetail objects.

Definition at line 794 of file qdeclarativeplace.cpp.

◆ contactDetailsChanged

void QDeclarativePlace::contactDetailsChanged ( )

signal

◆ copyFrom()

void QDeclarativePlace::copyFrom ( QDeclarativePlace * original )

\qmlmethod void Place::copyFrom(Place original)

Copies data from an original place into this place. Only data that is supported by this place's plugin is copied over and plugin specific data such as place identifier is not copied over.

Definition at line 961 of file qdeclarativeplace.cpp.

References QPlaceManager::compatiblePlace(), place, and setPlace().

Here is the call graph for this function:

◆ detailsFetched()

bool QDeclarativePlace::detailsFetched ( ) const

\qmlproperty bool Place::detailsFetched

This property indicates whether the details of the place have been fetched. If this property is false, the place details have not yet been fetched. Fetching can be done by invoking the \l getDetails() method.

See also: getDetails()

Definition at line 514 of file qdeclarativeplace.cpp.

References QPlace::detailsFetched().

Here is the call graph for this function:

◆ detailsFetchedChanged

void QDeclarativePlace::detailsFetchedChanged ( )

signal

Referenced by setPlace().

Here is the caller graph for this function:

◆ editorialModel()

QDeclarativePlaceEditorialModel * QDeclarativePlace::editorialModel ( )

◆ editorialModelChanged

void QDeclarativePlace::editorialModelChanged ( )

signal

◆ errorString()

QString QDeclarativePlace::errorString ( ) const

\qmlmethod string Place::errorString()

Returns a string description of the error of the last operation. If the last operation completed successfully then the string is empty.

Definition at line 718 of file qdeclarativeplace.cpp.

Referenced by setStatus().

Here is the caller graph for this function:

◆ extendedAttributes()

QQmlPropertyMap * QDeclarativePlace::extendedAttributes ( ) const

\qmlproperty ExtendedAttributes Place::extendedAttributes

This property holds the extended attributes of a place. Extended attributes are additional information about a place not covered by the place's properties.

Definition at line 783 of file qdeclarativeplace.cpp.

◆ extendedAttributesChanged

void QDeclarativePlace::extendedAttributesChanged ( )

signal

◆ favorite()

QDeclarativePlace * QDeclarativePlace::favorite ( ) const

\qmlproperty Place Place::favorite

This property holds the favorite instance of a place.

Definition at line 937 of file qdeclarativeplace.cpp.

◆ favoriteChanged

void QDeclarativePlace::favoriteChanged ( )

signal

Referenced by setFavorite().

Here is the caller graph for this function:

◆ getDetails()

void QDeclarativePlace::getDetails ( )

\qmlmethod void Place::getDetails()

This method starts fetching place details.

The \l status property will change to Place.Fetching while the fetch is in progress. On success the object's properties will be updated, \l status will be set to Place.Ready and \l detailsFetched will be set to true. On error \l status will be set to Place.Error. The \l errorString() method can be used to get the details of the error.

Definition at line 652 of file qdeclarativeplace.cpp.

References QObject::connect(), Fetching, QPlaceReply::finished(), QPlaceManager::getPlaceDetails(), placeId, and setStatus().

Here is the call graph for this function:

◆ icon()

QPlaceIcon QDeclarativePlace::icon ( ) const

\qmlproperty Icon Place::icon

This property holds a graphical icon which can be used to represent the place.

Definition at line 429 of file qdeclarativeplace.cpp.

References QPlace::icon().

Here is the call graph for this function:

◆ iconChanged

void QDeclarativePlace::iconChanged ( )

signal

Referenced by setIcon(), and setPlace().

Here is the caller graph for this function:

◆ imageModel()

QDeclarativePlaceImageModel * QDeclarativePlace::imageModel ( )

◆ imageModelChanged

void QDeclarativePlace::imageModelChanged ( )

signal

◆ initializeFavorite()

void QDeclarativePlace::initializeFavorite ( QDeclarativeGeoServiceProvider * plugin )

\qmlmethod void Place::initializeFavorite(Plugin destinationPlugin)

Creates a favorite instance for the place which is to be saved into the destination plugin destinationPlugin. This method does nothing if the favorite property is not null.

Definition at line 977 of file qdeclarativeplace.cpp.

References QDeclarativePlace(), place, plugin, and setFavorite().

Here is the call graph for this function:

◆ location()

QDeclarativeGeoLocation * QDeclarativePlace::location ( ) const

Definition at line 381 of file qdeclarativeplace.cpp.

◆ locationChanged

void QDeclarativePlace::locationChanged ( )

signal

Referenced by setLocation(), and setPlace().

Here is the caller graph for this function:

◆ name()

QString QDeclarativePlace::name ( ) const

Definition at line 455 of file qdeclarativeplace.cpp.

References QPlace::name().

Here is the call graph for this function:

◆ nameChanged

void QDeclarativePlace::nameChanged ( )

signal

Referenced by setName(), and setPlace().

Here is the caller graph for this function:

◆ place()

QPlace QDeclarativePlace::place ( ) const

Definition at line 328 of file qdeclarativeplace.cpp.

References QList< T >::append(), categories, QQmlPropertyMap::keys(), QDeclarativeGeoLocation::location, QVariant::toList(), QVariant::typeId(), QVariant::value(), and QQmlPropertyMap::value().

Here is the call graph for this function:

◆ placeId()

QString QDeclarativePlace::placeId ( ) const

Definition at line 479 of file qdeclarativeplace.cpp.

References QPlace::placeId().

Here is the call graph for this function:

◆ placeIdChanged

void QDeclarativePlace::placeIdChanged ( )

signal

Referenced by setPlace(), and setPlaceId().

Here is the caller graph for this function:

◆ plugin()

QDeclarativeGeoServiceProvider * QDeclarativePlace::plugin ( ) const

Definition at line 218 of file qdeclarativeplace.cpp.

◆ pluginChanged

void QDeclarativePlace::pluginChanged ( )

signal

Referenced by setPlugin().

Here is the caller graph for this function:

◆ primaryEmail()

QString QDeclarativePlace::primaryEmail ( ) const

\qmlproperty string Place::primaryEmail

This property holds the primary email address of the place. If no "email" contact detail is defined for this place this property will be an empty string. It is equivalent to

Definition at line 758 of file qdeclarativeplace.cpp.

References QPlaceContactDetail::Email.

◆ primaryEmailChanged

void QDeclarativePlace::primaryEmailChanged ( )

signal

Referenced by setPlace().

Here is the caller graph for this function:

◆ primaryFax()

QString QDeclarativePlace::primaryFax ( ) const

\qmlproperty string Place::primaryFax

This property holds the primary fax number of the place. If no "fax" contact detail is defined for this place this property will be an empty string. It is equivalent to

Definition at line 745 of file qdeclarativeplace.cpp.

References QPlaceContactDetail::Fax.

◆ primaryFaxChanged

void QDeclarativePlace::primaryFaxChanged ( )

signal

Referenced by setPlace().

Here is the caller graph for this function:

◆ primaryPhone()

QString QDeclarativePlace::primaryPhone ( ) const

\qmlproperty string Place::primaryPhone

This property holds the primary phone number of the place. If no "phone" contact detail is defined for this place, this property will be an empty string. It is equivalent to:

Definition at line 732 of file qdeclarativeplace.cpp.

References QPlaceContactDetail::Phone.

◆ primaryPhoneChanged

void QDeclarativePlace::primaryPhoneChanged ( )

signal

Referenced by setPlace().

Here is the caller graph for this function:

◆ primaryWebsite()

QUrl QDeclarativePlace::primaryWebsite ( ) const

\qmlproperty string Place::primaryWebsite

This property holds the primary website url of the place. If no "website" contact detail is defined for this place this property will be an empty string. It is equivalent to

Definition at line 772 of file qdeclarativeplace.cpp.

References QPlaceContactDetail::Website.

◆ primaryWebsiteChanged

void QDeclarativePlace::primaryWebsiteChanged ( )

signal

Referenced by setPlace().

Here is the caller graph for this function:

◆ ratings()

QPlaceRatings QDeclarativePlace::ratings ( ) const

Definition at line 400 of file qdeclarativeplace.cpp.

References QPlace::ratings().

Here is the call graph for this function:

◆ ratingsChanged

void QDeclarativePlace::ratingsChanged ( )

signal

Referenced by setPlace(), and setRatings().

Here is the caller graph for this function:

◆ remove()

void QDeclarativePlace::remove ( )

\qmlmethod void Place::remove()

This method performs a remove operation on the place.

The \l status property will change to Place.Removing while the save operation is in progress. On success \l status will be set to Place.Ready. On error \l status will be set to Place.Error. The \l errorString() method can be used to get the details of the error.

Definition at line 701 of file qdeclarativeplace.cpp.

References QObject::connect(), QPlaceReply::finished(), place, placeId, QPlaceManager::removePlace(), Removing, and setStatus().

Here is the call graph for this function:

◆ reviewModel()

QDeclarativePlaceReviewModel * QDeclarativePlace::reviewModel ( )

◆ reviewModelChanged

void QDeclarativePlace::reviewModelChanged ( )

signal

◆ save()

void QDeclarativePlace::save ( )

\qmlmethod void Place::save()

This method performs a save operation on the place.

The \l status property will change to Place.Saving while the save operation is in progress. On success the \l status will be set to Place.Ready. On error \l status will be set to Place.Error. The \l errorString() method can be used to get the details of the error.

If the \l placeId property was previously empty, it will be assigned a valid value automatically during a successful save operation.

Note that a \l PlaceSearchModel will call Place::getDetails on any place that it detects an update on. A consequence of this is that whenever a Place from a \l PlaceSearchModel is successfully saved, it will be followed by a fetch of place details, leading to a sequence of state changes of Saving, Ready, Fetching, Ready.

Definition at line 681 of file qdeclarativeplace.cpp.

References QObject::connect(), QPlaceReply::finished(), place, QPlaceManager::savePlace(), Saving, and setStatus().

Here is the call graph for this function:

◆ setAttribution()

void QDeclarativePlace::setAttribution ( const QString & attribution )

\qmlproperty string Place::attribution

This property holds a rich text attribution string for the place. Some providers may require that the attribution be shown to the user whenever a place is displayed. The contents of this property should be shown to the user if it is not empty.

Definition at line 492 of file qdeclarativeplace.cpp.

References attribution, QPlace::attribution(), attributionChanged(), emit, and QPlace::setAttribution().

Here is the call graph for this function:

◆ setFavorite()

void QDeclarativePlace::setFavorite ( QDeclarativePlace * favorite )

Definition at line 942 of file qdeclarativeplace.cpp.

References emit, favorite, favoriteChanged(), and QObject::parent().

Referenced by initializeFavorite().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIcon()

void QDeclarativePlace::setIcon ( const QPlaceIcon & icon )

Definition at line 434 of file qdeclarativeplace.cpp.

References emit, icon, QPlace::icon(), iconChanged(), and QPlace::setIcon().

Here is the call graph for this function:

◆ setLocation()

void QDeclarativePlace::setLocation ( QDeclarativeGeoLocation * location )

\qmlproperty QtPositioning::Location Place::location

This property holds the location of the place which can be used to retrieve the coordinate, address and the bounding box.

Definition at line 369 of file qdeclarativeplace.cpp.

References emit, location, locationChanged(), and QObject::parent().

Here is the call graph for this function:

◆ setName()

void QDeclarativePlace::setName ( const QString & name )

\qmlproperty string Place::name

This property holds the name of the place which can be used to represent the place.

Definition at line 447 of file qdeclarativeplace.cpp.

References emit, QPlace::name(), nameChanged(), and QPlace::setName().

Here is the call graph for this function:

◆ setPlace()

void QDeclarativePlace::setPlace ( const QPlace & src )

Definition at line 271 of file qdeclarativeplace.cpp.

References QPlace::attribution(), attributionChanged(), QPlace::categories(), categoriesChanged(), QPlace::content(), QPlace::detailsFetched(), detailsFetchedChanged(), QPlaceContent::EditorialType, emit, QPlace::icon(), iconChanged(), QPlaceContent::ImageType, QDeclarativePlaceContentModel::initializeCollection(), QPlace::location(), locationChanged(), QPlace::name(), nameChanged(), QObject::parent(), QPlace::placeId(), placeIdChanged(), QPlace::primaryEmail(), primaryEmailChanged(), QPlace::primaryFax(), primaryFaxChanged(), QPlace::primaryPhone(), primaryPhoneChanged(), QPlace::primaryWebsite(), primaryWebsiteChanged(), QPlace::ratings(), ratingsChanged(), QPlaceContent::ReviewType, QDeclarativeGeoLocation::setLocation(), QPlace::supplier(), supplierChanged(), and QPlace::totalContentCount().

Referenced by QDeclarativePlace(), QDeclarativePlace(), and copyFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPlaceId()

void QDeclarativePlace::setPlaceId ( const QString & placeId )

\qmlproperty string Place::placeId

This property holds the unique identifier of the place. The place identifier is only meaningful to the \l Plugin that generated it and is not transferable between \l {Plugin}{Plugins}. The place id is not guaranteed to be universally unique, but unique within the \l Plugin that generated it.

If only the place identifier is known, all other place data can fetched from the \l Plugin.

Definition at line 471 of file qdeclarativeplace.cpp.

References emit, placeId, QPlace::placeId(), placeIdChanged(), and QPlace::setPlaceId().

Here is the call graph for this function:

◆ setPlugin()

void QDeclarativePlace::setPlugin ( QDeclarativeGeoServiceProvider * plugin )

\qmlproperty Plugin Place::plugin

This property holds the \l Plugin that provided this place which can be used to retrieve more information about the service.

Definition at line 190 of file qdeclarativeplace.cpp.

References QDeclarativeGeoServiceProvider::attached(), QObject::connect(), emit, QDeclarativeGeoServiceProvider::isAttached, plugin, and pluginChanged().

Here is the call graph for this function:

◆ setRatings()

void QDeclarativePlace::setRatings ( const QPlaceRatings & rating )

\qmlproperty Ratings Place::ratings

This property holds ratings of the place. The ratings provide an indication of the quality of a place.

Definition at line 392 of file qdeclarativeplace.cpp.

References emit, QPlace::ratings(), ratingsChanged(), and QPlace::setRatings().

Here is the call graph for this function:

◆ setStatus()

void QDeclarativePlace::setStatus	(	Status	status,
		const QString &	errorString = QString() )

\qmlproperty enumeration Place::status

This property holds the status of the place. It can be one of:

\table \row

Place.Ready
No error occurred during the last operation, further operations may be performed on the place. \row
Place.Saving
The place is currently being saved, no other operation may be performed until complete. \row
Place.Fetching
The place details are currently being fetched, no other operations may be performed until complete. \row
Place.Removing
The place is currently being removed, no other operations can be performed until complete. \row
Place.Error
An error occurred during the last operation, further operations can still be performed on the place. \endtable

The status of a place can be checked by connecting the status property to a handler function, and then have the handler function process the change in status.

\dots

Definition at line 556 of file qdeclarativeplace.cpp.

References emit, errorString(), status, and statusChanged().

Referenced by getDetails(), remove(), and save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSupplier()

void QDeclarativePlace::setSupplier ( const QPlaceSupplier & supplier )

\qmlproperty Supplier Place::supplier

This property holds the supplier of the place data. The supplier is typically a business or organization that collected the data about the place.

Definition at line 411 of file qdeclarativeplace.cpp.

References emit, QPlace::setSupplier(), supplier, QPlace::supplier(), and supplierChanged().

Here is the call graph for this function:

◆ setVisibility()

void QDeclarativePlace::setVisibility ( Visibility visibility )

Definition at line 923 of file qdeclarativeplace.cpp.

References emit, QPlace::setVisibility(), visibility, QPlace::visibility(), and visibilityChanged().

Here is the call graph for this function:

◆ status()

QDeclarativePlace::Status QDeclarativePlace::status ( ) const

Definition at line 566 of file qdeclarativeplace.cpp.

◆ statusChanged

void QDeclarativePlace::statusChanged ( )

signal

Referenced by setStatus().

Here is the caller graph for this function:

◆ supplier()

QPlaceSupplier QDeclarativePlace::supplier ( ) const

Definition at line 419 of file qdeclarativeplace.cpp.

References QPlace::supplier().

Here is the call graph for this function:

◆ supplierChanged

void QDeclarativePlace::supplierChanged ( )

signal

Referenced by setPlace(), and setSupplier().

Here is the caller graph for this function:

◆ visibility()

QDeclarativePlace::Visibility QDeclarativePlace::visibility ( ) const

\qmlproperty enumeration Place::visibility

This property holds the visibility of the place. It can be one of:

\table \row

Place.UnspecifiedVisibility
The visibility of the place is unspecified, the default visibility of the \l Plugin will be used. \row
Place.DeviceVisibility
The place is limited to the current device. The place will not be transferred off of the device. \row
Place.PrivateVisibility
The place is private to the current user. The place may be transferred to an online service but is only ever visible to the current user. \row
Place.PublicVisibility
The place is public. \endtable

Note that visibility does not affect how the place is displayed in the user-interface of an application on the device. Instead, it defines the sharing semantics of the place.

Definition at line 918 of file qdeclarativeplace.cpp.

References QPlace::visibility().

Here is the call graph for this function:

◆ visibilityChanged

void QDeclarativePlace::visibilityChanged ( )

signal

Referenced by setVisibility().

Here is the caller graph for this function:

Property Documentation

◆ attribution

QString QDeclarativePlace::attribution

readwrite

Definition at line 54 of file qdeclarativeplace_p.h.

Referenced by setAttribution().

◆ categories

QQmlListProperty< QDeclarativeCategory > QDeclarativePlace::categories

read

\qmlproperty list<Category> Place::categories

This property holds the list of categories this place is a member of. The categories that can be assigned to a place are specific to each \l plugin.

Definition at line 47 of file qdeclarativeplace_p.h.

Referenced by place().

◆ contactDetails

QDeclarativeContactDetails * QDeclarativePlace::contactDetails

read

Definition at line 61 of file qdeclarativeplace_p.h.

◆ detailsFetched

bool QDeclarativePlace::detailsFetched

read

Definition at line 62 of file qdeclarativeplace_p.h.

◆ editorialModel

QDeclarativePlaceEditorialModel * QDeclarativePlace::editorialModel

read

\qmlproperty EditorialModel Place::editorialModel

This property holds a model which can be used to retrieve editorial descriptions of the place.

Definition at line 58 of file qdeclarativeplace_p.h.

◆ extendedAttributes

QObject * QDeclarativePlace::extendedAttributes

read

Definition at line 60 of file qdeclarativeplace_p.h.

◆ favorite

QDeclarativePlace * QDeclarativePlace::favorite

readwrite

Definition at line 71 of file qdeclarativeplace_p.h.

Referenced by setFavorite().

◆ icon

QPlaceIcon QDeclarativePlace::icon

readwrite

Definition at line 51 of file qdeclarativeplace_p.h.

Referenced by setIcon().

◆ imageModel

QDeclarativePlaceImageModel * QDeclarativePlace::imageModel

read

\qmlproperty ImageModel Place::imageModel

This property holds a model which can be used to retrieve images of the place.

Definition at line 57 of file qdeclarativeplace_p.h.

◆ location

QDeclarativeGeoLocation * QDeclarativePlace::location

readwrite

Definition at line 48 of file qdeclarativeplace_p.h.

Referenced by setLocation().

◆ name

QString QDeclarativePlace::name

readwrite

Definition at line 52 of file qdeclarativeplace_p.h.

◆ place

QPlace QDeclarativePlace::place

readwrite

Definition at line 45 of file qdeclarativeplace_p.h.

Referenced by copyFrom(), QDeclarativePlaceContentModel::fetchMore(), initializeFavorite(), remove(), and save().

◆ placeId

QString QDeclarativePlace::placeId

readwrite

Definition at line 53 of file qdeclarativeplace_p.h.

Referenced by getDetails(), remove(), and setPlaceId().

◆ plugin

QDeclarativeGeoServiceProvider * QDeclarativePlace::plugin

readwrite

Definition at line 46 of file qdeclarativeplace_p.h.

Referenced by QDeclarativePlace(), QDeclarativePlaceContentModel::fetchMore(), initializeFavorite(), and setPlugin().

◆ primaryEmail

QString QDeclarativePlace::primaryEmail

read

Definition at line 67 of file qdeclarativeplace_p.h.

◆ primaryFax

QString QDeclarativePlace::primaryFax

read

Definition at line 66 of file qdeclarativeplace_p.h.

◆ primaryPhone

QString QDeclarativePlace::primaryPhone

read

Definition at line 65 of file qdeclarativeplace_p.h.

◆ primaryWebsite

QUrl QDeclarativePlace::primaryWebsite

read

Definition at line 68 of file qdeclarativeplace_p.h.

◆ ratings

QPlaceRatings QDeclarativePlace::ratings

readwrite

Definition at line 49 of file qdeclarativeplace_p.h.

◆ reviewModel

QDeclarativePlaceReviewModel * QDeclarativePlace::reviewModel

read

\qmlproperty ReviewModel Place::reviewModel

This property holds a model which can be used to retrieve reviews about the place.

Definition at line 56 of file qdeclarativeplace_p.h.

◆ status

Status QDeclarativePlace::status

read

Definition at line 63 of file qdeclarativeplace_p.h.

Referenced by setStatus().

◆ supplier

QPlaceSupplier QDeclarativePlace::supplier

readwrite

Definition at line 50 of file qdeclarativeplace_p.h.

Referenced by setSupplier().

◆ visibility

Visibility QDeclarativePlace::visibility

readwrite

Definition at line 70 of file qdeclarativeplace_p.h.

Referenced by setVisibility().

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

qtlocation/src/location/declarativeplaces/qdeclarativeplace_p.h (60828037eb143eaefab1780f1f831a3f0e6dcaf2)
qtlocation/src/location/declarativeplaces/qdeclarativeplace.cpp (cd4db512ae08836f5fa1d746000052215cf70a9c)

Public Types

Signals

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Status

◆ Visibility

Constructor & Destructor Documentation

◆ QDeclarativePlace() [1/2]

◆ QDeclarativePlace() [2/2]

◆ ~QDeclarativePlace()

Member Function Documentation

◆ attribution()

◆ attributionChanged

◆ categories()

◆ categoriesChanged

◆ category_append()

◆ category_at()

◆ category_clear()

◆ category_count()

◆ classBegin()

◆ componentComplete()

◆ contactDetails()

◆ contactDetailsChanged

◆ copyFrom()

◆ detailsFetched()

◆ detailsFetchedChanged

◆ editorialModel()

◆ editorialModelChanged

◆ errorString()

◆ extendedAttributes()

◆ extendedAttributesChanged

◆ favorite()

◆ favoriteChanged

◆ getDetails()

◆ icon()

◆ iconChanged

◆ imageModel()

◆ imageModelChanged

◆ initializeFavorite()

◆ location()

◆ locationChanged

◆ name()

◆ nameChanged

◆ place()

◆ placeId()

◆ placeIdChanged

◆ plugin()

◆ pluginChanged

◆ primaryEmail()

◆ primaryEmailChanged

◆ primaryFax()

◆ primaryFaxChanged

◆ primaryPhone()

◆ primaryPhoneChanged

◆ primaryWebsite()

◆ primaryWebsiteChanged

◆ ratings()

◆ ratingsChanged

◆ remove()

◆ reviewModel()

◆ reviewModelChanged

◆ save()

◆ setAttribution()

◆ setFavorite()

◆ setIcon()

◆ setLocation()

◆ setName()

◆ setPlace()

◆ setPlaceId()

◆ setPlugin()

◆ setRatings()

◆ setStatus()

◆ setSupplier()

◆ setVisibility()

◆ status()

◆ statusChanged