QPlaceSupplier Class
The QPlaceSupplier class represents a supplier of a place or content associated with a place. More...
| Header: | #include <QPlaceSupplier> |
| qmake: | QT += location |
Properties
- icon : QPlaceIcon
- name : QString
- supplierId : QString
- url : QUrl
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 |
| QPlaceSupplier & | operator=(const QPlaceSupplier &other) |
Related Non-Members
| bool | operator!=(const QPlaceSupplier &lhs, const QPlaceSupplier &rhs) |
| bool | operator==(const QPlaceSupplier &lhs, const QPlaceSupplier &rhs) |
Detailed Description
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.
Property Documentation
icon : QPlaceIcon
This property holds the icon of the supplier.
Access functions:
| QPlaceIcon | icon() const |
| void | setIcon(const QPlaceIcon &icon) |
name : QString
This property holds 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.
Access functions:
| QString | name() const |
| void | setName(const QString &name) |
supplierId : QString
This property holds 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.
Access functions:
| QString | supplierId() const |
| void | setSupplierId(const QString &identifier) |
url : QUrl
This property holds the URL of the supplier's website.
Access functions:
| QUrl | url() const |
| void | setUrl(const QUrl &url) |
Member Function Documentation
QPlaceSupplier::QPlaceSupplier()
Constructs a new supplier object.
[noexcept] QPlaceSupplier::QPlaceSupplier(const QPlaceSupplier &other)
Constructs a copy of other.
[noexcept] QPlaceSupplier::~QPlaceSupplier()
Destroys the supplier object.
bool QPlaceSupplier::isEmpty() const
Returns true if all fields of the place supplier are 0; otherwise returns false.
void QPlaceSupplier::setIcon(const QPlaceIcon &icon)
Sets the icon of the supplier.
Note: Setter function for property icon.
See also icon().
void QPlaceSupplier::setName(const QString &name)
Sets the name of the supplier.
Note: Setter function for property name.
See also name().
void QPlaceSupplier::setSupplierId(const QString &identifier)
Sets the identifier of the supplier.
Note: Setter function for property supplierId.
See also supplierId().
void QPlaceSupplier::setUrl(const QUrl &url)
Sets the url of the supplier's website.
Note: Setter function for property url.
See also url().
[noexcept] QPlaceSupplier &QPlaceSupplier::operator=(const QPlaceSupplier &other)
Assigns other to this supplier and returns a reference to this supplier.
Related Non-Members
[noexcept] bool operator!=(const QPlaceSupplier &lhs, const QPlaceSupplier &rhs)
Returns true if lhs is not equal to rhs, otherwise returns false.
[noexcept] bool operator==(const QPlaceSupplier &lhs, const QPlaceSupplier &rhs)
Returns true if lhs is equal to rhs, otherwise returns false.