src/kitemviews/kfileitemmodel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef KFILEITEMMODEL_H
  21 #define KFILEITEMMODEL_H
  22
  23 #include <libdolphin_export.h>
  24 #include <KFileItemList>
  25 #include <KUrl>
  26 #include <kitemviews/kitemmodelbase.h>
  27
  28 #include <QHash>
  29
  30 class KDirLister;
  31 class QTimer;
  32
  33 /**
  34  * @brief KItemModelBase implementation for KFileItems.
  35  *
  36  * KFileItemModel is connected with one KDirLister. Each time the KDirLister
  37  * emits new items, removes items or changes items the model gets synchronized.
  38  *
  39  * KFileItemModel supports sorting and grouping of items. Additional roles that
  40  * are not part of KFileItem can be added with KFileItemModel::setData().
  41  *
  42  * Also the recursive expansion of sub-directories is supported by
  43  * KFileItemModel::setExpanded().
  44  */
  45 class LIBDOLPHINPRIVATE_EXPORT KFileItemModel : public KItemModelBase
  46 {
  47     Q_OBJECT
  48
  49 public:
  50     explicit KFileItemModel(KDirLister* dirLister, QObject* parent = 0);
  51     virtual ~KFileItemModel();
  52
  53     virtual int count() const;
  54     virtual QHash<QByteArray, QVariant> data(int index) const;
  55     virtual bool setData(int index, const QHash<QByteArray, QVariant>& values);
  56
  57     /**
  58      * Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false).
  59      */
  60     void setSortFoldersFirst(bool foldersFirst);
  61     bool sortFoldersFirst() const;
  62
  63     /** @reimp */
  64     virtual QMimeData* createMimeData(const QSet<int>& indexes) const;
  65
  66     /** @reimp */
  67     virtual int indexForKeyboardSearch(const QString& text, int startFromIndex = 0) const;
  68
  69     /** @reimp */
  70     virtual bool supportsDropping(int index) const;
  71
  72     /** @reimp */
  73     virtual QString roleDescription(const QByteArray& role) const;
  74
  75     /** @reimp */
  76     virtual QList<QPair<int, QVariant> > groups() const;
  77
  78     /**
  79      * @return The file-item for the index \a index. If the index is in a valid
  80      *         range it is assured that the file-item is not null. The runtime
  81      *         complexity of this call is O(1).
  82      */
  83     KFileItem fileItem(int index) const;
  84
  85     /**
  86      * @return The file-item for the url \a url. If no file-item with the given
  87      *         URL is found KFileItem::isNull() will be true for the returned
  88      *         file-item. The runtime complexity of this call is O(1).
  89      */
  90     KFileItem fileItem(const KUrl& url) const;
  91
  92     /**
  93      * @return The index for the file-item \a item. -1 is returned if no file-item
  94      *         is found or if the file-item is null. The runtime
  95      *         complexity of this call is O(1).
  96      */
  97     int index(const KFileItem& item) const;
  98
  99     /**
 100      * @return The index for the URL \a url. -1 is returned if no file-item
 101      *         is found. The runtime complexity of this call is O(1).
 102      */
 103     int index(const KUrl& url) const;
 104
 105     /**
 106      * @return Root item of all items.
 107      */
 108     KFileItem rootItem() const;
 109
 110     /**
 111      * Clears all items of the model.
 112      */
 113     void clear();
 114
 115     // TODO: "name" + "isDir" is default in ctor
 116     void setRoles(const QSet<QByteArray>& roles);
 117     QSet<QByteArray> roles() const;
 118
 119     bool setExpanded(int index, bool expanded);
 120     bool isExpanded(int index) const;
 121     bool isExpandable(int index) const;
 122     QSet<KUrl> expandedUrls() const;
 123     void restoreExpandedUrls(const QSet<KUrl>& urls);
 124
 125 signals:
 126     void loadingCompleted();
 127
 128 protected:
 129     virtual void onGroupedSortingChanged(bool current);
 130     virtual void onSortRoleChanged(const QByteArray& current, const QByteArray& previous);
 131     virtual void onSortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous);
 132
 133 private slots:
 134     void slotCompleted();
 135     void slotCanceled();
 136     void slotNewItems(const KFileItemList& items);
 137     void slotItemsDeleted(const KFileItemList& items);
 138     void slotRefreshItems(const QList<QPair<KFileItem, KFileItem> >& items);
 139     void slotClear();
 140     void slotClear(const KUrl& url);
 141
 142     void dispatchPendingItemsToInsert();
 143
 144 private:
 145     void insertItems(const KFileItemList& items);
 146     void removeItems(const KFileItemList& items);
 147
 148     void resortAllItems();
 149
 150     void removeExpandedItems();
 151
 152     enum Role {
 153         NoRole,
 154         NameRole,
 155         SizeRole,
 156         DateRole,
 157         PermissionsRole,
 158         OwnerRole,
 159         GroupRole,
 160         TypeRole,
 161         DestinationRole,
 162         PathRole,
 163         IsDirRole,
 164         IsExpandedRole,
 165         ExpansionLevelRole,
 166         RolesCount // Mandatory last entry
 167     };
 168
 169     void resetRoles();
 170
 171     Role roleIndex(const QByteArray& role) const;
 172
 173     QHash<QByteArray, QVariant> retrieveData(const KFileItem& item) const;
 174
 175     bool lessThan(const KFileItem& a, const KFileItem& b) const;
 176     void sort(const KFileItemList::iterator& start, const KFileItemList::iterator& end);
 177     int stringCompare(const QString& a, const QString& b) const;
 178
 179     /**
 180      * Compares the expansion level of both items. The "expansion level" is defined
 181      * by the number of parent directories. However simply comparing just the numbers
 182      * is not sufficient, it is also important to check the hierarchy for having
 183      * a correct order like shown in a tree.
 184      */
 185     int expansionLevelsCompare(const KFileItem& a, const KFileItem& b) const;
 186
 187     /**
 188      * Helper method for expansionLevelCompare().
 189      */
 190     QString subPath(const KFileItem& item,
 191                     const QString& itemPath,
 192                     int start,
 193                     bool* isDir) const;
 194
 195     bool useMaximumUpdateInterval() const;
 196
 197     QList<QPair<int, QVariant> > nameRoleGroups() const;
 198     QList<QPair<int, QVariant> > sizeRoleGroups() const;
 199     QList<QPair<int, QVariant> > dateRoleGroups() const;
 200     QList<QPair<int, QVariant> > permissionRoleGroups() const;
 201     QList<QPair<int, QVariant> > ownerRoleGroups() const;
 202     QList<QPair<int, QVariant> > groupRoleGroups() const;
 203     QList<QPair<int, QVariant> > typeRoleGroups() const;
 204     QList<QPair<int, QVariant> > destinationRoleGroups() const;
 205     QList<QPair<int, QVariant> > pathRoleGroups() const;
 206
 207 private:
 208     QWeakPointer<KDirLister> m_dirLister;
 209
 210     bool m_naturalSorting;
 211     bool m_sortFoldersFirst;
 212
 213     Role m_sortRole;
 214     Qt::CaseSensitivity m_caseSensitivity;
 215
 216     KFileItemList m_sortedItems;   // Allows O(1) access for KFileItemModel::fileItem(int index)
 217     QHash<KUrl, int> m_items;      // Allows O(1) access for KFileItemModel::index(const KFileItem& item)
 218     QList<QHash<QByteArray, QVariant> > m_data;
 219
 220     bool m_requestRole[RolesCount];
 221
 222     QTimer* m_minimumUpdateIntervalTimer;
 223     QTimer* m_maximumUpdateIntervalTimer;
 224     KFileItemList m_pendingItemsToInsert;
 225     bool m_pendingEmitLoadingCompleted;
 226
 227     // Cache for KFileItemModel::groups()
 228     mutable QList<QPair<int, QVariant> > m_groups;
 229
 230     // Stores the smallest expansion level of the root-URL. Is required to calculate
 231     // the "expansionLevel" role in an efficient way. A value < 0 indicates that
 232     // it has not been initialized yet.
 233     mutable int m_rootExpansionLevel;
 234
 235     // Stores the URLs of the expanded folders.
 236     QSet<KUrl> m_expandedUrls;
 237
 238     // Stores the URLs which have to be expanded in order to restore a previous state of the model.
 239     QSet<KUrl> m_restoredExpandedUrls;
 240
 241     friend class KFileItemModelTest; // For unit testing
 242 };
 243
 244 #endif
 245
 246