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
|
/*
* SPDX-FileCopyrightText: 2012 Peter Penz <[email protected]>
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef PLACESITEMMODEL_H
#define PLACESITEMMODEL_H
#include "kitemviews/kstandarditemmodel.h"
#include <KFilePlacesModel>
#include <Solid/Predicate>
#include <Solid/StorageAccess>
#include <QHash>
#include <QList>
#include <QSet>
#include <QUrl>
class KBookmark;
class PlacesItem;
class QAction;
/**
* @brief Model for maintaining the bookmarks of the places panel.
*
* It is based on KFilePlacesModel from KIO.
*/
class PlacesItemModel: public KStandardItemModel
{
Q_OBJECT
public:
explicit PlacesItemModel(QObject* parent = nullptr);
~PlacesItemModel() override;
/**
* @brief Create a new place entry in the bookmark file
* and add it to the model
*/
void createPlacesItem(const QString& text, const QUrl& url, const QString& iconName = {}, const QString& appName = {});
void createPlacesItem(const QString& text, const QUrl& url, const QString& iconName, const QString& appName, int after);
PlacesItem* placesItem(int index) const;
/**
* @brief Mark an item as hidden
* @param index of the item to be hidden
*/
void hideItem(int index);
/**
* If set to true, all items that are marked as hidden
* will be shown in the view. The items will
* stay marked as hidden, which is visually indicated
* by the view by desaturating the icon and the text.
*/
void setHiddenItemsShown(bool show);
bool hiddenItemsShown() const;
/**
* @return Number of items that are marked as hidden.
* Note that this does not mean that the items
* are really hidden
* (see PlacesItemModel::setHiddenItemsShown()).
*/
int hiddenCount() const;
/**
* Search the item which is equal to the URL or at least
* is a parent URL. If there are more than one possible
* candidates, return the item which covers the biggest
* range of the URL. -1 is returned if no closest item
* could be found.
*/
int closestItem(const QUrl& url) const;
QAction* ejectAction(int index) const;
QAction* teardownAction(int index) const;
void requestEject(int index);
void requestTearDown(int index);
bool storageSetupNeeded(int index) const;
void requestStorageSetup(int index);
QMimeData* createMimeData(const KItemSet& indexes) const override;
bool supportsDropping(int index) const override;
void dropMimeDataBefore(int index, const QMimeData* mimeData);
/**
* @return Converts the URL, which contains "virtual" URLs for system-items like
* "search:/documents" into a Query-URL that will be handled by
* the corresponding IO-slave. Virtual URLs for bookmarks are used to
* be independent from internal format changes.
*/
static QUrl convertedUrl(const QUrl& url);
void clear() override;
void proceedWithTearDown();
/**
* @brief Remove item from bookmark
*
* This function remove the index from bookmark file permanently
*
* @param index - the item to be removed
*/
void deleteItem(int index);
/**
* Force a sync on the bookmarks and indicates to other applications that the
* state of the bookmarks has been changed.
*/
void refresh();
bool isDir(int index) const override;
KFilePlacesModel::GroupType groupType(int row) const;
bool isGroupHidden(KFilePlacesModel::GroupType type) const;
void setGroupHidden(KFilePlacesModel::GroupType type, bool hidden);
signals:
void errorMessage(const QString& message);
void storageSetupDone(int index, bool success);
void storageTearDownRequested(const QString& mountPath);
void storageTearDownExternallyRequested(const QString& mountPath);
void storageTearDownSuccessful();
protected:
void onItemInserted(int index) override;
void onItemRemoved(int index, KStandardItem* removedItem) override;
void onItemChanged(int index, const QSet<QByteArray>& changedRoles) override;
private slots:
void slotStorageTearDownDone(Solid::ErrorType error, const QVariant& errorData);
void slotStorageSetupDone(Solid::ErrorType error, const QVariant& errorData, const QString& udi);
// source model control
void onSourceModelRowsInserted(const QModelIndex &parent, int first, int last);
void onSourceModelRowsAboutToBeRemoved(const QModelIndex &parent, int first, int last);
void onSourceModelRowsAboutToBeMoved(const QModelIndex &parent, int start, int end, const QModelIndex &destination, int row);
void onSourceModelRowsMoved(const QModelIndex &parent, int start, int end, const QModelIndex &destination, int row);
void onSourceModelDataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector<int> &roles);
void onSourceModelGroupHiddenChanged(KFilePlacesModel::GroupType group, bool hidden);
private:
/**
* Remove bookmarks created by the previous version of dolphin that are
* not valid anymore
*/
void cleanupBookmarks();
/**
* Loads the bookmarks from the bookmark-manager and creates items for
* the model or moves hidden items to m_bookmarkedItems.
*/
void loadBookmarks();
QString internalMimeType() const;
/**
* @return Adjusted drop index which assures that the item is aligned
* into the same group as specified by PlacesItem::groupType().
*/
int groupedDropIndex(int index, const PlacesItem* item) const;
/**
* @return True if the bookmarks have the same identifiers. The identifier
* is the unique "ID"-property in case if no UDI is set, otherwise
* the UDI is used as identifier.
*/
static bool equalBookmarkIdentifiers(const KBookmark& b1, const KBookmark& b2);
/**
* Appends the item \a item as last element of the group
* the item belongs to. If no item with the same group is
* present, the item gets appended as last element of the
* model. PlacesItemModel takes the ownership
* of the item.
*/
void insertSortedItem(PlacesItem* item);
PlacesItem *itemFromBookmark(const KBookmark &bookmark) const;
void addItemFromSourceModel(const QModelIndex &index);
void removeItemByIndex(const QModelIndex &mapToSource);
QString bookmarkId(const KBookmark &bookmark) const;
void initializeDefaultViewProperties() const;
int mapFromSource(const QModelIndex &index) const;
QModelIndex mapToSource(int row) const;
static void updateItem(PlacesItem *item, const QModelIndex &index);
private:
bool m_hiddenItemsShown;
Solid::StorageAccess *m_deviceToTearDown;
QHash<QObject*, int> m_storageSetupInProgress;
KFilePlacesModel *m_sourceModel;
QVector<QPersistentModelIndex> m_indexMap;
};
#endif
|
