#include <QHash>
#include <QList>
#include <QSet>
+#include <Solid/Predicate>
+#include <Solid/StorageAccess>
+class KBookmark;
class KBookmarkManager;
+class PlacesItem;
class QAction;
+class QTimer;
#ifdef HAVE_NEPOMUK
namespace Nepomuk
}
#endif
+// #define PLACESITEMMODEL_DEBUG
+
+/**
+ * @brief Model for maintaining the bookmarks of the places panel.
+ *
+ * It is compatible to the KFilePlacesModel from kdelibs but adds
+ * the ability to have groups for places.
+ */
class PlacesItemModel: public KStandardItemModel
{
Q_OBJECT
explicit PlacesItemModel(QObject* parent = 0);
virtual ~PlacesItemModel();
+ /**
+ * @return A new instance of a places item with the given
+ * attributes.
+ */
+ PlacesItem* createPlacesItem(const QString& text,
+ const KUrl& url,
+ const QString& iconName);
+
+ PlacesItem* placesItem(int index) const;
+
+ /**
+ * 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;
- int hiddenCount() const;
-
/**
- * @return True if the item is a default item created by
- * the system (e.g. the places for home, root, trash etc.)
+ * @return Number of items that are marked as hidden.
+ * Note that this does not mean that the items
+ * are really hidden
+ * (see PlacesItemModel::setHiddenItemsShown()).
*/
- bool isSystemItem(int index) const;
+ int hiddenCount() const;
/**
* Search the item which is equal to the URL or at least
*/
int closestItem(const KUrl& url) const;
+ QAction* ejectAction(int index) const;
+ QAction* teardownAction(int index) const;
+
+ void requestEject(int index);
+ void requestTeardown(int index);
+
/**
- * @return Name of the group where the item with the URL
- * \a URL belongs to.
+ * @return Converts the URL, which contains "virtual" URLs for system-items like
+ * "search:/documents" into a Nepomuk-Query-URL that will be handled by
+ * the corresponding IO-slave. Virtual URLs for bookmarks are used to
+ * be independent from internal format changes.
*/
- QString groupName(const KUrl& url) const;
+ static KUrl convertedUrl(const KUrl& url);
- QAction* ejectAction(int index) const;
- QAction* tearDownAction(int index) const;
+signals:
+ void errorMessage(const QString& message);
+
+protected:
+ virtual void onItemInserted(int index);
+ virtual void onItemRemoved(int index, KStandardItem* removedItem);
+ virtual void onItemChanged(int index, const QSet<QByteArray>& changedRoles);
+
+private slots:
+ void slotDeviceAdded(const QString& udi);
+ void slotDeviceRemoved(const QString& udi);
+ void slotStorageTeardownDone(Solid::ErrorType error, const QVariant& errorData);
+ void hideItem();
+
+ /**
+ * Updates the bookmarks from the model corresponding to the changed
+ * bookmarks stored by the bookmark-manager. Is called whenever the bookmarks
+ * have been changed by another application.
+ */
+ void updateBookmarks();
+
+ /**
+ * Saves the bookmarks and indicates to other applications that the
+ * state of the bookmarks has been changed. Is only called by the
+ * timeout of m_saveBookmarksTimer to prevent unnecessary savings.
+ */
+ void saveBookmarks();
private:
+ struct SystemBookmarkData;
+
+ /**
+ * Loads the bookmarks from the bookmark-manager and creates items for
+ * the model or moves hidden items to m_bookmarkedItems.
+ */
void loadBookmarks();
+ /**
+ * @return True, if the bookmark can be accepted in the context of the
+ * current application (e.g. bookmarks from other applications
+ * will be ignored).
+ */
+ bool acceptBookmark(const KBookmark& bookmark) const;
+
+ /**
+ * Creates a PlacesItem for a system-bookmark:
+ * - PlacesItem::isSystemItem() will return true
+ * - Default view-properties will be created for "Search For" items
+ * The item is not inserted to the model yet.
+ */
+ PlacesItem* createSystemPlacesItem(const SystemBookmarkData& data);
+
+ /**
+ * Creates system bookmarks that are shown per default and can
+ * only be hidden but not removed. The result will be stored
+ * in m_systemBookmarks.
+ */
void createSystemBookmarks();
- static QString placesGroupName();
- static QString recentlyAccessedGroupName();
- static QString searchForGroupName();
+ void initializeAvailableDevices();
+
+ /**
+ * @param index Item index related to the model.
+ * @return Corresponding index related to m_bookmarkedItems.
+ */
+ int bookmarkIndex(int index) const;
+
+ /**
+ * Marks the item with the index \a index as hidden and
+ * removes it from the model so that it gets invisible.
+ */
+ void hideItem(int index);
+
+ /**
+ * Triggers a delayed saving of bookmarks by starting
+ * m_saveBookmarksTimer.
+ */
+ void triggerBookmarksSaving();
- static KUrl translatedSystemBookmarkUrl(const KUrl& url);
+ /**
+ * @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);
/**
- * @return URL using the timeline-protocol for searching.
+ * @return URL using the timeline-protocol for searching (see convertedUrl()).
*/
static KUrl createTimelineUrl(const KUrl& url);
/**
* @return URL that can be listed by KIO and results in searching
* for a given term. The URL \a url represents a places-internal
- * URL like e.g. "search:/documents"
+ * URL like e.g. "search:/documents" (see convertedUrl()).
*/
static KUrl createSearchUrl(const KUrl& url);
static KUrl searchUrlForTerm(const Nepomuk::Query::Term& term);
#endif
+#ifdef PLACESITEMMODEL_DEBUG
+ void showModelState();
+#endif
+
private:
bool m_nepomukRunning;
bool m_hiddenItemsShown;
QSet<QString> m_availableDevices;
+ Solid::Predicate m_predicate;
KBookmarkManager* m_bookmarkManager;
struct SystemBookmarkData
{
SystemBookmarkData(const KUrl& url,
- const QString& icon,
- const QString& text,
- const QString& group) :
- url(url), icon(icon), text(text), group(group) {}
+ const QString& icon,
+ const QString& text) :
+ url(url), icon(icon), text(text) {}
KUrl url;
QString icon;
QString text;
- QString group;
};
QList<SystemBookmarkData> m_systemBookmarks;
QHash<KUrl, int> m_systemBookmarksIndexes;
+
+ // Contains hidden and unhidden items that are stored as
+ // bookmark (the model itself only contains items that
+ // are shown in the view). If an entry is 0, then the
+ // places-item is part of the model. If an entry is not
+ // 0, the item is hidden and not part of the model.
+ QList<PlacesItem*> m_bookmarkedItems;
+
+ // Index of the hidden item that should be removed in
+ // removeHiddenItem(). The removing must be done
+ // asynchronously as in the scope of onItemChanged()
+ // removing an item is not allowed.
+ int m_hiddenItemToRemove;
+
+ QTimer* m_saveBookmarksTimer;
+ QTimer* m_updateBookmarksTimer;
};
#endif
projects / dolphin.git / blobdiff