summaryrefslogtreecommitdiff
path: root/src/ivicore/qivistandarditem.cpp
blob: 2b49f1c7570ead6fb1a4226aea60846c9ce8cb7c (plain)
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
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Copyright (C) 2019 Luxoft Sweden AB
** 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$
** 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 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$
**
****************************************************************************/

#include "qivistandarditem.h"

QT_BEGIN_NAMESPACE

class QIviStandardItemPrivate : public QSharedData
{
public:
    QIviStandardItemPrivate() = default;
    QIviStandardItemPrivate(const QIviStandardItemPrivate &other) = default;

    QString m_id;
    QVariantMap m_data;
};

/*!
    \class QIviStandardItem
    \inmodule QtIviCore
    \brief The QIviStandardItem is the base class of a row in the QIviPagingModel model and derived models.
*/

/*!
    \qmltype StandardItem
    \qmlabstract
    \instantiates QIviStandardItem
    \inqmlmodule QtIvi
    \brief The StandardItem is the base class of a row in the PagingModel and derived models.

    \note This item is not creatable from QML.
*/

/*!
    \qmlproperty string StandardItem::id
    A unique identifier, which can be used to identify this item.

    This is mainly used by the backend to implement filtering or browsing.
*/

/*!
    \property QIviStandardItem::id
    A unique identifier, which can be used to identify this item.

    This is mainly used by the backend to implement filtering or browsing.
*/

/*!
    \qmlproperty string StandardItem::name
    The name of the item. E.g. The name of a contact in a addressbook, or the artist-name in a list of artists.
*/

/*!
    \property QIviStandardItem::name
    The name of the item. E.g. The name of a contact in a addressbook, or the artist-name in a list of artists.
*/

/*!
    \qmlproperty string StandardItem::type
    The type of the item. E.g. "artist", "track", "contact".
*/

/*!
    \property QIviStandardItem::type
    The type of the item. E.g. "artist", "track", "contact".
*/

/*!
    \qmlproperty object StandardItem::data
    A generic data field which can hold any data.

    This can be moved for storing additional data which is not part of the base class.
    E.g. the "composer" of an audio track.
*/

/*!
    \property QIviStandardItem::data
    A generic data field which can hold any data.

    This can be moved for storing additional data which is not part of the base class.
    E.g. the "composer" of an audio track.
*/

QIviStandardItem::QIviStandardItem()
    : d(new QIviStandardItemPrivate)
{

}

//defined here as a inline default copy constructor leads to compilation errors
QIviStandardItem::QIviStandardItem(const QIviStandardItem &rhs) = default;

QIviStandardItem &QIviStandardItem::operator=(const QIviStandardItem &rhs)
{
    if (this != &rhs)
        d.operator=(rhs.d);
    return *this;
}

//defined here as a inline default destructor leads to compilation errors
QIviStandardItem::~QIviStandardItem() = default;

QString QIviStandardItem::id() const
{
    return d->m_id;
}

void QIviStandardItem::setId(const QString &id)
{
    d->m_id = id;
}

QString QIviStandardItem::name() const
{
    return QString();
}

QString QIviStandardItem::type() const
{
    return QString();
}

QVariantMap QIviStandardItem::data() const
{
    return d->m_data;
}

void QIviStandardItem::setData(const QVariantMap &data)
{
    d->m_data = data;
}

/*!
    Returns \e true if this item is equal to \a other; otherwise returns false.

    \sa operator!=()
*/
bool QIviStandardItem::operator==(const QIviStandardItem &other) const
{
    return (d->m_id == other.d->m_id);
}

/*!
    \fn bool QIviStandardItem::operator!=(const QIviStandardItem &other)

    Returns \e true if this item is not equal to \a other; otherwise returns false.

    \sa operator==()
*/

QT_END_NAMESPACE