gwenview/lib/semanticinfo/sorteddirmodel.h

   1 /*
   2 Gwenview: an image viewer
   3 Copyright 2007 Aurélien Gâteau <aurelien.gateau@free.fr>
   4
   5 This program is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU General Public License
   7 as published by the Free Software Foundation; either version 2
   8 of the License, or (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18
  19 */
  20 #ifndef SORTEDDIRMODEL_H
  21 #define SORTEDDIRMODEL_H
  22
  23 #include <config-gwenview.h>
  24
  25 // Qt
  26 #include <QPointer>
  27
  28 // KDE
  29 #include <kdirsortfilterproxymodel.h>
  30
  31 // Local
  32 #include <lib/gwenviewlib_export.h>
  33
  34
  35 class KDateTime;
  36 class KDirLister;
  37 class KFileItem;
  38 class KUrl;
  39
  40 namespace Gwenview {
  41
  42 class AbstractSemanticInfoBackEnd;
  43 class SortedDirModelPrivate;
  44 class TagSet;
  45
  46 #ifndef GWENVIEW_SEMANTICINFO_BACKEND_NONE
  47 class SemanticInfo;
  48 #endif
  49
  50 class SortedDirModel;
  51 class GWENVIEWLIB_EXPORT AbstractSortedDirModelFilter : public QObject {
  52 public:
  53         AbstractSortedDirModelFilter(SortedDirModel* model);
  54         ~AbstractSortedDirModelFilter();
  55         SortedDirModel* model() const { return mModel; }
  56
  57         virtual bool needsSemanticInfo() const = 0;
  58         /**
  59          * Returns true if index should be accepted.
  60          * Warning: index is a source index of SortedDirModel
  61          */
  62         virtual bool acceptsIndex(const QModelIndex& index) const = 0;
  63
  64 private:
  65         QPointer<SortedDirModel> mModel;
  66 };
  67
  68 /**
  69  * This model makes it possible to show all images in a folder.
  70  * It can filter images based on name and metadata.
  71  */
  72 class GWENVIEWLIB_EXPORT SortedDirModel : public KDirSortFilterProxyModel {
  73         Q_OBJECT
  74 public:
  75         SortedDirModel(QObject* parent);
  76         ~SortedDirModel();
  77         KDirLister* dirLister();
  78         KFileItem itemForIndex(const QModelIndex& index) const;
  79         KFileItem itemForSourceIndex(const QModelIndex& sourceIndex) const;
  80         QModelIndex indexForItem(const KFileItem& item) const;
  81         QModelIndex indexForUrl(const KUrl& url) const;
  82
  83         /**
  84          * A list of file extensions we should skip
  85          */
  86         void setBlackListedExtensions(const QStringList& list);
  87
  88         virtual void setMimeExcludeFilter(const QStringList &mimeList);
  89
  90         void addFilter(AbstractSortedDirModelFilter*);
  91
  92         void removeFilter(AbstractSortedDirModelFilter*);
  93
  94         void reload();
  95
  96         AbstractSemanticInfoBackEnd* semanticInfoBackEnd() const;
  97
  98 #ifndef GWENVIEW_SEMANTICINFO_BACKEND_NONE
  99         SemanticInfo semanticInfoForSourceIndex(const QModelIndex& sourceIndex) const;
 100 #endif
 101
 102 public Q_SLOTS:
 103     void applyFilters();
 104
 105 protected:
 106         bool filterAcceptsRow(int row, const QModelIndex& parent) const;
 107         bool lessThan(const QModelIndex& left, const QModelIndex& right) const;
 108
 109 private Q_SLOTS:
 110         void doApplyFilters();
 111
 112 private:
 113         friend class SortedDirModelPrivate;
 114         SortedDirModelPrivate * const d;
 115 };
 116
 117 } // namespace
 118
 119 #endif /* SORTEDDIRMODEL_H */