QPlaceAttribute Class

The QPlaceAttribute class represents generic attribute information about a place. More...

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

• List of all members, including inherited members

Public Functions

	QPlaceAttribute()
	QPlaceAttribute(const QPlaceAttribute &other)
virtual	~QPlaceAttribute()
bool	isEmpty() const
QString	label() const
void	setLabel(const QString &label)
void	setText(const QString &text)
QString	text() const
bool	operator!=(const QPlaceAttribute &other) const
QPlaceAttribute &	operator=(const QPlaceAttribute &other)
bool	operator==(const QPlaceAttribute &other) const

Static Public Members

const QString	OpeningHours
const QString	Payment
const QString	Provider

Protected Variables

QSharedDataPointer<QPlaceAttributePrivate>

d_ptr

Detailed Description

The QPlaceAttribute class represents generic attribute information about a place.

A QPlaceAttribute instance stores an additional piece of information about a place that is not otherwise exposed through the QPlace class. A QPlaceAttribute encapsulates a localized label which describes the attribute and rich text string representing the attribute's value. Generally, both are intended to be displayed to the end-user as is.

Some plugins may not support attributes at all, others may only support a certain set, others still may support a dynamically changing set of attributes over time or even allow attributes to be arbitrarily defined by the client application. The attributes could also vary on a place by place basis, for example one place may have opening hours while another does not. Consult the plugin references for details.

Attribute Types

The QPlaceAttribute class defines some constant strings which characterize standard attribute types.

• QPlaceAttribute::OpeningHours
• QPlaceAttribute::Payment
• QPlaceAttribute::Provider

There is a class of attribute types of the format x_id_<provider> for example x_id_here. This class of attributes is a set of alternative identifiers of the place, from the specified provider's perspective.

The above types are used to access and modify attributes in QPlace via:

• QPlace::extendedAttribute()
• QPlace::setExtendedAttribute()
• QPlace::removeExtendedAttribute()
• QPlace::removeExtendedAttribute()

The attribute type is a string type so that providers are able to introduce new attributes as necessary. Custom attribute types should always be prefixed by a qualifier in order to avoid conflicts.

User Readable and Non-User Readable Attributes

Some attributes may not be intended to be readable by end users, the label field of such attributes are empty to indicate this fact.

Member Function Documentation

QPlaceAttribute::QPlaceAttribute()

Constructs an attribute.

QPlaceAttribute::QPlaceAttribute(const QPlaceAttribute &other)

Creates a copy of other.

[virtual] QPlaceAttribute::~QPlaceAttribute()

Destroys the attribute.

bool QPlaceAttribute::isEmpty() const

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

QString QPlaceAttribute::label() const

Returns a localized label describing the attribute.

See also setLabel().

void QPlaceAttribute::setLabel(const QString &label)

Sets the label of the attribute.

See also label().

void QPlaceAttribute::setText(const QString &text)

Sets the text of the attribute.

See also text().

QString QPlaceAttribute::text() const

Returns a piece of rich text representing the attribute value.

See also setText().

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

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

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

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

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

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