QPlaceAttribute Class▲
-
Header: QPlaceAttribute
-
qmake: QT += location
-
Group: QPlaceAttribute is part of QtLocation-places, QtLocation-places-data
I. Detailed Description▲
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.
I-1. Attribute Types▲
The QPlaceAttribute class defines some constant strings which characterize standard attribute types.
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:
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.
I-1-1. 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.
II. Property Documentation▲
II-1. label : QString▲
This property holds a localized label describing the attribute.
Access functions:
-
label() const
-
void setLabel(const &label)
II-2. text : QString▲
This property holds a piece of rich text representing the attribute value.
Access functions:
-
text() const
-
void setText(const &text)
III. Member Function Documentation▲
III-1. QPlaceAttribute::QPlaceAttribute()▲
Constructs an attribute.
III-2. QPlaceAttribute::QPlaceAttribute(const QPlaceAttribute &other)▲
Creates a copy of other.
III-3. QPlaceAttribute::~QPlaceAttribute()▲
Destroys the attribute.
III-4. bool QPlaceAttribute::isEmpty() const▲
Returns a boolean indicating whether the all the fields of the place attribute are empty or not.
III-5. QPlaceAttribute &QPlaceAttribute::operator=(const QPlaceAttribute &other)▲
Assigns other to this attribute and returns a reference to this attribute.
IV. Member Variable Documentation▲
IV-1. const QString QPlaceAttribute::OpeningHours▲
Specifies the opening hours.
IV-2. const QString QPlaceAttribute::Payment▲
The constant to specify an attribute that defines the methods of payment.
IV-3. const QString QPlaceAttribute::Provider▲
The constant to specify an attribute that defines which provider the place came from.