QPlaceContent

The QPlaceContent class serves as the base class for rich content types. More

Inheritance diagram of PySide2.QtLocation.QPlaceContent

Inherited by: QPlaceEditorial, QPlaceImage, QPlaceReview

Synopsis

Functions

Detailed Description

Rich content such as images , reviews and editorials inherit from the QPlaceContent class which contains common properties such as an attribution string and content contributor, which may take the form of a user and/or supplier . It is possible that a user from a supplier is contributing content, hence both fields could be filled in simultaneously.

Note

Some providers may require that the attribution string be displayed to the user whenever a piece of content is viewed.

Conversion between QPlaceContent and it’s subclasses can be easily performed without casting. Due to the way it has been implemented, object slicing is not an issue, the following code is valid:

QPlaceImage image;
image.setUrl(QUrl("www.example.com"));

QPlaceContent content = image;

QPlaceImage image2;
image2 = content;
qDebug() << image2.url(); //image2.url() == "www.example.com"

The rich content of a place is typically made available as paginated items. The ability to convert between QPlaceContent and it’s subclasses means that code which handles the mechanics of paging can be easily shared for each of the sub types.

At present the QPlaceContent class is not extensible by 3rd parties.

Note: The Places API considers content objects to be ‘retrieve-only’ objects. Submission of content to a provider is not a supported use case.

class PySide2.QtLocation.QPlaceContent

PySide2.QtLocation.QPlaceContent(other)

param other:

PySide2.QtLocation.QPlaceContent

Constructs an default content object which has no type.

Constructs a new copy of other .

PySide2.QtLocation.QPlaceContent.Type

Defines the type of content.

Constant

Description

QPlaceContent.NoType

The content object is default constructed, any other content type may be assigned to this content object

QPlaceContent.ImageType

The content object is an image

QPlaceContent.ReviewType

The content object is a review

QPlaceContent.EditorialType

The content object is an editorial

QPlaceContent.CustomType

The content object is of a custom type

PySide2.QtLocation.QPlaceContent.attribution()
Return type:

str

Returns a rich text attribution string.

Note : Some providers may require that the attribution of a particular content item always be displayed when the content item is shown.

See also

setAttribution()

PySide2.QtLocation.QPlaceContent.__ne__(other)
Parameters:

otherPySide2.QtLocation.QPlaceContent

Return type:

bool

Returns true if this content object is not equivalent to other , otherwise returns false.

PySide2.QtLocation.QPlaceContent.__eq__(other)
Parameters:

otherPySide2.QtLocation.QPlaceContent

Return type:

bool

Returns true if this content object is equivalent to other , otherwise returns false.

PySide2.QtLocation.QPlaceContent.setAttribution(attribution)
Parameters:

attribution – str

Sets a rich text attribution string for this content item.

See also

attribution()

PySide2.QtLocation.QPlaceContent.setSupplier(supplier)
Parameters:

supplierPySide2.QtLocation.QPlaceSupplier

Sets the supplier of the content.

See also

supplier()

PySide2.QtLocation.QPlaceContent.setUser(user)
Parameters:

userPySide2.QtLocation.QPlaceUser

Sets the user who contributed this content.

See also

user()

PySide2.QtLocation.QPlaceContent.supplier()
Return type:

PySide2.QtLocation.QPlaceSupplier

Returns the supplier who contributed this content.

See also

setSupplier()

PySide2.QtLocation.QPlaceContent.type()
Return type:

Type

Returns the content type.

PySide2.QtLocation.QPlaceContent.user()
Return type:

PySide2.QtLocation.QPlaceUser

Returns the user who contributed this content.

See also

setUser()