QPlace ¶

函数 ¶

Contact Information ¶

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.

• primaryPhone()

• primaryEmail()

• primaryWebsite()

• primaryFax()

Extended Attributes ¶

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.

内容 ¶

QPlace object is only meant to be a convenient container to hold rich content such as images, reviews and so on. Retrieval of content should happen via getPlaceContent() .

The content is stored as a Collection which 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.

Attribution ¶

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.

Categories ¶

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

Saving Caveats ¶

The Places API is currently designed for only saving core details. 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 了解更多细节。

Saving of properties such as the rating, extended attributes, images, reviews, editorials and supplier is explicitly not supported by the Places API.

class QPlace ¶

QPlace(other)

param other

QPlace

Constructs an empty place object.

PySide2.QtLocation.QPlace. appendContactDetail ( contactType , detail ) ¶

参数

• contactType – unicode

• detail – QPlaceContactDetail

Appends a contact detail of a specified contactType .

见 QPlaceContactDetail for a list of common contact types .

PySide2.QtLocation.QPlace. attribution ( ) ¶

返回类型

unicode

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.

另请参阅

setAttribution()

PySide2.QtLocation.QPlace. categories ( ) ¶

返回类型

Returns categories that this place belongs to.

另请参阅

setCategories()

PySide2.QtLocation.QPlace. contactDetails ( contactType ) ¶

参数

contactType – unicode

返回类型

Returns a list of contact details of the specified contactType .

见 QPlaceContactDetail for a list of common contact types .

另请参阅

setContactDetails()

PySide2.QtLocation.QPlace. contactTypes ( ) ¶

返回类型

字符串列表

Returns the type of contact details this place has.

见 QPlaceContactDetail for a list of common contact types .

PySide2.QtLocation.QPlace. content ( type ) ¶

参数

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.

type specifies which kind of content is to be retrieved.

另请参阅

setContent()

PySide2.QtLocation.QPlace. detailsFetched ( ) ¶

返回类型

bool

Returns true if the details of this place have been fetched, otherwise returns false.

另请参阅

setDetailsFetched()

PySide2.QtLocation.QPlace. extendedAttribute ( attributeType ) ¶

参数

attributeType – unicode

返回类型

QPlaceAttribute

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.

另请参阅

setExtendedAttribute()

PySide2.QtLocation.QPlace. extendedAttributeTypes ( ) ¶

返回类型

字符串列表

Returns the types of extended attributes that this place has.

PySide2.QtLocation.QPlace. icon ( ) ¶

返回类型

QPlaceIcon

Returns the icon of the place.

另请参阅

setIcon()

PySide2.QtLocation.QPlace. insertContent ( type , content ) ¶

参数

• type – Type

• content –

Adds a collection of content 为给定 type to the place. Any index in content that already exists is overwritten.

PySide2.QtLocation.QPlace. isEmpty ( ) ¶

返回类型

bool

Returns a boolean indicating whether the all the fields of the place are empty or not.

PySide2.QtLocation.QPlace. location ( ) ¶

返回类型

QGeoLocation

Returns the location of the place.

另请参阅

setLocation()

PySide2.QtLocation.QPlace. name ( ) ¶

返回类型

unicode

Returns the name of the place.

另请参阅

setName()

PySide2.QtLocation.QPlace. __ne__ ( other ) ¶

参数

other – QPlace

返回类型

bool

返回 true 若 other is not equal to this place, otherwise returns false.

PySide2.QtLocation.QPlace. __eq__ ( other ) ¶

参数

other – QPlace

返回类型

bool

返回 true 若 other is equal to this place, otherwise returns false.

PySide2.QtLocation.QPlace. placeId ( ) ¶

返回类型

unicode

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.

另请参阅

setPlaceId()

PySide2.QtLocation.QPlace. primaryEmail ( ) ¶

返回类型

unicode

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.

PySide2.QtLocation.QPlace. primaryFax ( ) ¶

返回类型

unicode

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.

