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