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
|
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qplacecontent.h"
#include "qplacecontent_p.h"
QT_USE_NAMESPACE
inline QPlaceContentPrivate *QPlaceContent::d_func()
{
return d_ptr.data();
}
inline const QPlaceContentPrivate *QPlaceContent::d_func() const
{
return d_ptr.constData();
}
bool QPlaceContentPrivate::compare(const QPlaceContentPrivate *other) const
{
return data == other->data;
}
QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QPlaceContentPrivate)
/*!
\class QPlaceContent
\inmodule QtLocation
\ingroup QtLocation-places
\ingroup QtLocation-places-data
\since 5.6
\brief The QPlaceContent class holds content about places.
A QPlaceContent holds rich content such as images, reviews, or editorials, as well
as attributes about the content such as the user or supplier of the content. Content
objects might hold multiple data, e.g. an item holding a review typically includes
the user that wrote the review. Use type() to inspect the type of content a
QPlaceContent object represents, and dataTags() to see which data is held. Use value()
to get the individual data as a QVariant.
\b {Note:} Some providers may \e {require} that the attribution string be displayed
to the user whenever a piece of content is viewed.
The rich content of a place is typically made available as paginated items.
At present the QPlaceContent class is not extensible by 3rd parties.
Note: The Places API considers content objects to be 'retrieve-only' objects.
Submission of content to a provider is not a supported use case.
*/
/*!
\typedef QPlaceContent::Collection
Synonym for QMap<int, QPlaceContent>. The key of the map is an \c int representing the
index of the content. The value is the content object itself.
The \c {Collection} is intended to be a container where content items, that have been retrieved
as pages, can be stored. This enables a developer to skip pages, for example indexes 0-9 may be
stored in the collection, if the user skips to indexes 80-99, these can be stored in the
collection as well.
*/
/*!
\enum QPlaceContent::Type
Defines the type of content.
\value NoType
The content object is default constructed, any other content type may be assigned
to this content object
\value ImageType
The content object is an image
\value ReviewType
The content object is a review
\value EditorialType
The content object is an editorial
\value CustomType
The content object is of a custom type
*/
/*!
\enum QPlaceContent::DataTag
Defines the value entry of the content object
\value ContentSupplier
The supplier who contributed this content
\value ContentUser
The user who contributed this content
\value ContentAttribution
Returns a rich text attribution string
\note Some providers may require that the attribution
of a particular content item always be displayed
when the content item is shown.
\value ImageId
The image's identifier
\value ImageUrl
The image's url
\value ImageMimeType
The image's MIME type
\value EditorialTitle
The title of the editorial
\value EditorialText
A textual description of the place. Depending upon the provider, the
text could be either rich (HTML based) text or plain text.
\value EditorialLanguage
The language of the editorial. Typically this would be a language code
in the 2 letter ISO 639-1 format.
\value ReviewId
The identifier of the review
\value ReviewDateTime
The date and time that the review was submitted
\value ReviewTitle
The title of the review
\value ReviewText
The text of the review. Depending on the provider, the text could be
rich (HTML based) or plain text.
\value ReviewLanguage
The language of the review. Typically this would be a language code
in the 2 letter ISO 639-1 format.
\value ReviewRating
This review's rating of the place
\value CustomDataTag
*/
/*!
Constructs an content object for \a type.
*/
QPlaceContent::QPlaceContent(Type type)
: d_ptr(new QPlaceContentPrivate(type))
{}
/*!
Constructs a new copy of \a other.
*/
QPlaceContent::QPlaceContent(const QPlaceContent &other) noexcept = default;
/*!
Assigns the \a other content object to this and returns a reference
to this content object.
*/
QPlaceContent &QPlaceContent::operator=(const QPlaceContent &other) noexcept = default;
/*!
Destroys the content object.
*/
QPlaceContent::~QPlaceContent() = default;
/*!
\internal
*/
void QPlaceContent::detach()
{
d_ptr.detach();
}
/*!
Returns the content type.
*/
QPlaceContent::Type QPlaceContent::type() const
{
if (!d_ptr)
return NoType;
return d_ptr->type();
}
/*!
Returns true if this content object is equivalent to \a other,
otherwise returns false.
*/
bool QPlaceContent::operator==(const QPlaceContent &other) const
{
// An invalid content object is only equal to another invalid content object
if (!d_ptr)
return !other.d_ptr;
if (type() != other.type())
return false;
return d_ptr->compare(other.d_ptr.constData());
}
/*!
Returns true if this content object is not equivalent to \a other,
otherwise returns false.
*/
bool QPlaceContent::operator!=(const QPlaceContent &other) const
{
return !(*this == other);
}
/*!
Returns the list of data tags for which values are stored in this
content objects.
*/
QList<QPlaceContent::DataTag> QPlaceContent::dataTags() const
{
Q_D(const QPlaceContent);
return d->data.keys();
}
/*!
Returns the value stored for the data \a tag, or an invalid QVariant
if there is no data for that tag.
*/
QVariant QPlaceContent::value(QPlaceContent::DataTag tag) const
{
Q_D(const QPlaceContent);
return d->data.value(tag);
}
/*!
Sets the value stored for the data \a tag to \a value.
*/
void QPlaceContent::setValue(QPlaceContent::DataTag tag, const QVariant &value)
{
detach();
Q_D(QPlaceContent);
d->data[tag] = value;
}
|
