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(int column, AbstractTreeItem *child);
  44   bool newChild(AbstractTreeItem *child);
  45
  46   bool removeChild(int column, int row);
  47   bool removeChild(int row);
  48
  49   bool removeChildById(int column, const quint64 &id);
  50   bool removeChildById(const quint64 &id);
  51
  52   void removeAllChilds();
  53
  54   virtual quint64 id() const;
  55
  56   AbstractTreeItem *child(int column, int row) const;
  57   AbstractTreeItem *child(int row) const;
  58
  59   AbstractTreeItem *childById(int column, const quint64 &id) const;
  60   AbstractTreeItem *childById(const quint64 &id) const;
  61
  62   int childCount(int column) const;
  63   int childCount() const;
  64
  65   virtual int columnCount() const = 0;
  66
  67   virtual QVariant data(int column, int role) const = 0;
  68   virtual bool setData(int column, const QVariant &value, int role) = 0;
  69
  70   virtual Qt::ItemFlags flags() const;
  71   virtual void setFlags(Qt::ItemFlags);
  72
  73   int column() const;
  74   int row() const;
  75   AbstractTreeItem *parent() const;
  76
  77   void dumpChildList();
  78
  79 signals:
  80   void dataChanged(int column = -1);
  81
  82   void beginAppendChilds(int column, int firstRow, int lastRow);
  83   void endAppendChilds();
  84
  85   void beginRemoveChilds(int column, int firstRow, int lastRow);
  86   void endRemoveChilds();
  87
  88 private:
  89   QHash<int, QList<AbstractTreeItem *> > _childItems;
  90   Qt::ItemFlags _flags;
  91
  92   int defaultColumn() const;
  93 };
  94
  95
  96 /*****************************************
  97  * SimpleTreeItem
  98  *****************************************/
  99 class SimpleTreeItem : public AbstractTreeItem {
 100   Q_OBJECT
 101
 102 public:
 103   SimpleTreeItem(const QList<QVariant> &data, AbstractTreeItem *parent = 0);
 104   virtual ~SimpleTreeItem();
 105
 106   virtual QVariant data(int column, int role) const;
 107   virtual bool setData(int column, const QVariant &value, int role);
 108
 109   virtual int columnCount() const;
 110
 111 private:
 112   QList<QVariant> _itemData;
 113 };
 114
 115 /*****************************************
 116  * PropertyMapItem
 117  *****************************************/
 118 class PropertyMapItem : public AbstractTreeItem {
 119   Q_OBJECT
 120
 121 public:
 122   PropertyMapItem(const QStringList &propertyOrder, AbstractTreeItem *parent = 0);
 123   PropertyMapItem(AbstractTreeItem *parent = 0);
 124
 125   virtual ~PropertyMapItem();
 126
 127   virtual QVariant data(int column, int role) const;
 128   virtual bool setData(int column, const QVariant &value, int role);
 129
 130   virtual QString toolTip(int column) const { Q_UNUSED(column) return QString(); }
 131   virtual int columnCount() const;
 132
 133   void appendProperty(const QString &property);
 134
 135 private:
 136   QStringList _propertyOrder;
 137 };
 138
 139
 140 /*****************************************
 141  * TreeModel
 142  *****************************************/
 143 class TreeModel : public QAbstractItemModel {
 144   Q_OBJECT
 145
 146 public:
 147   TreeModel(const QList<QVariant> &, QObject *parent = 0);
 148   virtual ~TreeModel();
 149
 150   virtual QVariant data(const QModelIndex &index, int role) const;
 151   virtual bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole);
 152
 153   virtual Qt::ItemFlags flags(const QModelIndex &index) const;
 154   QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const;
 155
 156   QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
 157   QModelIndex indexById(quint64 id, const QModelIndex &parent = QModelIndex()) const;
 158   QModelIndex indexByItem(AbstractTreeItem *item, int column = 0) const;
 159
 160   QModelIndex parent(const QModelIndex &index) const;
 161
 162   int rowCount(const QModelIndex &parent = QModelIndex()) const;
 163   int columnCount(const QModelIndex &parent = QModelIndex()) const;
 164
 165   virtual void clear();
 166
 167 private slots:
 168   void itemDataChanged(int column = -1);
 169
 170   void beginAppendChilds(int column, int firstRow, int lastRow);
 171   void endAppendChilds();
 172
 173   void beginRemoveChilds(int column, int firstRow, int lastRow);
 174   void endRemoveChilds();
 175
 176 protected:
 177   AbstractTreeItem *rootItem;
 178
 179 private:
 180   void connectItem(AbstractTreeItem *item);
 181
 182   struct ChildStatus {
 183     QModelIndex parent;
 184     int childCount;
 185     int start;
 186     int end;
 187     inline ChildStatus(QModelIndex parent_, int cc_, int s_, int e_) : parent(parent_), childCount(cc_), start(s_), end(e_) {};
 188   };
 189   ChildStatus _childStatus;
 190   int _aboutToRemoveOrInsert;
 191
 192 private slots:
 193   void debug_rowsAboutToBeInserted(const QModelIndex &parent, int start, int end);
 194   void debug_rowsAboutToBeRemoved(const QModelIndex &parent, int start, int end);
 195   void debug_rowsInserted(const QModelIndex &parent, int start, int end);
 196   void debug_rowsRemoved(const QModelIndex &parent, int start, int end);
 197 };
 198
 199 #endif