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     /**
  73      * @return The file-item for the index \a index. If the index is in a valid
  74      *         range it is assured that the file-item is not null. The runtime
  75      *         complexity of this call is O(1).
  76      */
  77     KFileItem fileItem(int index) const;
  78
  79     /**
  80      * @return The index for the file-item \a item. -1 is returned if no file-item
  81      *         is found or if the file-item is null. The runtime
  82      *         complexity of this call is O(1).
  83      */
  84     int index(const KFileItem& item) const;
  85
  86     /**
  87      * Clears all items of the model.
  88      */
  89     void clear();
  90
  91     // TODO: "name" + "isDir" is default in ctor
  92     void setRoles(const QSet<QByteArray>& roles);
  93     QSet<QByteArray> roles() const;
  94
  95     bool setExpanded(int index, bool expanded);
  96     bool isExpanded(int index) const;
  97     bool isExpandable(int index) const;
  98
  99 protected:
 100     virtual void onGroupRoleChanged(const QByteArray& current, const QByteArray& previous);
 101     virtual void onSortRoleChanged(const QByteArray& current, const QByteArray& previous);
 102
 103 private slots:
 104     void slotCompleted();
 105     void slotCanceled();
 106     void slotNewItems(const KFileItemList& items);
 107     void slotItemsDeleted(const KFileItemList& items);
 108     void slotClear();
 109     void slotClear(const KUrl& url);
 110
 111     void dispatchPendingItems();
 112
 113 private:
 114     void insertItems(const KFileItemList& items);
 115     void removeItems(const KFileItemList& items);
 116
 117     void removeExpandedItems();
 118
 119     enum Role {
 120         NoRole,
 121         NameRole,
 122         SizeRole,
 123         DateRole,
 124         PermissionsRole,
 125         OwnerRole,
 126         GroupRole,
 127         TypeRole,
 128         DestinationRole,
 129         PathRole,
 130         IsDirRole,
 131         IsExpandedRole,
 132         ExpansionLevelRole,
 133         RolesCount // Mandatory last entry
 134     };
 135
 136     void resetRoles();
 137
 138     Role roleIndex(const QByteArray& role) const;
 139
 140     QHash<QByteArray, QVariant> retrieveData(const KFileItem& item) const;
 141
 142     bool lessThan(const KFileItem& a, const KFileItem& b) const;
 143     void sort(const KFileItemList::iterator& start, const KFileItemList::iterator& end);
 144     int stringCompare(const QString& a, const QString& b) const;
 145
 146     /**
 147      * Compares the expansion level of both items. The "expansion level" is defined
 148      * by the number of parent directories. However simply comparing just the numbers
 149      * is not sufficient, it is also important to check the hierarchy for having
 150      * a correct order like shown in a tree.
 151      */
 152     int expansionLevelsCompare(const KFileItem& a, const KFileItem& b) const;
 153
 154     /**
 155      * Helper method for expansionLevelCompare().
 156      */
 157     QString subPath(const KFileItem& item,
 158                     const QString& itemPath,
 159                     int start,
 160                     bool* isDir) const;
 161
 162     bool useMaximumUpdateInterval() const;
 163
 164 private:
 165     QWeakPointer<KDirLister> m_dirLister;
 166
 167     bool m_naturalSorting;
 168     bool m_sortFoldersFirst;
 169
 170     Role m_groupRole;
 171     Role m_sortRole;
 172     Qt::CaseSensitivity m_caseSensitivity;
 173
 174     KFileItemList m_sortedItems;   // Allows O(1) access for KFileItemModel::fileItem(int index)
 175     QHash<KFileItem, int> m_items; // Allows O(1) access for KFileItemModel::index(const KFileItem& item)
 176     QList<QHash<QByteArray, QVariant> > m_data;
 177
 178     bool m_requestRole[RolesCount];
 179
 180     QTimer* m_minimumUpdateIntervalTimer;
 181     QTimer* m_maximumUpdateIntervalTimer;
 182     KFileItemList m_pendingItemsToInsert;
 183     KFileItemList m_pendingItemsToDelete;
 184
 185     // Stores the smallest expansion level of the root-URL. Is required to calculate
 186     // the "expansionLevel" role in an efficient way. A value < 0 indicates that
 187     // it has not been initialized yet.
 188     mutable int m_rootExpansionLevel;
 189
 190     friend class KFileItemModelTest; // For unit testing
 191 };
 192
 193 #endif
 194
 195