PySide2.QtLocation.QPlace. primaryPhone ( ) ¶

返回类型

unicode

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.

PySide2.QtLocation.QPlace. primaryWebsite ( ) ¶

返回类型

QUrl

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.

PySide2.QtLocation.QPlace. ratings ( ) ¶

返回类型

QPlaceRatings

Returns an aggregated rating of the place.

另请参阅

setRatings()

PySide2.QtLocation.QPlace. removeContactDetails ( contactType ) ¶

参数

contactType – unicode

Removes all the contact details of a given contactType .

contactType is no longer returned when contactTypes() 被调用。

PySide2.QtLocation.QPlace. removeExtendedAttribute ( attributeType ) ¶

参数

attributeType – unicode

Remove the attribute of attributeType from the place.

The attribute will no longer be listed by extendedAttributeTypes()

PySide2.QtLocation.QPlace. setAttribution ( attribution ) ¶

参数

attribution – unicode

设置 attribution string of the place.

另请参阅

attribution()

PySide2.QtLocation.QPlace. setCategories ( categories ) ¶

参数

categories –

设置 categories that this place belongs to.

另请参阅

categories()

PySide2.QtLocation.QPlace. setCategory ( category ) ¶

参数

category – QPlaceCategory

Sets a single category that this place belongs to.

PySide2.QtLocation.QPlace. setContactDetails ( contactType , details ) ¶

参数

• contactType – unicode

• details –

Sets the contact details of a specified contactType .

若 details is empty, then the contactType is removed from the place such that it is no longer returned by contactTypes() .

见 QPlaceContactDetail for a list of common contact types .

另请参阅

contactDetails()

PySide2.QtLocation.QPlace. setContent ( type , content ) ¶

参数

• type – Type

• content –

Sets a collection of content 为给定 type .

另请参阅

content()

PySide2.QtLocation.QPlace. setDetailsFetched ( fetched ) ¶

参数

fetched – bool

Sets whether the details of this place have been fetched or not.

另请参阅

detailsFetched()

PySide2.QtLocation.QPlace. setExtendedAttribute ( attributeType , attribute ) ¶

参数

• attributeType – unicode

• attribute – QPlaceAttribute

Assigns an attribute 为给定 attributeType to a place. If the given attributeType already exists in the place, then it is overwritten.

若 attribute is a default constructed QPlaceAttribute , then the attributeType is removed from the place which means it will not be listed by extendedAttributeTypes() .

另请参阅

extendedAttribute()

PySide2.QtLocation.QPlace. setIcon ( icon ) ¶

参数

icon – QPlaceIcon

设置 icon of the place.

另请参阅

icon()

PySide2.QtLocation.QPlace. setLocation ( location ) ¶

参数

location – QGeoLocation

设置 location of the place.

另请参阅

location()

PySide2.QtLocation.QPlace. setName ( name ) ¶

参数

name – unicode

设置 name of the place.

另请参阅

name()

PySide2.QtLocation.QPlace. setPlaceId ( identifier ) ¶

参数

identifier – unicode

设置 identifier of the place.

另请参阅

placeId()

PySide2.QtLocation.QPlace. setRatings ( ratings ) ¶

参数

ratings – QPlaceRatings

Sets the aggregated rating of the place.

另请参阅

ratings()

PySide2.QtLocation.QPlace. setSupplier ( supplier ) ¶

参数

supplier – QPlaceSupplier

Sets the supplier of this place to supplier .

另请参阅

supplier()

PySide2.QtLocation.QPlace. setTotalContentCount ( type , total ) ¶

参数

• type – Type

• total – int

设置 totalCount of content objects of the given type .

另请参阅

totalContentCount()

PySide2.QtLocation.QPlace. supplier ( ) ¶

返回类型

QPlaceSupplier

Returns the supplier of this place.

另请参阅

setSupplier()

PySide2.QtLocation.QPlace. totalContentCount ( type ) ¶

参数

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.

另请参阅

setTotalContentCount()