PySide2.QtLocation.QPlacePySide2.QtLocation.QPlace.appendContactDetail()PySide2.QtLocation.QPlace.attribution()PySide2.QtLocation.QPlace.categories()PySide2.QtLocation.QPlace.contactDetails()PySide2.QtLocation.QPlace.contactTypes()PySide2.QtLocation.QPlace.content()PySide2.QtLocation.QPlace.detailsFetched()PySide2.QtLocation.QPlace.extendedAttribute()PySide2.QtLocation.QPlace.extendedAttributeTypes()PySide2.QtLocation.QPlace.icon()PySide2.QtLocation.QPlace.insertContent()PySide2.QtLocation.QPlace.isEmpty()PySide2.QtLocation.QPlace.location()PySide2.QtLocation.QPlace.name()PySide2.QtLocation.QPlace.__ne__()PySide2.QtLocation.QPlace.__eq__()PySide2.QtLocation.QPlace.placeId()PySide2.QtLocation.QPlace.primaryEmail()PySide2.QtLocation.QPlace.primaryFax()PySide2.QtLocation.QPlace.primaryPhone()PySide2.QtLocation.QPlace.primaryWebsite()PySide2.QtLocation.QPlace.ratings()PySide2.QtLocation.QPlace.removeContactDetails()PySide2.QtLocation.QPlace.removeExtendedAttribute()PySide2.QtLocation.QPlace.setAttribution()PySide2.QtLocation.QPlace.setCategories()PySide2.QtLocation.QPlace.setCategory()PySide2.QtLocation.QPlace.setContactDetails()PySide2.QtLocation.QPlace.setContent()PySide2.QtLocation.QPlace.setDetailsFetched()PySide2.QtLocation.QPlace.setExtendedAttribute()PySide2.QtLocation.QPlace.setIcon()PySide2.QtLocation.QPlace.setLocation()PySide2.QtLocation.QPlace.setName()PySide2.QtLocation.QPlace.setPlaceId()PySide2.QtLocation.QPlace.setRatings()PySide2.QtLocation.QPlace.setSupplier()PySide2.QtLocation.QPlace.setTotalContentCount()PySide2.QtLocation.QPlace.supplier()PySide2.QtLocation.QPlace.totalContentCount()
def __eq__ (other)
def __ne__ (other)
def appendContactDetail (contactType, detail)
def attribution ()
def categories ()
def contactDetails (contactType)
def contactTypes ()
def content (type)
def detailsFetched ()
def extendedAttribute (attributeType)
def extendedAttributeTypes ()
def icon ()
def insertContent (type, content)
def isEmpty ()
def location ()
def name ()
def placeId ()
def primaryEmail ()
def primaryFax ()
def primaryPhone ()
def primaryWebsite ()
def ratings ()
def removeContactDetails (contactType)
def removeExtendedAttribute (attributeType)
def setAttribution (attribution)
def setCategories (categories)
def setCategory (category)
def setContactDetails (contactType, details)
def setContent (type, content)
def setDetailsFetched (fetched)
def setExtendedAttribute (attributeType, attribute)
def setIcon (icon)
def setLocation (location)
def setName (name)
def setPlaceId (identifier)
def setRatings (ratings)
def setSupplier (supplier)
def setTotalContentCount (type, total)
def supplier ()
def totalContentCount (type)
A place is a point of interest, it could be a favorite restaurant, a park or someone’s home. A
QPlaceobject represents a place by acting as a container for various information about that place.This information can be divided into 2 broad classifications
Details
Rich content
The place details consist of properties of the place, such as the name, location, contact information and so on. When a place is returned during a search, these details are filled in. Sometimes in order to save bandwidth, there are further details about the place that can be retrieved on an individual place by place basis, if the user is interested. The
detailsFetched()function can be queried to see if all available details have been fetched, and if not,getPlaceDetails()can be used to retrieve them. Precisely which details are populated during a search and which need to be fetched individually may vary from provider to provider. See plugin documentation for more details.The rich content of a place consists of items such as images, reviews and editorials. Potentially there may be many rich content items, so they are treated separately from the place details. They can be retrieved in a paged fashion via
getPlaceContent(). If necessary, the content may be assigned to a place so it can act as a convenient container.
The contact information of a place is based around a common set of
contact types. To retrieve all the phone numbers of a place, one would do:if (place.contactTypes().contains(QPlaceContactDetail::Phone)) { foreach (const QPlaceContactDetail &number, place.contactDetails(QPlaceContactDetail::Phone)) qDebug() << number.label() << ":" << number.value(); }The contact types are string values by design to allow for providers to introduce new contact types.
For convenience there are a set of functions which return the value of the first contact detail of each type.
Places may have additional attributes which are not covered in the formal API. Similar to contacts attributes are based around a common set of
attribute types. To retrieve an extended attribute one would do:if (place.extendedAttributeTypes().contains(QPlaceAttribute::OpeningHours)) qDebug() << place.extendedAttribute(QPlaceAttribute::OpeningHours).text();The attribute types are string values by design to allow providers to introduce new attribute types.
The
QPlaceobject is only meant to be a convenient container to hold rich content such as images, reviews and so on. Retrieval of content should happen viagetPlaceContent().The content is stored as a
Collectionwhich contains both the index of the content, as well as the content itself. This enables developers to check whether a particular item has already been retrieved and if not, then request that content.
Places have a field for a rich text attribution string. Some providers may require that the attribution be shown when a place is displayed to a user.
Different categories may be assigned to a place to indicate that the place is associated with those categories. When saving a place, the only meaningful data is the category id, the rest of the category data is effectively ignored. The category must already exist before saving the place (it is not possible to create a new category, assign it to the place, save the place and expect the category to be created).
The Places API is currently designed for only saving
coredetails. Saving rich content like images and reviews or details like supplier and rating is not a supported use case. Typically a manager will generally ignore these fields upon save and may produce a warning message if they are populated.The Places API only supports saving of the following core details :
name
place id
location
contact details
icon
categories (tag-like names to describe a place)
visibility scope
It is possible that providers may only support a subset of these. See the plugin documentation for more details.
Saving of properties such as the rating, extended attributes, images, reviews, editorials and supplier is explicitly not supported by the Places API.
PySide2.QtLocation.QPlace(other)
- param other:
Constructs an empty place object.
contactType – str
Appends a contact detail of a specified contactType .
See QPlaceContactDetail for a list of common contact types .
str
Returns a rich text attribution string of the place. Note, some providers may have a requirement where the attribution must be shown whenever a place is displayed to an end user.
See also
Returns categories that this place belongs to.
See also
contactType – str
Returns a list of contact details of the specified contactType .
See QPlaceContactDetail for a list of common contact types .
See also
list of strings
Returns the type of contact details this place has.
See QPlaceContactDetail for a list of common contact types .
type – Type
Returns a collection of content associated with a place. This collection is a map with the key being the index of the content object and value being the content object itself.
The type specifies which kind of content is to be retrieved.
See also
bool
Returns true if the details of this place have been fetched, otherwise returns false.
See also
attributeType – str
Returns the exteded attribute corresponding to the specified attributeType . If the place does not have that particular attribute type, a default constructed QPlaceExtendedAttribute is returned.
See also
list of strings
Returns the types of extended attributes that this place has.
Returns the icon of the place.
See also
type – Type
content –
Adds a collection of content of the given type to the place. Any index in content that already exists is overwritten.
bool
Returns a boolean indicating whether the all the fields of the place are empty or not.
Returns the location of the place.
See also
str
Returns the name of the place.
See also
other – PySide2.QtLocation.QPlace
bool
Returns true if other is not equal to this place, otherwise returns false.
other – PySide2.QtLocation.QPlace
bool
Returns true if other is equal to this place, otherwise returns false.
str
Returns the identifier of the place. The place identifier is only meaningful to the QPlaceManager that generated it and is not transferable between managers. The place identifier is not guaranteed to be universally unique, but unique for the manager that generated it.
See also
str
Returns the primary email address for this place. This convenience function accesses the first contact detail of the email type . If no email addresses exist, then an empty string is returned.
str
Returns the primary fax number for this place. This convenience function accesses the first contact detail of the fax type . If no fax details exist, then an empty string is returned.
str
Returns the primary phone number for this place. This accesses the first contact detail of the phone number type . If no phone details exist, then an empty string is returned.
Returns the primary website of the place. This convenience function accesses the first contact detail of the website type . If no websites exist, then an empty string is returned.
Returns an aggregated rating of the place.
See also
contactType – str
Removes all the contact details of a given contactType .
The contactType is no longer returned when contactTypes() is called.
attributeType – str
Remove the attribute of attributeType from the place.
The attribute will no longer be listed by extendedAttributeTypes()
attribution – str
Sets the attribution string of the place.
See also
categories –
Sets the categories that this place belongs to.
See also
category – PySide2.QtLocation.QPlaceCategory
Sets a single category that this place belongs to.
contactType – str
details –
Sets the contact details of a specified contactType .
If details is empty, then the contactType is removed from the place such that it is no longer returned by contactTypes() .
See QPlaceContactDetail for a list of common contact types .
See also
type – Type
content –
Sets a collection of content for the given type .
See also
fetched – bool
Sets whether the details of this place have been fetched or not.
See also
attributeType – str
attribute – PySide2.QtLocation.QPlaceAttribute
Assigns an attribute of the given attributeType to a place. If the given attributeType already exists in the place, then it is overwritten.
If attribute is a default constructed QPlaceAttribute , then the attributeType is removed from the place which means it will not be listed by extendedAttributeTypes() .
See also
Sets the icon of the place.
See also
location – PySide2.QtPositioning.QGeoLocation
Sets the location of the place.
See also
name – str
Sets the name of the place.
See also
identifier – str
Sets the identifier of the place.
See also
ratings – PySide2.QtLocation.QPlaceRatings
Sets the aggregated rating of the place.
See also
supplier – PySide2.QtLocation.QPlaceSupplier
Sets the supplier of this place to supplier .
See also
type – Type
total – int
Sets the totalCount of content objects of the given type .
See also
Returns the supplier of this place.
See also
type – Type
int
Returns the total count of content objects of the given type . This total count indicates how many the manager/provider should have available. (As opposed to how many objects this place instance is currently assigned).
A negative count indicates that the total number of items is unknown. By default the total content count is set to 0.
See also
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.