X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/a4ede4e0ebaf0bba57da8fc2924577f1a8ff7b54..40c71d5ce0f6978ce48eb67fd73ed211bab4e887:/src/kitemviews/kfileitemmodel.h diff --git a/src/kitemviews/kfileitemmodel.h b/src/kitemviews/kfileitemmodel.h index 4824dec3d..b29c76c92 100644 --- a/src/kitemviews/kfileitemmodel.h +++ b/src/kitemviews/kfileitemmodel.h @@ -23,62 +23,80 @@ #include #include #include -#include #include +#include #include -class KDirLister; +class KFileItemModelDirLister; class QTimer; /** * @brief KItemModelBase implementation for KFileItems. * - * KFileItemModel is connected with one KDirLister. Each time the KDirLister - * emits new items, removes items or changes items the model gets synchronized. + * Allows to load items of a directory. Sorting and grouping of + * items are supported. Roles that are not part of KFileItem can + * be added with KFileItemModel::setData(). * - * KFileItemModel supports sorting and grouping of items. Additional roles that - * are not part of KFileItem can be added with KFileItemModel::setData(). - * - * Also the recursive expansion of sub-directories is supported by + * Recursive expansion of sub-directories is supported by * KFileItemModel::setExpanded(). - * - * TODO: In the longterm instead of passing a KDirLister just an URL should - * be passed and a KDirLister used internally. This solves the following issues: - * - The user of the API does not need to decide whether he listens to KDirLister - * or KFileItemModel. - * - It resolves minor conceptual differences between KDirLister and KFileItemModel. - * E.g. there is no way for KFileItemModel to check whether a completed() signal - * will be emitted after newItems() will be send by KDirLister or not (in the case - * of setShowingDotFiles() no completed() signal will get emitted). */ class LIBDOLPHINPRIVATE_EXPORT KFileItemModel : public KItemModelBase { Q_OBJECT public: - explicit KFileItemModel(KDirLister* dirLister, QObject* parent = 0); + explicit KFileItemModel(QObject* parent = 0); virtual ~KFileItemModel(); + /** + * Loads the directory specified by \a url. The signals + * directoryLoadingStarted(), directoryLoadingProgress() and directoryLoadingCompleted() + * indicate the current state of the loading process. The items + * of the directory are added after the loading has been completed. + */ + void loadDirectory(const KUrl& url); + + /** + * Throws away all currently loaded items and refreshes the directory + * by reloading all items again. + */ + void refreshDirectory(const KUrl& url); + + /** + * @return Parent directory of the items that are shown. In case + * if a directory tree is shown, KFileItemModel::dir() returns + * the root-parent of all items. + * @see rootItem() + */ + KUrl directory() const; + + /** + * Cancels the loading of a directory which has been started by either + * loadDirectory() or refreshDirectory(). + */ + void cancelDirectoryLoading(); + virtual int count() const; virtual QHash data(int index) const; virtual bool setData(int index, const QHash& values); /** - * Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). + * Sets a separate sorting with directories first (true) or a mixed + * sorting of files and directories (false). */ - void setSortFoldersFirst(bool foldersFirst); - bool sortFoldersFirst() const; + void setSortDirectoriesFirst(bool dirsFirst); + bool sortDirectoriesFirst() const; void setShowHiddenFiles(bool show); bool showHiddenFiles() const; /** - * If set to true, only folders are shown as items of the model. Files + * If set to true, only directories are shown as items of the model. Files * are ignored. */ - void setShowFoldersOnly(bool enabled); - bool showFoldersOnly() const; + void setShowDirectoriesOnly(bool enabled); + bool showDirectoriesOnly() const; /** @reimp */ virtual QMimeData* createMimeData(const QSet& indexes) const; @@ -123,7 +141,8 @@ public: int index(const KUrl& url) const; /** - * @return Root item of all items. + * @return Root item of all items representing the item + * for KFileItemModel::dir(). */ KFileItem rootItem() const; @@ -132,7 +151,9 @@ public: */ void clear(); - // TODO: "name" + "isDir" is default in ctor + /** + * Sets the roles that should be shown for each item. + */ void setRoles(const QSet& roles); QSet roles() const; @@ -141,19 +162,19 @@ public: virtual bool isExpandable(int index) const; virtual int expandedParentsCount(int index) const; - QSet expandedUrls() const; + QSet expandedDirectories() const; /** - * Marks the URLs in \a urls as subfolders which were expanded previously. - * They are re-expanded one by one each time the KDirLister's completed() signal is received. - * Note that a manual triggering of the KDirLister is required. + * Marks the URLs in \a urls as sub-directories which were expanded previously. + * After calling loadDirectory() or refreshDirectory() the marked sub-directories + * will be expanded step-by-step. */ - void restoreExpandedUrls(const QSet& urls); + void restoreExpandedDirectories(const QSet& urls); /** - * Expands all parent-items of \a url. + * Expands all parent-directories of the item \a url. */ - void expandParentItems(const KUrl& url); + void expandParentDirectories(const KUrl& url); void setNameFilter(const QString& nameFilter); QString nameFilter() const; @@ -175,6 +196,14 @@ public: static QList rolesInformation(); signals: + /** + * Is emitted if the loading of a directory has been started. It is + * assured that a signal directoryLoadingCompleted() will be send after + * the loading has been finished. For tracking the loading progress + * the signal directoryLoadingProgress() gets emitted in between. + */ + void directoryLoadingStarted(); + /** * Is emitted after the loading of a directory has been completed or new * items have been inserted to an already loaded directory. Usually @@ -182,7 +211,38 @@ signals: * (the only exception is loading an empty directory, where only a * loadingCompleted() signal gets emitted). */ - void loadingCompleted(); + void directoryLoadingCompleted(); + + /** + * Informs about the progress in percent when loading a directory. It is assured + * that the signal directoryLoadingStarted() has been emitted before. + */ + void directoryLoadingProgress(int percent); + + /** + * Is emitted if the sort-role gets resolved asynchronously and provides + * the progress-information of the sorting in percent. It is assured + * that the last sortProgress-signal contains 100 as value. + */ + void directorySortingProgress(int percent); + + /** + * Is emitted if an information message (e.g. "Connecting to host...") + * should be shown. + */ + void infoMessage(const QString& message); + + /** + * Is emitted if an error message (e.g. "Unknown location") + * should be shown. + */ + void errorMessage(const QString& message); + + /** + * Is emitted if a redirection from the current URL \a oldUrl + * to the new URL \a newUrl has been done. + */ + void directoryRedirection(const KUrl& oldUrl, const KUrl& newUrl); protected: virtual void onGroupedSortingChanged(bool current); @@ -274,30 +334,6 @@ private: */ int sortRoleCompare(const ItemData* a, const ItemData* b) const; - /** - * Sorts the items by using lessThan() as comparison criteria. - * The merge sort algorithm is used to assure a worst-case - * of O(n * log(n)) and to keep the number of comparisons low. - */ - void sort(QList::iterator begin, QList::iterator end); - - /** Helper method for sort(). */ - void merge(QList::iterator begin, - QList::iterator pivot, - QList::iterator end); - - /** Helper method for sort(). */ - QList::iterator lowerBound(QList::iterator begin, - QList::iterator end, - const ItemData* value); - - /** Helper method for sort(). */ - QList::iterator upperBound(QList::iterator begin, - QList::iterator end, - const ItemData* value); - /** Helper method for sort(). */ - void reverse(QList::iterator begin, QList::iterator end); - int stringCompare(const QString& a, const QString& b) const; /** @@ -340,6 +376,12 @@ private: */ KFileItemList childItems(const KFileItem& item) const; + /** + * Is invoked by KFileItemModelRolesUpdater and results in emitting the + * sortProgress signal with a percent-value of the progress. + */ + void emitSortProgress(int resolvedCount); + /** * Maps the QByteArray-roles to RoleTypes and provides translation- and * group-contexts. @@ -361,13 +403,20 @@ private: */ static const RoleInfoMap* rolesInfoMap(int& count); + /** + * Determines the MIME-types of all items that can be done within + * the given timeout. + */ + static void determineMimeTypes(const KFileItemList& items, int timeout); + private: - QWeakPointer m_dirLister; + KFileItemModelDirLister* m_dirLister; bool m_naturalSorting; - bool m_sortFoldersFirst; + bool m_sortDirsFirst; RoleType m_sortRole; + int m_sortingProgressPercent; // Value of directorySortingProgress() signal QSet m_roles; Qt::CaseSensitivity m_caseSensitivity; @@ -401,14 +450,16 @@ private: }; mutable int m_expandedParentsCountRoot; - // Stores the URLs of the expanded folders. - QSet m_expandedUrls; + // Stores the URLs of the expanded directories. + QSet m_expandedDirs; // URLs that must be expanded. The expanding is initially triggered in setExpanded() // and done step after step in slotCompleted(). QSet m_urlsToExpand; - friend class KFileItemModelTest; // For unit testing + friend class KFileItemModelSortAlgorithm; // Accesses lessThan() method + friend class KFileItemModelRolesUpdater; // Accesses emitSortProgress() method + friend class KFileItemModelTest; // For unit testing }; inline bool KFileItemModel::isChildItem(int index) const