1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtLocation module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qdeclarativeplaceattribute_p.h"
/*!
\qmltype ExtendedAttributes
\instantiates QQmlPropertyMap
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-data
\since Qt Location 5.0
\brief The ExtendedAttributes type holds additional data about a \l Place.
The ExtendedAttributes type is a map of \l {PlaceAttribute}{PlaceAttributes}. To access
attributes in the map use the \l keys() method to get the list of keys stored in the map and
use the \c {[]} operator to access the \l PlaceAttribute items.
The following are standard keys that are defined by the API. \l Plugin
implementations are free to define additional keys. Custom keys should
be qualified by a unique prefix to avoid clashes.
\table
\header
\li key
\li description
\row
\li openingHours
\li The trading hours of the place
\row
\li payment
\li The types of payment the place accepts, for example visa, mastercard.
\row
\li x_provider
\li The name of the provider that a place is sourced from
\row
\li x_id_<provider> (for example x_id_nokia)
\li An alternative identifier which identifies the place from the
perspective of the specified provider.
\endtable
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 \l {Plugin References and Parameters}{plugin
references} for details.
Some attributes may not be intended to be readable by end users, the label field
of such attributes is empty to indicate this fact.
\note ExtendedAttributes instances are only ever used in the context of \l {Place}s. It is not
possible to create an ExtendedAttributes instance directly or re-assign a \l {Place}'s
ExtendedAttributes property. Modification of ExtendedAttributes can only be accomplished
via Javascript.
The following example shows how to access all \l {PlaceAttribute}{PlaceAttributes} and print
them to the console:
\snippet declarative/places.qml QtLocation import
\codeline
\snippet declarative/places.qml ExtendedAttributes read
The following example shows how to assign and modify an attribute:
\snippet declarative/places.qml ExtendedAttributes write
\sa PlaceAttribute, QQmlPropertyMap
*/
/*!
\qmlmethod variant ExtendedAttributes::keys()
Returns an array of place attribute keys currently stored in the map.
*/
/*!
\qmlsignal void ExtendedAttributes::onValueChanged(string key, variant value)
This signal is raised when the set of attributes changes. \a key is the key
corresponding to the \a value that was changed.
*/
/*!
\qmltype PlaceAttribute
\instantiates QDeclarativePlaceAttribute
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-data
\since Qt Location 5.0
\brief The PlaceAttribute type holds generic place attribute information.
A place attribute stores an additional piece of information about a \l Place that is not
otherwise exposed through the \l Place type. A PlaceAttribute is a textual piece of data,
accessible through the \l text property, and a \l label. Both the \l text and \l label
properties are intended to be displayed to the user. PlaceAttributes are stored in an
\l ExtendedAttributes map with a unique key.
The following example shows how to display all attributes in a list:
\snippet declarative/places.qml QtQuick import
\snippet declarative/places.qml QtLocation import
\codeline
\snippet declarative/places.qml ExtendedAttributes
The following example shows how to assign and modify an attribute:
\snippet declarative/places.qml ExtendedAttributes write
*/
QDeclarativePlaceAttribute::QDeclarativePlaceAttribute(QObject *parent)
: QObject(parent)
{
}
QDeclarativePlaceAttribute::QDeclarativePlaceAttribute(const QPlaceAttribute &src, QObject *parent)
: QObject(parent),m_attribute(src)
{
}
QDeclarativePlaceAttribute::~QDeclarativePlaceAttribute()
{
}
/*!
\qmlproperty QPlaceAttribute PlaceAttribute::attribute
For details on how to use this property to interface between C++ and QML see
"\l {location-cpp-qml.html#placeattribute} {Interfaces between C++ and QML Code}".
*/
void QDeclarativePlaceAttribute::setAttribute(const QPlaceAttribute &src)
{
QPlaceAttribute prevAttribute = m_attribute;
m_attribute = src;
if (m_attribute.label() != prevAttribute.label())
emit labelChanged();
if (m_attribute.text() != prevAttribute.text())
emit textChanged();
}
QPlaceAttribute QDeclarativePlaceAttribute::attribute() const
{
return m_attribute;
}
/*!
\qmlproperty string PlaceAttribute::label
This property holds the attribute label which is a user visible string
describing the attribute.
*/
void QDeclarativePlaceAttribute::setLabel(const QString &label)
{
if (m_attribute.label() != label) {
m_attribute.setLabel(label);
emit labelChanged();
}
}
QString QDeclarativePlaceAttribute::label() const
{
return m_attribute.label();
}
/*!
\qmlproperty string PlaceAttribute::text
This property holds the attribute text which can be used to show additional information about the place.
*/
void QDeclarativePlaceAttribute::setText(const QString &text)
{
if (m_attribute.text() != text) {
m_attribute.setText(text);
emit textChanged();
}
}
QString QDeclarativePlaceAttribute::text() const
{
return m_attribute.text();
}
|
