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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
/****************************************************************************
**
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtIvi module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite 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 The Qt Company. For
** licensing terms and conditions see https://www.qt.io/terms-conditions.
** For further information use the contact form at https://www.qt.io/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 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: LGPL-3.0
**
****************************************************************************/
#include "qivisearchandbrowsemodelinterface.h"
#include "qivisearchandbrowsemodelinterface_p.h"
QT_BEGIN_NAMESPACE
/*!
\class QIviSearchAndBrowseModelInterface
\inmodule QtIviCore
\ingroup backends
\inherits QObject
\keyword org.qt-project.qtivi.SearchAndBrowseModel/1.0
\brief The QIviSearchAndBrowseModelInterface defines the interface for backends to the
QIviSearchAndBrowseModel feature class.
The QIviSearchAndBrowseModelInterface is the interface used by \l QIviSearchAndBrowseModel
The interface is discovered by a \l QIviSearchAndBrowseModel object, which connects to it and sets it up.
Every QIviSearchAndBrowseModel generates its own QUuid which is passed to the backend interface and can
be used to identify a model instance.
\sa QIviSearchAndBrowseModel
//TODO explain how the interface works on a example
<example of a fully featured backend>
*/
/*!
\fn QIviSearchAndBrowseModelInterface::QIviSearchAndBrowseModelInterface(QObject *parent = nullptr)
Constructs a backend interface.
The \a parent is sent to the QObject constructor.
*/
QIviSearchAndBrowseModelInterface::QIviSearchAndBrowseModelInterface(QObject *parent)
: QIviFeatureInterface(*new QIviSearchAndBrowseModelInterfacePrivate(), parent)
{}
/*!
Returns all the available content types for this backend instance.
It's recommended to use the registerContentType() function instead, which takes care of this function for you.
*/
QSet<QString> QIviSearchAndBrowseModelInterface::availableContentTypes() const
{
Q_D(const QIviSearchAndBrowseModelInterface);
return d->m_types;
}
/*!
Returns the available identifiers for the given \a contentType.
Every identifier can be used in the \l {Qt IVI Query Language} for filtering or sorting.
It's recommended to use the registerContentType() function instead, which takes care of this function for you.
*/
QSet<QString> QIviSearchAndBrowseModelInterface::supportedIdentifiers(const QString &contentType) const
{
Q_D(const QIviSearchAndBrowseModelInterface);
return d->m_identifiers.values(contentType).toSet();
}
/*!
\fn template <class T> QIviSearchAndBrowseModelInterface::registerContentType(const QString &contentType)
Registers the type T with the name \a contentType.
In addition all properties of type T will be registered as identifiers for the \l {Qt IVI Query Language}
*/
/*!
\internal
*/
void QIviSearchAndBrowseModelInterface::registerContentType(const QMetaObject &object, const QString &contentType)
{
Q_D(QIviSearchAndBrowseModelInterface);
for (int i=0; i < object.propertyCount(); i++) {
QLatin1String propName(object.property(i).name());
if (propName != QLatin1String("objectName"))
d->m_identifiers.insert(contentType, propName);
}
d->m_types.insert(contentType);
}
/*!
\fn void QIviSearchAndBrowseModelInterface::fetchData(const QUuid &identifier, const QString &type, QIviAbstractQueryTerm *term, const QList<QIviOrderTerm> &orderTerms, int start, int count)
This function is called whenever new data of the given type \a type needs to be retrieved by a QIviSearchAndBrowseModel identified by \a identifier.
The \a term and \a orderTerms properties are representations of the query which is used for filtering and sorting. The \a term pointer is null when the backend
doesn't support filtering and sorting or when no query was defined in the QIviSearchAndBrowseModel instance.
The parameters \a start and \a count define the range of data which should be fetched. This method is expected to emit the dataFetched() signal once
the new data is ready.
\sa dataFetched()
*/
/*!
\fn bool QIviSearchAndBrowseModelInterface::canGoBack(const QUuid &identifier, const QString &type)
Returns true when the QIviSearchAndBrowseModel instance identified by \a identifier can go back and return to the previously shown data set.
The \a type parameter holds the currently displayed content type.
See \l Browsing for more information on how this is used.
\sa goBack()
*/
/*!
\fn QString QIviSearchAndBrowseModelInterface::goBack(const QUuid &identifier, const QString &type)
Requests to go back to the previous displayed data set of the QIviSearchAndBrowseModel instance identified by \a identifier.
The current content type is passed as \a type and the new content type should be returned.
See \l Browsing for more information on how this is used.
\sa canGoBack()
*/
/*!
\fn bool QIviSearchAndBrowseModelInterface::canGoForward(const QUuid &identifier, const QString &type, const QString &itemId)
Returns true when the QIviSearchAndBrowseModel instance identified by \a identifier and the current content type \a type has an
item identified by \a itemId and this item can be used to show a new set of data.
See \l Browsing for more information on how this is used.
\sa goForward
*/
/*!
\fn QString QIviSearchAndBrowseModelInterface::goForward(const QUuid &identifier, const QString &type, const QString &itemId)
Requests to go to the next data set of the QIviSearchAndBrowseModel instance identified by \a identifier and the current content type \a type.
The item which is used for the new set of data is passed as \a itemId and the new content type should be returned.
See \l Browsing for more information on how this is used.
\sa canGoForward()
*/
/*!
\fn QIviSearchAndBrowseModelInterface::insert(const QUuid &identifier, const QString &type, int index, const QIviSearchAndBrowseModelItem *item)
Adds the browsable \a item into the current dataset of the QIviSearchAndBrowseModel instance identified by \a identifier and the current content type \a type at \a index.
The provided item could be owned by another model or QML, because of that it's expected that the backend stores its internal representation.
\sa dataChanged()
*/
/*!
\fn QIviSearchAndBrowseModelInterface::remove(const QUuid &identifier, const QString &type, int index)
Removes the browsable item at position \a index from the current dataset of the QIviSearchAndBrowseModel instance identified by \a identifier and the current content type \a type.
\sa dataChanged()
*/
/*!
\fn QIviSearchAndBrowseModelInterface::move(const QUuid &identifier, const QString &type, int currentIndex, int newIndex)
Moves the browsable item at position \a currentIndex of the current dataset of the QIviSearchAndBrowseModel instance identified by \a identifier and the current content type \a type to the new position \a newIndex.
\sa dataChanged()
*/
/*!
\fn QIviSearchAndBrowseModelInterface::indexOf(const QUuid &identifier, const QString &type, const QIviSearchAndBrowseModelItem *item)
Determines the index of \a item in the model identified by \a identifier and \a type.
*/
/*!
\fn void QIviSearchAndBrowseModelInterface::supportedCapabilitiesChanged(const QUuid &identifier, QIviSearchAndBrowseModel::Capabilities capabilities)
Emitted when the \a capabilities of the model instance identified by \a identifier changed.
*/
/*!
\fn void QIviSearchAndBrowseModelInterface::countChanged(const QUuid &identifier, int newLength)
This signal is emitted when the current number of items in the QIviSearchAndBrowseModel instance identified by \a identifier changed.
The new number of items is returned as \a newLength.
This signal is expected to be emitted after the model instance has requested new data for the first time by calling fetchData() and
should be emitted before the data is returned by emitting the dataFetched() signal
\sa fetchData() dataFetched()
*/
/*!
\fn void QIviSearchAndBrowseModelInterface::dataFetched(const QUuid &identifier, const QList<QVariant> &data, int start, bool moreAvailable)
This signal is emitted as a result of a call to fetchData() and returns the requested data in the argument \a data to the QIviSearchAndBrowseModel instance identified by \a identifier.
The arguments \a start holds the index where the data starts and \a moreAvailable holds whether there is more data available and a new fetchData() call can be used to retrieve this data.
\sa fetchData() dataFetched()
*/
/*!
\fn void QIviSearchAndBrowseModelInterface::dataChanged(const QUuid &identifier, const QList<QVariant> &data, int start, int count)
This signal is emitted whenever the data in the QIviSearchAndBrowseModel instance identified by \a identifier changed and the model needs to be updated.
The new data is passed as \a data. The arguments \a start and \a count can be used to define the set of items which should be replaced with the new data.
For inserting a new item, the item is passed in \a data and \a start is used for where the item should be inserted, the \a count argument needs to be 0 as we don't want to replace existing data:
\code
QList<ExampleItem> list;
ExampleItem item = ExampleItem();
list.insert(index, item);
QVariantList items = { QVariant::fromValue(item) };
emit dataChanged(items, index, 0);
\endcode
Removing an item is very similar, \a start is used to indicate which item and \a count to indicate how much:
\code
list.removeAt(index);
emit dataChanged(identifier, QVariantList(), index, 1);
\endcode
\sa insert() remove() move()
*/
QT_END_NAMESPACE
|
