workspace/plasma/shells/common/kcategorizeditemsviewmodels_p.h

   1 /*
   2  *   Copyright (C) 2007 Ivan Cukic <ivan.cukic+kde@gmail.com>
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU Library/Lesser General Public License
   6  *   version 2, or (at your option) any later version, as published by the
   7  *   Free Software Foundation
   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 Library/Lesser General Public
  15  *   License 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 PLASMA_KCATEGORIZEDITEMSVIEWMODELS_P_H
  21 #define PLASMA_KCATEGORIZEDITEMSVIEWMODELS_P_H
  22
  23 #include <QtGui/QtGui>
  24 #include <QtCore/QtCore>
  25 #include <KIcon>
  26 #include <KDebug>
  27 namespace KCategorizedItemsViewModels {
  28
  29 typedef QPair<QString, QVariant> Filter;
  30
  31 /**
  32  * Abstract class that needs to be implemented and used with the ItemModel
  33  */
  34 class AbstractItem : public QStandardItem
  35 {
  36 public:
  37     /**
  38      * Returns a localized string - name of the item
  39      */
  40     virtual QString name() const;
  41
  42     /**
  43      * Returns a localized string - description of the item
  44      */
  45     virtual QString description() const;
  46
  47     /**
  48      * Returns if the item is flagged as favorite
  49      * Default implementation checks if the item passes the Filter("favorite", "1") filter
  50      */
  51     virtual bool isFavorite() const;
  52
  53     /**
  54      * Returns the item's number of running applets
  55      * Default implementation just returns 0
  56      */
  57     virtual int running() const;
  58
  59     /**
  60      * Returns if the item contains string specified by pattern.
  61      * Default implementation checks whether name or description contain the
  62      * string (not needed to be exactly that string)
  63      */
  64     virtual bool matches(const QString &pattern) const;
  65
  66     /**
  67      * sets the favorite flag for the item
  68      */
  69     virtual void setFavorite(bool favorite) = 0;
  70     /**
  71      * sets the number of running applets for the item
  72      */
  73     virtual void setRunning(int count) = 0;
  74
  75     /**
  76      * Returns if the item passes the filter specified
  77      */
  78     virtual bool passesFiltering(const Filter &filter) const = 0;
  79 private:
  80 };
  81
  82 /**
  83  * The default implementation of the model containing filters
  84  */
  85 class DefaultFilterModel : public QStandardItemModel
  86 {
  87 public:
  88     DefaultFilterModel(QObject *parent = 0);
  89
  90     /**
  91      * Adds a filter to the model
  92      * @param caption The localized string to be displayed as a name of the filter
  93      * @param filter The filter structure
  94      */
  95     void addFilter(const QString &caption, const Filter &filter, const KIcon &icon = KIcon());
  96
  97     /**
  98      * Adds a separator to the model
  99      * @param caption The localized string to be displayed as a name of the separator
 100      */
 101     void addSeparator(const QString &caption);
 102 };
 103
 104 /**
 105  * Default filter proxy model.
 106  */
 107 class DefaultItemFilterProxyModel : public QSortFilterProxyModel
 108 {
 109 Q_OBJECT
 110
 111 public:
 112     DefaultItemFilterProxyModel(QObject *parent = 0);
 113
 114     bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const;
 115     bool lessThan(const QModelIndex &left, const QModelIndex &right) const;
 116
 117     void setSearch(const QString &pattern);
 118     void setFilter(const Filter &filter);
 119
 120     void setSourceModel(QAbstractItemModel *sourceModel);
 121
 122     QStandardItemModel *sourceModel() const;
 123
 124     int columnCount(const QModelIndex &index) const;
 125
 126     QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
 127
 128 Q_SIGNALS:
 129     void searchTermChanged(const QString &term);
 130
 131 private:
 132
 133     class InnerProxyModel : public QAbstractItemModel
 134     {
 135     public:
 136         InnerProxyModel(QObject *parent = 0);
 137
 138         Qt::ItemFlags flags(const QModelIndex &index) const;
 139
 140         QVariant data(const QModelIndex &index, bool favoriteColumn,
 141                       int role = Qt::DisplayRole) const;
 142         QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
 143         bool setData(const QModelIndex &index, const QVariant &value,
 144                      int role = Qt::EditRole);
 145
 146         QVariant headerData(int section, Qt::Orientation orientation,
 147                             int role = Qt::DisplayRole) const;
 148         bool setHeaderData(int section, Qt::Orientation orientation,
 149                            const QVariant &value, int role = Qt::EditRole);
 150
 151         int rowCount(const QModelIndex &parent = QModelIndex()) const;
 152         int columnCount(const QModelIndex &index) const;
 153
 154         QModelIndex index(int row, int column,
 155                           const QModelIndex &parent = QModelIndex()) const;
 156         QModelIndex parent(const QModelIndex &index) const;
 157
 158         QMimeData *mimeData(const QModelIndexList &indexes) const;
 159
 160         void setSourceModel(QStandardItemModel *sourceModel);
 161         QStandardItemModel *sourceModel() const;
 162
 163     private:
 164         QStandardItemModel *m_sourceModel;
 165     };
 166
 167     Filter m_filter;
 168     QString m_searchPattern;
 169     InnerProxyModel m_innerModel;
 170
 171 };
 172
 173 /**
 174  * The default implementation of the model containing items. It /is/ QStandardItemModel
 175  */
 176 class DefaultItemModel : public QStandardItemModel
 177 {
 178 public:
 179     DefaultItemModel(QObject *parent = 0);
 180 };
 181
 182 }
 183
 184 Q_DECLARE_METATYPE(KCategorizedItemsViewModels::Filter)
 185
 186 #endif /*KCATEGORIZEDITEMSVIEWMODELS_H_*/