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
|
#pragma once
#include <QItemDelegate>
#include <QList>
#include <QVector>
#include <QtSql>
#include "library/coverart.h"
#include "library/dao/settingsdao.h"
#include "track/track_decl.h"
#include "track/trackref.h"
/** Pure virtual (abstract) class that provides an interface for data models which
display track lists. */
class TrackModel {
public:
static const int kHeaderWidthRole = Qt::UserRole + 0;
static const int kHeaderNameRole = Qt::UserRole + 1;
TrackModel(const QSqlDatabase& db,
const char* settingsNamespace)
: m_db(db),
m_settingsNamespace(settingsNamespace),
m_iDefaultSortColumn(-1),
m_eDefaultSortOrder(Qt::AscendingOrder) {
}
virtual ~TrackModel() {}
// These enums are the bits in a bitvector. Any individual column cannot
// have a value other than 0, 1, 2, 4, or 8!
enum Capabilities {
TRACKMODELCAPS_NONE = 0x00000,
TRACKMODELCAPS_REORDER = 0x00001,
TRACKMODELCAPS_RECEIVEDROPS = 0x00002,
TRACKMODELCAPS_ADDTOPLAYLIST = 0x00004,
TRACKMODELCAPS_ADDTOCRATE = 0x00008,
TRACKMODELCAPS_ADDTOAUTODJ = 0x00010,
TRACKMODELCAPS_LOCKED = 0x00020,
TRACKMODELCAPS_EDITMETADATA = 0x00040,
TRACKMODELCAPS_LOADTODECK = 0x00080,
TRACKMODELCAPS_LOADTOSAMPLER = 0x00100,
TRACKMODELCAPS_LOADTOPREVIEWDECK = 0x00200,
TRACKMODELCAPS_REMOVE = 0x00400,
TRACKMODELCAPS_RESETPLAYED = 0x02000,
TRACKMODELCAPS_HIDE = 0x04000,
TRACKMODELCAPS_UNHIDE = 0x08000,
TRACKMODELCAPS_PURGE = 0x10000,
TRACKMODELCAPS_REMOVE_PLAYLIST = 0x20000,
TRACKMODELCAPS_REMOVE_CRATE = 0x40000,
};
typedef int CapabilitiesFlags; /** Enables us to do ORing */
// Note that these enum values are used literally by controller scripts and must never be changed!
// Both reordering or insertion of new enum variants is strictly forbidden!
// New variants must always be inserted between the last valid and before the terminating variant IdMax!
enum class SortColumnId : int {
Invalid = -1,
CurrentIndex = 0, // Column with the cursor on it
Artist = 1,
Title = 2,
Album = 3,
AlbumArtist = 4,
Year = 5,
Genre = 6,
Composer = 7,
Grouping = 8,
TrackNumber = 9,
FileType = 10,
NativeLocation = 11,
Comment = 12,
Duration = 13,
BitRate = 14,
Bpm = 15,
ReplayGain = 16,
DateTimeAdded = 17,
TimesPlayed = 18,
Rating = 19,
Key = 20,
Preview = 21,
CoverArt = 22,
Position = 23,
PlaylistId = 24,
Location = 25,
Filename = 26,
FileModifiedTime = 27,
FileCreationTime = 28,
SampleRate = 29,
Color = 30,
// IdMax terminates the list of columns, it must be always after the last item
IdMax,
IdMin = Artist,
NumOfIds = (IdMax - IdMin) + 1
};
// Deserialize and return the track at the given QModelIndex
// or TrackRef in this result set.
virtual TrackPointer getTrack(const QModelIndex& index) const = 0;
virtual TrackPointer getTrackByRef(const TrackRef& trackRef) const = 0;
// Gets the on-disk location of the track at the given location
// with Qt separator "/".
// Use QDir::toNativeSeparators() before displaying this to a user.
virtual QString getTrackLocation(const QModelIndex& index) const = 0;
// Gets the track ID of the track at the given QModelIndex
virtual TrackId getTrackId(const QModelIndex& index) const = 0;
virtual CoverInfo getCoverInfo(const QModelIndex& index) const = 0;
// Gets the rows of the track in the current result set. Returns an
// empty list if the track ID is not present in the result set.
virtual const QVector<int> getTrackRows(TrackId trackId) const = 0;
bool isTrackModel() { return true;}
virtual void search(const QString& searchText, const QString& extraFilter=QString()) = 0;
virtual const QString currentSearch() const = 0;
virtual bool isColumnInternal(int column) = 0;
// if no header state exists, we may hide some columns so that the user can
// reactivate them
virtual bool isColumnHiddenByDefault(int column) = 0;
virtual const QList<int>& showableColumns() const { return m_emptyColumns; }
virtual const QList<int>& searchColumns() const { return m_emptyColumns; }
virtual void removeTracks(const QModelIndexList& indices) {
Q_UNUSED(indices);
}
virtual void hideTracks(const QModelIndexList& indices) {
Q_UNUSED(indices);
}
virtual void unhideTracks(const QModelIndexList& indices) {
Q_UNUSED(indices);
}
virtual void purgeTracks(const QModelIndexList& indices) {
Q_UNUSED(indices);
}
virtual int addTracks(const QModelIndex& index, const QList<QString>& locations) {
Q_UNUSED(index);
Q_UNUSED(locations);
return 0;
}
virtual void moveTrack(const QModelIndex& sourceIndex,
const QModelIndex& destIndex) {
Q_UNUSED(sourceIndex);
Q_UNUSED(destIndex);
}
virtual bool isLocked() {
return false;
}
virtual QAbstractItemDelegate* delegateForColumn(const int i, QObject* pParent) {
Q_UNUSED(i);
Q_UNUSED(pParent);
return NULL;
}
virtual TrackModel::CapabilitiesFlags getCapabilities() const {
return TRACKMODELCAPS_NONE;
}
/*non-virtual*/ bool hasCapabilities(TrackModel::CapabilitiesFlags caps) const {
return (getCapabilities() & caps) == caps;
}
virtual QString getModelSetting(const QString& name) {
SettingsDAO settings(m_db);
QString key = m_settingsNamespace + "." + name;
return settings.getValue(key);
}
virtual bool setModelSetting(const QString& name, const QVariant& value) {
SettingsDAO settings(m_db);
QString key = m_settingsNamespace + "." + name;
return settings.setValue(key, value);
}
virtual int defaultSortColumn() const {
return m_iDefaultSortColumn;
}
virtual Qt::SortOrder defaultSortOrder() const {
return m_eDefaultSortOrder;
}
virtual void setDefaultSort(int sortColumn, Qt::SortOrder sortOrder) {
m_iDefaultSortColumn = sortColumn;
m_eDefaultSortOrder = sortOrder;
}
virtual bool isColumnSortable(int column) {
Q_UNUSED(column);
return true;
}
virtual SortColumnId sortColumnIdFromColumnIndex(int index) {
Q_UNUSED(index);
return TrackModel::SortColumnId::Invalid;
}
virtual int columnIndexFromSortColumnId(TrackModel::SortColumnId sortColumn) {
Q_UNUSED(sortColumn);
return -1;
}
virtual int fieldIndex(const QString& fieldName) const {
Q_UNUSED(fieldName);
return -1;
}
virtual void select() {
}
private:
QSqlDatabase m_db;
QString m_settingsNamespace;
QList<int> m_emptyColumns;
int m_iDefaultSortColumn;
Qt::SortOrder m_eDefaultSortOrder;
};
|
