Rework of the TreeModel. This should finaliy *knock on wood* inconsitency issues.
[quassel.git] / src / client / treemodel.h
index d4f2725..5ff823a 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-07 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-08 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
 #define _TREEMODEL_H_
 
 #include <QList>
+#include <QStringList>
 #include <QVariant>
 #include <QHash>
 #include <QAbstractItemModel>
 
+#include <QLinkedList> // needed for debug
+
 /*****************************************
  *  general item used in the Tree Model
  *****************************************/
-class TreeItem : public QObject {
+class AbstractTreeItem : public QObject {
   Q_OBJECT
-  Q_PROPERTY(uint id READ id)
+  Q_PROPERTY(quint64 id READ id)
 
 public:
-  TreeItem(const QList<QVariant> &data, TreeItem *parent = 0);
-  TreeItem(TreeItem *parent = 0);
-  virtual ~TreeItem();
+  AbstractTreeItem(AbstractTreeItem *parent = 0);
+  virtual ~AbstractTreeItem();
+
+  bool newChild(int column, AbstractTreeItem *child);
+  bool newChild(AbstractTreeItem *child);
+  
+  bool removeChild(int column, int row);
+  bool removeChild(int row);
 
-  void appendChild(TreeItem *child);
-  void removeChild(int row);
+  bool removeChildById(int column, const quint64 &id);
+  bool removeChildById(const quint64 &id);
+  
+  void removeAllChilds();
 
-  virtual uint id() const;
+  virtual quint64 id() const;
 
-  TreeItem *child(int row) const;
-  TreeItem *childById(const uint &) const;
+  AbstractTreeItem *child(int column, int row) const;
+  AbstractTreeItem *child(int row) const;
+  
+  AbstractTreeItem *childById(int column, const quint64 &id) const;
+  AbstractTreeItem *childById(const quint64 &id) const;
 
+  int childCount(int column) const;
   int childCount() const;
-  int columnCount() const;
 
-  virtual QVariant data(int column, int role) const;
+  virtual int columnCount() const = 0;
 
-  Qt::ItemFlags flags() const;
-  void setFlags(Qt::ItemFlags);
+  virtual QVariant data(int column, int role) const = 0;
+  virtual bool setData(int column, const QVariant &value, int role) = 0;
 
+  virtual Qt::ItemFlags flags() const;
+  virtual void setFlags(Qt::ItemFlags);
+
+  int column() const;
   int row() const;
-  TreeItem *parent();
+  AbstractTreeItem *parent() const;
 
+signals:
+  void dataChanged(int column = -1);
 
-private slots:
-  void childDestroyed();
+  void beginAppendChilds(int column, int firstRow, int lastRow);
+  void endAppendChilds();
+  
+  void beginRemoveChilds(int column, int firstRow, int lastRow);
+  void endRemoveChilds();
+                                      
+private:
+  QHash<int, QList<AbstractTreeItem *> > _childItems;
+  Qt::ItemFlags _flags;
+
+  int defaultColumn() const;
+};
 
 
-protected:
-  QList<QVariant> itemData;
+/*****************************************
+ * SimpleTreeItem
+ *****************************************/
+class SimpleTreeItem : public AbstractTreeItem {
+  Q_OBJECT
+
+public:
+  SimpleTreeItem(const QList<QVariant> &data, AbstractTreeItem *parent = 0);
+  virtual ~SimpleTreeItem();
+
+  virtual QVariant data(int column, int role) const;
+  virtual bool setData(int column, const QVariant &value, int role);
+
+  virtual int columnCount() const;
 
 private:
-  QList<TreeItem *> _childItems;
-  QHash<uint, TreeItem *> _childHash; // uint to be compatible to qHash functions
-  TreeItem *_parentItem;
-  Qt::ItemFlags _flags;
+  QList<QVariant> _itemData;
+};
+
+/*****************************************
+ * PropertyMapItem
+ *****************************************/
+class PropertyMapItem : public AbstractTreeItem {
+  Q_OBJECT
+
+public:
+  PropertyMapItem(const QStringList &propertyOrder, AbstractTreeItem *parent = 0);
+  PropertyMapItem(AbstractTreeItem *parent = 0);
+
+  virtual ~PropertyMapItem();
+  
+  virtual QVariant data(int column, int role) const;
+  virtual bool setData(int column, const QVariant &value, int role);
+
+  virtual int columnCount() const;
+  
+  void appendProperty(const QString &property);
+
+private:
+  QStringList _propertyOrder;
 };
 
 
@@ -83,22 +144,49 @@ public:
   TreeModel(const QList<QVariant> &, QObject *parent = 0);
   virtual ~TreeModel();
 
-  QVariant data(const QModelIndex &index, int role) const;
+  virtual QVariant data(const QModelIndex &index, int role) const;
+  virtual bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole);
+
   virtual Qt::ItemFlags flags(const QModelIndex &index) const;
   QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const;
+  
   QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
-  QModelIndex indexById(uint id, const QModelIndex &parent = QModelIndex()) const;
+  QModelIndex indexById(quint64 id, const QModelIndex &parent = QModelIndex()) const;
+  QModelIndex indexByItem(AbstractTreeItem *item, int column = 0) const;
+
   QModelIndex parent(const QModelIndex &index) const;
+
   int rowCount(const QModelIndex &parent = QModelIndex()) const;
   int columnCount(const QModelIndex &parent = QModelIndex()) const;
 
   virtual void clear();
 
+private slots:
+  void itemDataChanged(int column = -1);
+  
+  void beginAppendChilds(int column, int firstRow, int lastRow);
+  void endAppendChilds();
+  
+  void beginRemoveChilds(int column, int firstRow, int lastRow);
+  void endRemoveChilds();
+  
 protected:
-  bool removeRow(int row, const QModelIndex &parent = QModelIndex());
-  bool removeRows(int row, int count, const QModelIndex &parent = QModelIndex());
+  AbstractTreeItem *rootItem;
+
+private:
+  void connectItem(AbstractTreeItem *item);
   
-  TreeItem *rootItem;
+  struct ChildStatus {
+    QModelIndex parent;
+    int childCount;
+    int start;
+    int end;
+    inline ChildStatus(QModelIndex parent_, int cc_, int s_, int e_) : parent(parent_), childCount(cc_), start(s_), end(e_) {};
+  };
+  ChildStatus _childStatus;
+  int _aboutToRemoveOrInsert;
+  // QLinkedList<ChildStatus> _childStatus;
+
 };
 
 #endif