\inmodule QtLocation More...

#include <qplacesupplier.h>

Collaboration diagram for QPlaceSupplier:

Public Member Functions
	QPlaceSupplier ()
	\qmlvaluetype supplier \inqmlmodule QtLocation

	QPlaceSupplier (const QPlaceSupplier &other) noexcept
	Constructs a copy of other.

	QPlaceSupplier (QPlaceSupplier &&other) noexcept=default

	~QPlaceSupplier ()
	Destroys the supplier object.

QPlaceSupplier &	operator= (const QPlaceSupplier &other) noexcept
	Assigns other to this supplier and returns a reference to this supplier.

void	swap (QPlaceSupplier &other) noexcept

QString	name () const

void	setName (const QString &data)
	Sets the name of the supplier.

QString	supplierId () const

void	setSupplierId (const QString &identifier)
	Sets the identifier of the supplier.

QUrl	url () const

void	setUrl (const QUrl &data)
	Sets the url of the supplier's website.

QPlaceIcon	icon () const

void	setIcon (const QPlaceIcon &icon)
	Sets the icon of the supplier.

bool	isEmpty () const
	Returns true if all fields of the place supplier are 0; otherwise returns false.

Properties
QML_STRUCTURED_VALUEQString	name
	\qmlproperty string Supplier::name

QString	supplierId
	\qmlproperty string Supplier::supplierId

QUrl	url
	\qmlproperty url Supplier::url

QPlaceIcon	icon
	\qmlproperty PlaceIcon Supplier::icon

Friends
bool	operator== (const QPlaceSupplier &lhs, const QPlaceSupplier &rhs) noexcept
	Returns true if lhs is equal to rhs, otherwise returns false.

bool	operator!= (const QPlaceSupplier &lhs, const QPlaceSupplier &rhs) noexcept
	Returns true if lhs is not equal to rhs, otherwise returns false.

Detailed Description

\inmodule QtLocation

Since: 5.6

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.

Definition at line 19 of file qplacesupplier.h.

Constructor & Destructor Documentation

◆ QPlaceSupplier() [1/3]

QPlaceSupplier::QPlaceSupplier ( )

\qmlvaluetype supplier \inqmlmodule QtLocation

Since: QtLocation 5.5

Holds data regarding the supplier of a place, a place's image, review, or editorial.

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.

Definition at line 77 of file qplacesupplier.cpp.

◆ QPlaceSupplier() [2/3]

QPlaceSupplier::QPlaceSupplier ( const QPlaceSupplier & other )

defaultnoexcept

Constructs a copy of other.

◆ QPlaceSupplier() [3/3]

QPlaceSupplier::QPlaceSupplier ( QPlaceSupplier && other )

defaultnoexcept

◆ ~QPlaceSupplier()

QPlaceSupplier::~QPlaceSupplier ( )

default

Destroys the supplier object.

Member Function Documentation

◆ icon()

QPlaceIcon QPlaceSupplier::icon ( ) const

Definition at line 215 of file qplacesupplier.cpp.

◆ isEmpty()

bool QPlaceSupplier::isEmpty ( ) const

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

Definition at line 231 of file qplacesupplier.cpp.

◆ name()

QString QPlaceSupplier::name ( ) const

Definition at line 141 of file qplacesupplier.cpp.

◆ operator=()

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

noexcept

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

Definition at line 96 of file qplacesupplier.cpp.

◆ setIcon()

void QPlaceSupplier::setIcon ( const QPlaceIcon & icon )

Sets the icon of the supplier.

Definition at line 223 of file qplacesupplier.cpp.

◆ setName()

void QPlaceSupplier::setName ( const QString & data )

Sets the name of the supplier.

Definition at line 149 of file qplacesupplier.cpp.

◆ setSupplierId()

void QPlaceSupplier::setSupplierId ( const QString & identifier )

Sets the identifier of the supplier.

Definition at line 177 of file qplacesupplier.cpp.

◆ setUrl()

void QPlaceSupplier::setUrl ( const QUrl & data )

Sets the url of the supplier's website.

Definition at line 200 of file qplacesupplier.cpp.

◆ supplierId()

QString QPlaceSupplier::supplierId ( ) const

Definition at line 169 of file qplacesupplier.cpp.

◆ swap()

void QPlaceSupplier::swap ( QPlaceSupplier & other )

inlinenoexcept

Definition at line 39 of file qplacesupplier.h.

◆ url()

QUrl QPlaceSupplier::url ( ) const

Definition at line 192 of file qplacesupplier.cpp.

Friends And Related Symbol Documentation

◆ operator!=

bool operator!=	(	const QPlaceSupplier &	lhs,
		const QPlaceSupplier &	rhs )

friend

Returns true if lhs is not equal to rhs, otherwise returns false.

Definition at line 44 of file qplacesupplier.h.

◆ operator==

bool operator==	(	const QPlaceSupplier &	lhs,
		const QPlaceSupplier &	rhs )

friend

Returns true if lhs is equal to rhs, otherwise returns false.

Definition at line 41 of file qplacesupplier.h.

Property Documentation

◆ icon

QPlaceIcon QPlaceSupplier::icon

readwrite

\qmlproperty PlaceIcon Supplier::icon

This property holds the icon of the supplier.

the icon of the supplier.

Definition at line 28 of file qplacesupplier.h.

◆ name

QML_STRUCTURED_VALUEQString QPlaceSupplier::name

readwrite

\qmlproperty string Supplier::name

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 \l Plugin. The \l {Plugin::locales} property defines what language is used.

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.

Definition at line 25 of file qplacesupplier.h.

Referenced by testing.tools.encode_pdf_filter._PdfStream::RegisterByName().

◆ supplierId

QString QPlaceSupplier::supplierId

readwrite

\qmlproperty string Supplier::supplierId

This property holds the identifier of the supplier. The identifier is unique to the Plugin backend which provided the supplier and is generally not suitable for displaying to the user.

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.

Definition at line 26 of file qplacesupplier.h.

◆ url

QUrl QPlaceSupplier::url

readwrite

\qmlproperty url Supplier::url

This property holds the URL of the supplier's website.

the URL of the supplier's website.

Definition at line 27 of file qplacesupplier.h.

The documentation for this class was generated from the following files:

qtlocation/src/location/places/qplacesupplier.h (cd4db512ae08836f5fa1d746000052215cf70a9c)
qtlocation/src/location/places/qplacesupplier.cpp (cd4db512ae08836f5fa1d746000052215cf70a9c)

Public Member Functions

Properties

Friends

Detailed Description

Constructor & Destructor Documentation

◆ QPlaceSupplier() [1/3]

◆ QPlaceSupplier() [2/3]

◆ QPlaceSupplier() [3/3]

◆ ~QPlaceSupplier()

Member Function Documentation

◆ icon()

◆ isEmpty()

◆ name()

◆ operator=()

◆ setIcon()

◆ setName()

◆ setSupplierId()

◆ setUrl()

◆ supplierId()

◆ swap()

◆ url()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator==

Property Documentation

◆ icon

◆ name

◆ supplierId

◆ url