src/client/treemodel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-07 by the Quassel IRC Team                         *
   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 #include "treemodel.h"
  22
  23 #include <QDebug>
  24
  25 /*****************************************
  26  *  Abstract Items of a TreeModel
  27  *****************************************/
  28 AbstractTreeItem::AbstractTreeItem(AbstractTreeItem *parent)
  29   : QObject(parent),
  30     _parentItem(parent),
  31     _flags(Qt::ItemIsSelectable | Qt::ItemIsEnabled)
  32 {
  33 }
  34
  35 AbstractTreeItem::~AbstractTreeItem() {
  36   foreach(int key, _childItems.keys()) {
  37     qDeleteAll(_childItems[key]);
  38   }
  39 }
  40
  41 quint64 AbstractTreeItem::id() const {
  42   return (quint64)this;
  43 }
  44
  45 int AbstractTreeItem::defaultColumn() const {
  46   // invalid QModelIndexes aka rootNodes get their Childs stuffed into column -1
  47   // all others to 0
  48   if(_parentItem == 0)
  49     return -1;
  50   else
  51     return 0;
  52 }
  53
  54 void AbstractTreeItem::appendChild(int column, AbstractTreeItem *item) {
  55   if(!_childItems.contains(column)) {
  56     _childItems[column] = QList<AbstractTreeItem *>();
  57     _childHash[column] = QHash<quint64, AbstractTreeItem *>();
  58   }
  59
  60   _childItems[column].append(item);
  61   _childHash[column][item->id()] = item;
  62
  63   connect(item, SIGNAL(destroyed()), this, SLOT(childDestroyed()));
  64 }
  65
  66 void AbstractTreeItem::appendChild(AbstractTreeItem *child) {
  67   appendChild(defaultColumn(), child);
  68 }
  69
  70 void AbstractTreeItem::removeChild(int column, int row) {
  71   if(!_childItems.contains(column)
  72      || _childItems[column].size() <= row)
  73     return;
  74
  75   AbstractTreeItem *treeitem = _childItems[column].value(row);
  76   _childItems[column].removeAt(row);
  77   _childHash[column].remove(_childHash[column].key(treeitem));
  78   treeitem->deleteLater();
  79 }
  80
  81 void AbstractTreeItem::removeChild(int row) {
  82   removeChild(defaultColumn(), row);
  83 }
  84
  85 AbstractTreeItem *AbstractTreeItem::child(int column, int row) const {
  86   if(!_childItems.contains(column)
  87      || _childItems[column].size() <= row)
  88     return 0;
  89   else
  90     return _childItems[column].value(row);
  91 }
  92
  93 AbstractTreeItem *AbstractTreeItem::child(int row) const {
  94   return child(defaultColumn(), row);
  95 }
  96
  97 AbstractTreeItem *AbstractTreeItem::childById(int column, const uint &id) const {
  98   if(!_childHash.contains(column)
  99      || !_childHash[column].contains(id))
 100     return 0;
 101   else
 102     return _childHash[column].value(id);
 103 }
 104
 105 AbstractTreeItem *AbstractTreeItem::childById(const uint &id) const {
 106   return childById(defaultColumn(), id);
 107 }
 108
 109 int AbstractTreeItem::childCount(int column) const {
 110   if(!_childItems.contains(column))
 111     return 0;
 112   else
 113     return _childItems[column].count();
 114 }
 115
 116 int AbstractTreeItem::childCount() const {
 117   return childCount(defaultColumn());
 118 }
 119
 120 int AbstractTreeItem::column() const {
 121   if(!_parentItem)
 122     return -1;
 123
 124   QHash<int, QList<AbstractTreeItem*> >::const_iterator iter = _parentItem->_childItems.constBegin();
 125   int pos;
 126   while(iter != _parentItem->_childItems.constEnd()) {
 127     pos = iter.value().indexOf(const_cast<AbstractTreeItem *>(this));
 128     if(pos != -1)
 129       return iter.key();
 130     iter++;
 131   }
 132
 133   // unable to find us o_O
 134   return _parentItem->defaultColumn();
 135 }
 136
 137 int AbstractTreeItem::row() const {
 138   if(!_parentItem)
 139     return -1;
 140   else
 141     return _parentItem->_childItems[column()].indexOf(const_cast<AbstractTreeItem*>(this));
 142 }
 143
 144 AbstractTreeItem *AbstractTreeItem::parent() {
 145   return _parentItem;
 146 }
 147
 148 Qt::ItemFlags AbstractTreeItem::flags() const {
 149   return _flags;
 150 }
 151
 152 void AbstractTreeItem::setFlags(Qt::ItemFlags flags) {
 153   _flags = flags;
 154 }
 155
 156 void AbstractTreeItem::childDestroyed() {
 157   AbstractTreeItem *item = static_cast<AbstractTreeItem*>(sender());
 158
 159   if(!item) {
 160     qWarning() << "AbstractTreeItem::childDestroyed() received null pointer!";
 161     return;
 162   }
 163   _childItems[item->column()].removeAt(item->row());
 164   _childHash[item->column()].remove(_childHash[item->column()].key(item));
 165 }
 166
 167 /*****************************************
 168  * SimpleTreeItem
 169  *****************************************/
 170 SimpleTreeItem::SimpleTreeItem(const QList<QVariant> &data, AbstractTreeItem *parent)
 171   : AbstractTreeItem(parent),
 172     _itemData(data)
 173 {
 174 }
 175
 176 SimpleTreeItem::~SimpleTreeItem() {
 177 }
 178
 179 QVariant SimpleTreeItem::data(int column, int role) const {
 180   if(role == Qt::DisplayRole && column < _itemData.count())
 181     return _itemData[column];
 182   else
 183     return QVariant();
 184 }
 185
 186 int SimpleTreeItem::columnCount() const {
 187   return _itemData.count();
 188 }
 189
 190 /*****************************************
 191  * PropertyMapItem
 192  *****************************************/
 193 PropertyMapItem::PropertyMapItem(const QStringList &propertyOrder, AbstractTreeItem *parent)
 194   : AbstractTreeItem(parent),
 195     _propertyOrder(propertyOrder)
 196 {
 197 }
 198
 199 PropertyMapItem::PropertyMapItem(AbstractTreeItem *parent)
 200   : AbstractTreeItem(parent),
 201     _propertyOrder(QStringList())
 202 {
 203 }
 204
 205
 206 PropertyMapItem::~PropertyMapItem() {
 207 }
 208
 209 QVariant PropertyMapItem::data(int column, int role) const {
 210   if(column >= columnCount())
 211     return QVariant();
 212
 213   if(role != Qt::DisplayRole)
 214     return QVariant();
 215
 216   return property(_propertyOrder[column].toAscii());
 217 }
 218
 219 int PropertyMapItem::columnCount() const {
 220   return _propertyOrder.count();
 221 }
 222
 223 void PropertyMapItem::appendProperty(const QString &property) {
 224   _propertyOrder << property;
 225 }
 226
 227
 228
 229 /*****************************************
 230  * TreeModel
 231  *****************************************/
 232 TreeModel::TreeModel(const QList<QVariant> &data, QObject *parent)
 233   : QAbstractItemModel(parent)
 234 {
 235   rootItem = new SimpleTreeItem(data, 0);
 236 }
 237
 238 TreeModel::~TreeModel() {
 239   delete rootItem;
 240 }
 241
 242 QModelIndex TreeModel::index(int row, int column, const QModelIndex &parent) const {
 243   if(!hasIndex(row, column, parent))
 244     return QModelIndex();
 245
 246   AbstractTreeItem *parentItem;
 247
 248   if(!parent.isValid())
 249     parentItem = rootItem;
 250   else
 251     parentItem = static_cast<AbstractTreeItem*>(parent.internalPointer());
 252
 253   AbstractTreeItem *childItem = parentItem->child(parent.column(), row);
 254
 255   if(childItem)
 256     return createIndex(row, column, childItem);
 257   else
 258     return QModelIndex();
 259 }
 260
 261 QModelIndex TreeModel::indexById(uint id, const QModelIndex &parent) const {
 262   AbstractTreeItem *parentItem;
 263
 264   if(!parent.isValid())
 265     parentItem = rootItem;
 266   else
 267     parentItem = static_cast<AbstractTreeItem *>(parent.internalPointer());
 268
 269   AbstractTreeItem *childItem = parentItem->childById(parent.column(), id);
 270
 271   if(childItem)
 272     return createIndex(childItem->row(), 0, childItem);
 273   else
 274     return QModelIndex();
 275 }
 276
 277 QModelIndex TreeModel::indexByItem(AbstractTreeItem *item) const {
 278   if(item == 0) {
 279     qWarning() << "TreeModel::indexByItem(AbstractTreeItem *item) received NULL-Pointer";
 280     return QModelIndex();
 281   }
 282
 283   if(item == rootItem)
 284     return QModelIndex();
 285   else
 286     return createIndex(item->row(), 0, item);
 287
 288 }
 289
 290 QModelIndex TreeModel::parent(const QModelIndex &index) const {
 291   if(!index.isValid())
 292     return QModelIndex();
 293
 294   AbstractTreeItem *childItem = static_cast<AbstractTreeItem *>(index.internalPointer());
 295   AbstractTreeItem *parentItem = static_cast<AbstractTreeItem *>(childItem->parent());
 296
 297   if(parentItem == rootItem)
 298     return QModelIndex();
 299
 300   return createIndex(parentItem->row(), 0, parentItem);
 301 }
 302
 303 int TreeModel::rowCount(const QModelIndex &parent) const {
 304   AbstractTreeItem *parentItem;
 305   if(!parent.isValid())
 306     parentItem = rootItem;
 307   else
 308     parentItem = static_cast<AbstractTreeItem*>(parent.internalPointer());
 309
 310   return parentItem->childCount(parent.column());
 311 }
 312
 313 int TreeModel::columnCount(const QModelIndex &parent) const {
 314   if(parent.isValid())
 315     return static_cast<AbstractTreeItem*>(parent.internalPointer())->columnCount();
 316   else
 317     return rootItem->columnCount();
 318 }
 319
 320 QVariant TreeModel::data(const QModelIndex &index, int role) const {
 321   if(!index.isValid())
 322     return QVariant();
 323
 324   AbstractTreeItem *item = static_cast<AbstractTreeItem*>(index.internalPointer());
 325   return item->data(index.column(), role);
 326 }
 327
 328 Qt::ItemFlags TreeModel::flags(const QModelIndex &index) const {
 329   AbstractTreeItem *item;
 330   if(!index.isValid())
 331     item = rootItem;
 332   else
 333     item = static_cast<AbstractTreeItem *>(index.internalPointer());
 334   return item->flags();
 335 }
 336
 337 QVariant TreeModel::headerData(int section, Qt::Orientation orientation, int role) const {
 338   if (orientation == Qt::Horizontal && role == Qt::DisplayRole)
 339     return rootItem->data(section, role);
 340   else
 341     return QVariant();
 342 }
 343
 344 void TreeModel::itemDataChanged(int column) {
 345   AbstractTreeItem *item = qobject_cast<AbstractTreeItem *>(sender());
 346   QModelIndex itemIndex;
 347
 348   if(item == rootItem)
 349     itemIndex = QModelIndex();
 350   else
 351     itemIndex = createIndex(item->row(), column, item);
 352
 353   emit dataChanged(itemIndex, itemIndex);
 354 }
 355
 356 void TreeModel::appendChild(AbstractTreeItem *parent, AbstractTreeItem *child) {
 357   if(parent == 0 or child == 0) {
 358     qWarning() << "TreeModel::apendChild(parent, child) parent and child have to be valid pointers!" << parent << child;
 359     return;
 360   }
 361
 362   int nextRow = parent->childCount();
 363   beginInsertRows(indexByItem(parent), nextRow, nextRow);
 364   parent->appendChild(child);
 365   endInsertRows();
 366
 367   connect(child, SIGNAL(dataChanged(int)),
 368           this, SLOT(itemDataChanged(int)));
 369 }
 370
 371
 372 bool TreeModel::removeRow(int row, const QModelIndex &parent) {
 373   if(row > rowCount(parent))
 374     return false;
 375
 376   AbstractTreeItem *item;
 377   if(!parent.isValid())
 378     item = rootItem;
 379   else
 380     item = static_cast<AbstractTreeItem*>(parent.internalPointer());
 381
 382   beginRemoveRows(parent, row, row);
 383   item->removeChild(parent.column(), row);
 384   endRemoveRows();
 385   return true;
 386 }
 387
 388 bool TreeModel::removeRows(int row, int count, const QModelIndex &parent) {
 389   // check if there is work to be done
 390   if(count == 0)
 391     return true;
 392
 393   // out of range check
 394   if(row + count - 1 > rowCount(parent) || row < 0 || count < 0)
 395     return false;
 396
 397   AbstractTreeItem *item;
 398   if(!parent.isValid())
 399     item = rootItem;
 400   else
 401     item = static_cast<AbstractTreeItem *>(parent.internalPointer());
 402
 403
 404   beginRemoveRows(parent, row, row + count - 1);
 405
 406   for(int i = row + count - 1; i >= 0; i--) {
 407     item->removeChild(parent.column(), i);
 408   }
 409   endRemoveRows();
 410   return true;
 411 }
 412
 413 void TreeModel::clear() {
 414   removeRows(0, rowCount());
 415   reset();
 416 }