/***************************************************************************
- * Copyright (C) 2005-08 by the Quassel Project *
+ * Copyright (C) 2005-2018 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
-#ifndef _TREEMODEL_H_
-#define _TREEMODEL_H_
+#pragma once
+
+#include "client-export.h"
#include <QList>
#include <QStringList>
#include <QVariant>
-#include <QHash>
#include <QAbstractItemModel>
+#include <QLinkedList> // needed for debug
+
/*****************************************
* general item used in the Tree Model
*****************************************/
-class AbstractTreeItem : public QObject {
- Q_OBJECT
- Q_PROPERTY(uint id READ id)
+class CLIENT_EXPORT AbstractTreeItem : public QObject
+{
+ Q_OBJECT
public:
- AbstractTreeItem(AbstractTreeItem *parent = 0);
- virtual ~AbstractTreeItem();
+ enum TreeItemFlag {
+ NoTreeItemFlag = 0x00,
+ DeleteOnLastChildRemoved = 0x01
+ };
+ Q_DECLARE_FLAGS(TreeItemFlags, TreeItemFlag)
+
+ AbstractTreeItem(AbstractTreeItem *parent = nullptr);
+
+ bool newChild(AbstractTreeItem *child);
+ bool newChilds(const QList<AbstractTreeItem *> &items);
- void appendChild(int column, AbstractTreeItem *child);
- void appendChild(AbstractTreeItem *child);
-
- void removeChild(int column, int row);
- void removeChild(int row);
+ bool removeChild(int row);
+ inline bool removeChild(AbstractTreeItem *child) { return removeChild(child->row()); }
+ void removeAllChilds();
- virtual quint64 id() const;
+ bool reParent(AbstractTreeItem *newParent);
- AbstractTreeItem *child(int column, int row) const;
- AbstractTreeItem *child(int row) const;
-
- AbstractTreeItem *childById(int column, const uint &id) const;
- AbstractTreeItem *childById(const uint &id) const;
+ AbstractTreeItem *child(int row) const;
- int childCount(int column) const;
- int childCount() const;
+ int childCount(int column = 0) const;
- virtual int columnCount() const = 0;
+ virtual int columnCount() const = 0;
- virtual QVariant data(int column, int role) const = 0;
+ 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);
+ virtual inline Qt::ItemFlags flags() const { return _flags; }
+ virtual inline void setFlags(Qt::ItemFlags flags) { _flags = flags; }
- int column() const;
- int row() const;
- AbstractTreeItem *parent();
+ inline AbstractTreeItem::TreeItemFlags treeItemFlags() const { return _treeItemFlags; }
+ inline void setTreeItemFlags(AbstractTreeItem::TreeItemFlags flags) { _treeItemFlags = flags; }
+ int row() const;
+ inline AbstractTreeItem *parent() const { return qobject_cast<AbstractTreeItem *>(QObject::parent()); }
+
+ void dumpChildList();
signals:
- void dataChanged(int column);
- void newChild(AbstractTreeItem *);
- void childDestroyed(int row);
-
-private slots:
- void childDestroyed();
+ void dataChanged(int column = -1);
-private:
- QHash<int, QList<AbstractTreeItem *> > _childItems;
- QHash<int, QHash<quint64, AbstractTreeItem *> > _childHash; // uint to be compatible to qHash functions
- AbstractTreeItem *_parentItem;
- Qt::ItemFlags _flags;
+ void beginAppendChilds(int firstRow, int lastRow);
+ void endAppendChilds();
- int defaultColumn() const;
+ void beginRemoveChilds(int firstRow, int lastRow);
+ void endRemoveChilds();
+
+protected:
+ void customEvent(QEvent *event);
+
+private:
+ QList<AbstractTreeItem *> _childItems;
+ Qt::ItemFlags _flags;
+ TreeItemFlags _treeItemFlags;
+
+ void removeChildLater(AbstractTreeItem *child);
+ inline void checkForDeletion()
+ {
+ if (treeItemFlags() & DeleteOnLastChildRemoved && childCount() == 0) parent()->removeChildLater(this);
+ }
};
/*****************************************
* SimpleTreeItem
*****************************************/
-class SimpleTreeItem : public AbstractTreeItem {
- Q_OBJECT
+class CLIENT_EXPORT 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 int columnCount() const;
+ SimpleTreeItem(const QList<QVariant> &data, AbstractTreeItem *parent = nullptr);
+ 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<QVariant> _itemData;
+ QList<QVariant> _itemData;
};
+
/*****************************************
* PropertyMapItem
*****************************************/
-class PropertyMapItem : public AbstractTreeItem {
- Q_OBJECT
+class CLIENT_EXPORT PropertyMapItem : public AbstractTreeItem
+{
+ Q_OBJECT
public:
- PropertyMapItem(const QStringList &propertyOrder, AbstractTreeItem *parent = 0);
- PropertyMapItem(AbstractTreeItem *parent = 0);
+ PropertyMapItem(AbstractTreeItem *parent = nullptr);
- virtual ~PropertyMapItem();
-
- virtual QVariant data(int column, int role) const;
- virtual int columnCount() const;
-
- void appendProperty(const QString &property);
+ virtual QStringList propertyOrder() const = 0;
-private:
- QStringList _propertyOrder;
+ virtual QVariant data(int column, int role) const;
+ virtual bool setData(int column, const QVariant &value, int role);
+
+ virtual QString toolTip(int column) const { Q_UNUSED(column) return QString(); }
+ virtual int columnCount() const;
};
/*****************************************
* TreeModel
*****************************************/
-class TreeModel : public QAbstractItemModel {
- Q_OBJECT
+class CLIENT_EXPORT TreeModel : public QAbstractItemModel
+{
+ Q_OBJECT
public:
- TreeModel(const QList<QVariant> &, QObject *parent = 0);
- virtual ~TreeModel();
+ enum myRoles {
+ SortRole = Qt::UserRole,
+ UserRole
+ };
+
+ TreeModel(const QList<QVariant> &, QObject *parent = nullptr);
+ virtual ~TreeModel();
+
+ AbstractTreeItem *root() 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;
- QVariant data(const QModelIndex &index, int role) const;
- 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 indexByItem(AbstractTreeItem *item) const;
+ QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
+ QModelIndex indexByItem(AbstractTreeItem *item) const;
- QModelIndex parent(const QModelIndex &index) const;
+ QModelIndex parent(const QModelIndex &index) const;
- int rowCount(const QModelIndex &parent = QModelIndex()) const;
- int columnCount(const QModelIndex &parent = QModelIndex()) const;
+ int rowCount(const QModelIndex &parent = QModelIndex()) const;
+ int columnCount(const QModelIndex &parent = QModelIndex()) const;
- virtual void clear();
+ virtual void clear();
private slots:
- void itemDataChanged(int column);
- void newChild(AbstractTreeItem *child);
- void childDestroyed(int row);
+ void itemDataChanged(int column = -1);
+
+ void beginAppendChilds(int firstRow, int lastRow);
+ void endAppendChilds();
+
+ void beginRemoveChilds(int firstRow, int lastRow);
+ void endRemoveChilds();
protected:
- void appendChild(AbstractTreeItem *parent, AbstractTreeItem *child);
+ AbstractTreeItem *rootItem;
- 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);
+
+ 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;
-#endif
+private slots:
+ void debug_rowsAboutToBeInserted(const QModelIndex &parent, int start, int end);
+ void debug_rowsAboutToBeRemoved(const QModelIndex &parent, int start, int end);
+ void debug_rowsInserted(const QModelIndex &parent, int start, int end);
+ void debug_rowsRemoved(const QModelIndex &parent, int start, int end);
+ void debug_dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight);
+};