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      * @return True
  59      * @reimp
  60      */
  61     virtual bool supportsGrouping() const;
  62
  63     /**
  64      * @return True
  65      * @reimp
  66      */
  67     virtual bool supportsSorting() const;
  68
  69     /** @reimp */
  70     virtual QMimeData* createMimeData(const QSet<int>& indexes) const;
  71
  72     /** @reimp */
  73     virtual int indexForKeyboardSearch(const QString& text, int startFromIndex = 0) const;
  74
  75     /** @reimp */
  76     virtual bool supportsDropping(int index) 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 Root item of all items.
 101      */
 102     KFileItem rootItem() const;
 103
 104     /**
 105      * Clears all items of the model.
 106      */
 107     void clear();
 108
 109     // TODO: "name" + "isDir" is default in ctor
 110     void setRoles(const QSet<QByteArray>& roles);
 111     QSet<QByteArray> roles() const;
 112
 113     bool setExpanded(int index, bool expanded);
 114     bool isExpanded(int index) const;
 115     bool isExpandable(int index) const;
 116
 117 protected:
 118     virtual void onGroupRoleChanged(const QByteArray& current, const QByteArray& previous);
 119     virtual void onSortRoleChanged(const QByteArray& current, const QByteArray& previous);
 120
 121 private slots:
 122     void slotCompleted();
 123     void slotCanceled();
 124     void slotNewItems(const KFileItemList& items);
 125     void slotItemsDeleted(const KFileItemList& items);
 126     void slotRefreshItems(const QList<QPair<KFileItem, KFileItem> >& items);
 127     void slotClear();
 128     void slotClear(const KUrl& url);
 129
 130     void dispatchPendingItemsToInsert();
 131
 132 private:
 133     void insertItems(const KFileItemList& items);
 134     void removeItems(const KFileItemList& items);
 135
 136     void removeExpandedItems();
 137
 138     enum Role {
 139         NoRole,
 140         NameRole,
 141         SizeRole,
 142         DateRole,
 143         PermissionsRole,
 144         OwnerRole,
 145         GroupRole,
 146         TypeRole,
 147         DestinationRole,
 148         PathRole,
 149         IsDirRole,
 150         IsExpandedRole,
 151         ExpansionLevelRole,
 152         RolesCount // Mandatory last entry
 153     };
 154
 155     void resetRoles();
 156
 157     Role roleIndex(const QByteArray& role) const;
 158
 159     QHash<QByteArray, QVariant> retrieveData(const KFileItem& item) const;
 160
 161     bool lessThan(const KFileItem& a, const KFileItem& b) const;
 162     void sort(const KFileItemList::iterator& start, const KFileItemList::iterator& end);
 163     int stringCompare(const QString& a, const QString& b) const;
 164
 165     /**
 166      * Compares the expansion level of both items. The "expansion level" is defined
 167      * by the number of parent directories. However simply comparing just the numbers
 168      * is not sufficient, it is also important to check the hierarchy for having
 169      * a correct order like shown in a tree.
 170      */
 171     int expansionLevelsCompare(const KFileItem& a, const KFileItem& b) const;
 172
 173     /**
 174      * Helper method for expansionLevelCompare().
 175      */
 176     QString subPath(const KFileItem& item,
 177                     const QString& itemPath,
 178                     int start,
 179                     bool* isDir) const;
 180
 181     bool useMaximumUpdateInterval() const;
 182
 183 private:
 184     QWeakPointer<KDirLister> m_dirLister;
 185
 186     bool m_naturalSorting;
 187     bool m_sortFoldersFirst;
 188
 189     Role m_groupRole;
 190     Role m_sortRole;
 191     Qt::CaseSensitivity m_caseSensitivity;
 192
 193     KFileItemList m_sortedItems;   // Allows O(1) access for KFileItemModel::fileItem(int index)
 194     QHash<KUrl, int> m_items;      // Allows O(1) access for KFileItemModel::index(const KFileItem& item)
 195     QList<QHash<QByteArray, QVariant> > m_data;
 196
 197     bool m_requestRole[RolesCount];
 198
 199     QTimer* m_minimumUpdateIntervalTimer;
 200     QTimer* m_maximumUpdateIntervalTimer;
 201     KFileItemList m_pendingItemsToInsert;
 202
 203     // Stores the smallest expansion level of the root-URL. Is required to calculate
 204     // the "expansionLevel" role in an efficient way. A value < 0 indicates that
 205     // it has not been initialized yet.
 206     mutable int m_rootExpansionLevel;
 207
 208     friend class KFileItemModelTest; // For unit testing
 209 };
 210
 211 #endif
 212
 213