src/client/treemodel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 by the Quassel Project                          *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   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                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef _TREEMODEL_H_
  22 #define _TREEMODEL_H_
  23
  24 #include <QList>
  25 #include <QStringList>
  26 #include <QVariant>
  27 #include <QHash>
  28 #include <QAbstractItemModel>
  29
  30 #include <QLinkedList> // needed for debug
  31
  32 /*****************************************
  33  *  general item used in the Tree Model
  34  *****************************************/
  35 class AbstractTreeItem : public QObject {
  36   Q_OBJECT
  37   Q_PROPERTY(quint64 id READ id)
  38
  39 public:
  40   AbstractTreeItem(AbstractTreeItem *parent = 0);
  41   virtual ~AbstractTreeItem();
  42
  43   bool newChild(AbstractTreeItem *child);
  44   bool newChilds(const QList<AbstractTreeItem *> &items);
  45
  46   bool removeChild(int row);
  47   bool removeChildById(const quint64 &id);
  48   void removeAllChilds();
  49
  50   virtual quint64 id() const;
  51
  52   bool reParent(AbstractTreeItem *newParent);
  53
  54   AbstractTreeItem *child(int row) const;
  55   AbstractTreeItem *childById(const quint64 &id) const;
  56
  57   int childCount(int column = 0) const;
  58
  59   virtual int columnCount() const = 0;
  60
  61   virtual QVariant data(int column, int role) const = 0;
  62   virtual bool setData(int column, const QVariant &value, int role) = 0;
  63
  64   virtual Qt::ItemFlags flags() const;
  65   virtual void setFlags(Qt::ItemFlags);
  66
  67   int row() const;
  68   AbstractTreeItem *parent() const;
  69
  70   void dumpChildList();
  71
  72 signals:
  73   void dataChanged(int column = -1);
  74
  75   void beginAppendChilds(int firstRow, int lastRow);
  76   void endAppendChilds();
  77
  78   void beginRemoveChilds(int firstRow, int lastRow);
  79   void endRemoveChilds();
  80
  81 private:
  82   QList<AbstractTreeItem *> _childItems;
  83   Qt::ItemFlags _flags;
  84 };
  85
  86
  87 /*****************************************
  88  * SimpleTreeItem
  89  *****************************************/
  90 class SimpleTreeItem : public AbstractTreeItem {
  91   Q_OBJECT
  92
  93 public:
  94   SimpleTreeItem(const QList<QVariant> &data, AbstractTreeItem *parent = 0);
  95   virtual ~SimpleTreeItem();
  96
  97   virtual QVariant data(int column, int role) const;
  98   virtual bool setData(int column, const QVariant &value, int role);
  99
 100   virtual int columnCount() const;
 101
 102 private:
 103   QList<QVariant> _itemData;
 104 };
 105
 106 /*****************************************
 107  * PropertyMapItem
 108  *****************************************/
 109 class PropertyMapItem : public AbstractTreeItem {
 110   Q_OBJECT
 111
 112 public:
 113   PropertyMapItem(const QStringList &propertyOrder, AbstractTreeItem *parent = 0);
 114   PropertyMapItem(AbstractTreeItem *parent = 0);
 115
 116   virtual ~PropertyMapItem();
 117
 118   virtual QVariant data(int column, int role) const;
 119   virtual bool setData(int column, const QVariant &value, int role);
 120
 121   virtual QString toolTip(int column) const { Q_UNUSED(column) return QString(); }
 122   virtual int columnCount() const;
 123
 124   void appendProperty(const QString &property);
 125
 126 private:
 127   QStringList _propertyOrder;
 128 };
 129
 130
 131 /*****************************************
 132  * TreeModel
 133  *****************************************/
 134 class TreeModel : public QAbstractItemModel {
 135   Q_OBJECT
 136
 137 public:
 138   enum myRoles {
 139     SortRole = Qt::UserRole,
 140     UserRole
 141   };
 142
 143   TreeModel(const QList<QVariant> &, QObject *parent = 0);
 144   virtual ~TreeModel();
 145
 146   virtual QVariant data(const QModelIndex &index, int role) const;
 147   virtual bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole);
 148
 149   virtual Qt::ItemFlags flags(const QModelIndex &index) const;
 150   QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const;
 151
 152   QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
 153   QModelIndex indexById(quint64 id, const QModelIndex &parent = QModelIndex()) const;
 154   QModelIndex indexByItem(AbstractTreeItem *item) const;
 155
 156   QModelIndex parent(const QModelIndex &index) const;
 157
 158   int rowCount(const QModelIndex &parent = QModelIndex()) const;
 159   int columnCount(const QModelIndex &parent = QModelIndex()) const;
 160
 161   virtual void clear();
 162
 163 private slots:
 164   void itemDataChanged(int column = -1);
 165
 166   void beginAppendChilds(int firstRow, int lastRow);
 167   void endAppendChilds();
 168
 169   void beginRemoveChilds(int firstRow, int lastRow);
 170   void endRemoveChilds();
 171
 172 protected:
 173   AbstractTreeItem *rootItem;
 174
 175 private:
 176   void connectItem(AbstractTreeItem *item);
 177
 178   struct ChildStatus {
 179     QModelIndex parent;
 180     int childCount;
 181     int start;
 182     int end;
 183     inline ChildStatus(QModelIndex parent_, int cc_, int s_, int e_) : parent(parent_), childCount(cc_), start(s_), end(e_) {};
 184   };
 185   ChildStatus _childStatus;
 186   int _aboutToRemoveOrInsert;
 187
 188 private slots:
 189   void debug_rowsAboutToBeInserted(const QModelIndex &parent, int start, int end);
 190   void debug_rowsAboutToBeRemoved(const QModelIndex &parent, int start, int end);
 191   void debug_rowsInserted(const QModelIndex &parent, int start, int end);
 192   void debug_rowsRemoved(const QModelIndex &parent, int start, int end);
 193   void debug_dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight);
 194 };
 195
 196 #endif