QPlaceSupplier Class

The QPlaceSupplier class represents a supplier of a place or content associated with a place. More...

Header: #include <QPlaceSupplier>
qmake: QT += location
Since: Qt 5.6

Public Functions

QPlaceSupplier()
QPlaceSupplier(const QPlaceSupplier &other)
~QPlaceSupplier()
QPlaceIcon icon() const
bool isEmpty() const
QString name() const
void setIcon(const QPlaceIcon &icon)
void setName(const QString &name)
void setSupplierId(const QString &identifier)
void setUrl(const QUrl &url)
QString supplierId() const
QUrl url() const
bool operator!=(const QPlaceSupplier &other) const
QPlaceSupplier &operator=(const QPlaceSupplier &other)
bool operator==(const QPlaceSupplier &other) const

Detailed Description

The QPlaceSupplier class represents a supplier of a place or content associated with a place.

Each instance represents a set of data about a supplier, which can include supplier's name, url and icon. The supplier is typically a business or organization.

Note: The Places API only supports suppliers as 'retrieve-only' objects. Submitting suppliers to a provider is not a supported use case.

Member Function Documentation

QPlaceSupplier::QPlaceSupplier()

Constructs a new supplier object.

QPlaceSupplier::QPlaceSupplier(const QPlaceSupplier &other)

Constructs a copy of other.

QPlaceSupplier::~QPlaceSupplier()

Destroys the supplier object.

QPlaceIcon QPlaceSupplier::icon() const

Returns the icon of the supplier.

See also setIcon().

bool QPlaceSupplier::isEmpty() const

Returns true if all fields of the place supplier are 0; otherwise returns false.

QString QPlaceSupplier::name() const

Returns the name of the supplier which can be displayed to the user.

The name can potentially be localized. The language is dependent on the entity that sets it, typically this is the QPlaceManager. The QPlaceManager::locales() field defines what language is used.

See also setName().

void QPlaceSupplier::setIcon(const QPlaceIcon &icon)

Sets the icon of the supplier.

See also icon().

void QPlaceSupplier::setName(const QString &name)

Sets the name of the supplier.

See also name().

void QPlaceSupplier::setSupplierId(const QString &identifier)

Sets the identifier of the supplier.

See also supplierId().

void QPlaceSupplier::setUrl(const QUrl &url)

Sets the url of the supplier's website.

See also url().

QString QPlaceSupplier::supplierId() const

Returns the identifier of the supplier. The identifier is unique to the manager backend which provided the supplier and is generally not suitable for displaying to the user.

See also setSupplierId().

QUrl QPlaceSupplier::url() const

Returns the URL of the supplier's website.

See also setUrl().

bool QPlaceSupplier::operator!=(const QPlaceSupplier &other) const

Returns true if this supplier is not equal to other, otherwise returns false.

QPlaceSupplier &QPlaceSupplier::operator=(const QPlaceSupplier &other)

Assigns other to this supplier and returns a reference to this supplier.

bool QPlaceSupplier::operator==(const QPlaceSupplier &other) const

Returns true if this supplier is equal to other, otherwise returns false.