src/uisupport/bufferview.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 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 #include "bufferview.h"
  22
  23 #include <QApplication>
  24 #include <QAction>
  25 #include <QFlags>
  26 #include <QHeaderView>
  27 #include <QLineEdit>
  28 #include <QMenu>
  29 #include <QMessageBox>
  30 #include <QSet>
  31
  32 #include "action.h"
  33 #include "buffermodel.h"
  34 #include "bufferviewfilter.h"
  35 #include "buffersettings.h"
  36 #include "buffersyncer.h"
  37 #include "client.h"
  38 #include "iconloader.h"
  39 #include "network.h"
  40 #include "networkmodel.h"
  41 #include "networkmodelactionprovider.h"
  42 #include "quasselui.h"
  43 #include "uisettings.h"
  44
  45 bool TristateDelegate::editorEvent(QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index) {
  46   if(event->type() != QEvent::MouseButtonRelease)
  47     return QStyledItemDelegate::editorEvent(event, model, option, index);
  48
  49   if(!(model->flags(index) & Qt::ItemIsUserCheckable))
  50     return QStyledItemDelegate::editorEvent(event, model, option, index);
  51
  52   QVariant value = index.data(Qt::CheckStateRole);
  53   if(!value.isValid())
  54     return QStyledItemDelegate::editorEvent(event, model, option, index);
  55
  56   QStyleOptionViewItemV4 viewOpt(option);
  57   initStyleOption(&viewOpt, index);
  58
  59   QRect checkRect = viewOpt.widget->style()->subElementRect(QStyle::SE_ItemViewItemCheckIndicator, &viewOpt, viewOpt.widget);
  60   QMouseEvent *me = static_cast<QMouseEvent*>(event);
  61
  62   if(me->button() != Qt::LeftButton || !checkRect.contains(me->pos()))
  63     return QStyledItemDelegate::editorEvent(event, model, option, index);
  64
  65   Qt::CheckState state = static_cast<Qt::CheckState>(value.toInt());
  66   if(state == Qt::Unchecked)
  67     state = Qt::PartiallyChecked;
  68   else if(state == Qt::PartiallyChecked)
  69     state = Qt::Checked;
  70   else
  71     state = Qt::Unchecked;
  72   model->setData(index, state, Qt::CheckStateRole);
  73   return true;
  74 }
  75
  76
  77
  78
  79 /*****************************************
  80 * The TreeView showing the Buffers
  81 *****************************************/
  82 // Please be carefull when reimplementing methods which are used to inform the view about changes to the data
  83 // to be on the safe side: call QTreeView's method aswell
  84 BufferView::BufferView(QWidget *parent)
  85   : QTreeView(parent)
  86 {
  87   connect(this, SIGNAL(collapsed(const QModelIndex &)), SLOT(storeExpandedState(const QModelIndex &)));
  88   connect(this, SIGNAL(expanded(const QModelIndex &)), SLOT(storeExpandedState(const QModelIndex &)));
  89
  90   setSelectionMode(QAbstractItemView::ExtendedSelection);
  91
  92   QAbstractItemDelegate *oldDelegate = itemDelegate();
  93   TristateDelegate *tristateDelegate = new TristateDelegate(this);
  94   setItemDelegate(tristateDelegate);
  95   delete oldDelegate;
  96 }
  97
  98 void BufferView::init() {
  99   header()->setContextMenuPolicy(Qt::ActionsContextMenu);
 100   hideColumn(1);
 101   hideColumn(2);
 102   setIndentation(10);
 103   expandAll();
 104
 105   setAnimated(true);
 106
 107 #ifndef QT_NO_DRAGANDDROP
 108   setDragEnabled(true);
 109   setAcceptDrops(true);
 110   setDropIndicatorShown(true);
 111 #endif
 112
 113   setSortingEnabled(true);
 114   sortByColumn(0, Qt::AscendingOrder);
 115
 116   // activated() fails on X11 and Qtopia at least
 117 #if defined Q_WS_QWS || defined Q_WS_X11
 118   connect(this, SIGNAL(doubleClicked(QModelIndex)), SLOT(joinChannel(QModelIndex)));
 119 #else
 120   // afaik this is better on Mac and Windows
 121   connect(this, SIGNAL(activated(QModelIndex)), SLOT(joinChannel(QModelIndex)));
 122 #endif
 123 }
 124
 125 void BufferView::setModel(QAbstractItemModel *model) {
 126   delete selectionModel();
 127
 128   QTreeView::setModel(model);
 129   init();
 130   // remove old Actions
 131   QList<QAction *> oldactions = header()->actions();
 132   foreach(QAction *action, oldactions) {
 133     header()->removeAction(action);
 134     action->deleteLater();
 135   }
 136
 137   if(!model)
 138     return;
 139
 140   QString sectionName;
 141   QAction *showSection;
 142   for(int i = 1; i < model->columnCount(); i++) {
 143     sectionName = (model->headerData(i, Qt::Horizontal, Qt::DisplayRole)).toString();
 144     showSection = new QAction(sectionName, header());
 145     showSection->setCheckable(true);
 146     showSection->setChecked(!isColumnHidden(i));
 147     showSection->setProperty("column", i);
 148     connect(showSection, SIGNAL(toggled(bool)), this, SLOT(toggleHeader(bool)));
 149     header()->addAction(showSection);
 150   }
 151
 152 }
 153
 154 void BufferView::setFilteredModel(QAbstractItemModel *model_, BufferViewConfig *config) {
 155   BufferViewFilter *filter = qobject_cast<BufferViewFilter *>(model());
 156   if(filter) {
 157     filter->setConfig(config);
 158     setConfig(config);
 159     return;
 160   }
 161
 162   if(model()) {
 163     disconnect(this, 0, model(), 0);
 164     disconnect(model(), 0, this, 0);
 165   }
 166
 167   if(!model_) {
 168     setModel(model_);
 169   } else {
 170     BufferViewFilter *filter = new BufferViewFilter(model_, config);
 171     setModel(filter);
 172     connect(filter, SIGNAL(configChanged()), this, SLOT(on_configChanged()));
 173   }
 174   setConfig(config);
 175 }
 176
 177 void BufferView::setSelectionModel(QItemSelectionModel *selectionModel) {
 178   if(QTreeView::selectionModel())
 179     disconnect(selectionModel, SIGNAL(currentChanged(QModelIndex, QModelIndex)),
 180                model(), SIGNAL(checkPreviousCurrentForRemoval(QModelIndex, QModelIndex)));
 181
 182   QTreeView::setSelectionModel(selectionModel);
 183   BufferViewFilter *filter = qobject_cast<BufferViewFilter *>(model());
 184   if(filter) {
 185     connect(selectionModel, SIGNAL(currentChanged(QModelIndex, QModelIndex)),
 186             filter, SLOT(checkPreviousCurrentForRemoval(QModelIndex, QModelIndex)));
 187   }
 188 }
 189
 190 void BufferView::setConfig(BufferViewConfig *config) {
 191   if(_config == config)
 192     return;
 193
 194   if(_config) {
 195     disconnect(_config, 0, this, 0);
 196   }
 197
 198   _config = config;
 199   if(config) {
 200     connect(config, SIGNAL(networkIdSet(const NetworkId &)), this, SLOT(setRootIndexForNetworkId(const NetworkId &)));
 201     setRootIndexForNetworkId(config->networkId());
 202   } else {
 203     setIndentation(10);
 204     setRootIndex(QModelIndex());
 205   }
 206 }
 207
 208 void BufferView::setRootIndexForNetworkId(const NetworkId &networkId) {
 209   if(!networkId.isValid() || !model()) {
 210     setIndentation(10);
 211     setRootIndex(QModelIndex());
 212   } else {
 213     setIndentation(5);
 214     int networkCount = model()->rowCount();
 215     QModelIndex child;
 216     for(int i = 0; i < networkCount; i++) {
 217       child = model()->index(i, 0);
 218       if(networkId == model()->data(child, NetworkModel::NetworkIdRole).value<NetworkId>())
 219         setRootIndex(child);
 220     }
 221   }
 222 }
 223
 224 void BufferView::joinChannel(const QModelIndex &index) {
 225   BufferInfo::Type bufferType = (BufferInfo::Type)index.data(NetworkModel::BufferTypeRole).value<int>();
 226
 227   if(bufferType != BufferInfo::ChannelBuffer)
 228     return;
 229
 230   BufferInfo bufferInfo = index.data(NetworkModel::BufferInfoRole).value<BufferInfo>();
 231
 232   Client::userInput(bufferInfo, QString("/JOIN %1").arg(bufferInfo.bufferName()));
 233 }
 234
 235 void BufferView::keyPressEvent(QKeyEvent *event) {
 236   if(event->key() == Qt::Key_Backspace || event->key() == Qt::Key_Delete) {
 237     event->accept();
 238     removeSelectedBuffers();
 239   }
 240   QTreeView::keyPressEvent(event);
 241 }
 242
 243 void BufferView::dropEvent(QDropEvent *event) {
 244   QModelIndex index = indexAt(event->pos());
 245
 246   QRect indexRect = visualRect(index);
 247   QPoint cursorPos = event->pos();
 248
 249   // check if we're really _on_ the item and not indicating a move to just above or below the item
 250   const int margin = 2;
 251   if(cursorPos.y() - indexRect.top() < margin
 252      || indexRect.bottom() - cursorPos.y() < margin)
 253     return QTreeView::dropEvent(event);
 254
 255   QList< QPair<NetworkId, BufferId> > bufferList = Client::networkModel()->mimeDataToBufferList(event->mimeData());
 256   if(bufferList.count() != 1)
 257     return QTreeView::dropEvent(event);
 258
 259   NetworkId networkId = bufferList[0].first;
 260   BufferId bufferId2 = bufferList[0].second;
 261
 262   if(index.data(NetworkModel::ItemTypeRole) != NetworkModel::BufferItemType)
 263     return QTreeView::dropEvent(event);
 264
 265   if(index.data(NetworkModel::BufferTypeRole) != BufferInfo::QueryBuffer)
 266     return QTreeView::dropEvent(event);
 267
 268   if(index.data(NetworkModel::NetworkIdRole).value<NetworkId>() != networkId)
 269     return QTreeView::dropEvent(event);
 270
 271   BufferId bufferId1 = index.data(NetworkModel::BufferIdRole).value<BufferId>();
 272   if(bufferId1 == bufferId2)
 273     return QTreeView::dropEvent(event);
 274
 275   int res = QMessageBox::question(0, tr("Merge buffers permanently?"),
 276                                   tr("Do you want to merge the buffer \"%1\" permanently into buffer \"%2\"?\n This cannot be reversed!").arg(Client::networkModel()->bufferName(bufferId2)).arg(Client::networkModel()->bufferName(bufferId1)),
 277                                   QMessageBox::Yes|QMessageBox::No, QMessageBox::No);
 278   if(res == QMessageBox::Yes) {
 279     Client::mergeBuffersPermanently(bufferId1, bufferId2);
 280   }
 281 }
 282
 283 void BufferView::removeSelectedBuffers(bool permanently) {
 284   if(!config())
 285     return;
 286
 287   BufferId bufferId;
 288   QSet<BufferId> removedRows;
 289   foreach(QModelIndex index, selectionModel()->selectedIndexes()) {
 290     if(index.data(NetworkModel::ItemTypeRole) != NetworkModel::BufferItemType)
 291       continue;
 292
 293     bufferId = index.data(NetworkModel::BufferIdRole).value<BufferId>();
 294     if(removedRows.contains(bufferId))
 295       continue;
 296
 297     removedRows << bufferId;
 298
 299     if(permanently)
 300       config()->requestRemoveBufferPermanently(bufferId);
 301     else
 302       config()->requestRemoveBuffer(bufferId);
 303   }
 304 }
 305
 306 void BufferView::rowsInserted(const QModelIndex & parent, int start, int end) {
 307   QTreeView::rowsInserted(parent, start, end);
 308
 309   // ensure that newly inserted network nodes are expanded per default
 310   if(parent.data(NetworkModel::ItemTypeRole) != NetworkModel::NetworkItemType)
 311     return;
 312
 313   if(model()->rowCount(parent) == 1 && parent.data(NetworkModel::ItemActiveRole) == true) {
 314     // without updating the parent the expand will have no effect... Qt Bug?
 315     update(parent);
 316     expand(parent);
 317   }
 318 }
 319
 320 void BufferView::on_configChanged() {
 321   Q_ASSERT(model());
 322
 323   // expand all active networks... collapse inactive ones... unless manually changed
 324   QModelIndex networkIdx;
 325   NetworkId networkId;
 326   for(int row = 0; row < model()->rowCount(); row++) {
 327     networkIdx = model()->index(row, 0);
 328     if(model()->rowCount(networkIdx) ==  0)
 329       continue;
 330
 331     networkId = model()->data(networkIdx, NetworkModel::NetworkIdRole).value<NetworkId>();
 332     if(!networkId.isValid())
 333       continue;
 334
 335     update(networkIdx);
 336     setExpandedState(networkIdx);
 337   }
 338
 339   if(config()) {
 340     // update selection to current one
 341     Client::bufferModel()->synchronizeView(this);
 342   }
 343
 344   return;
 345 }
 346
 347 void BufferView::storeExpandedState(const QModelIndex &networkIdx) {
 348   NetworkId networkId = model()->data(networkIdx, NetworkModel::NetworkIdRole).value<NetworkId>();
 349
 350   int oldState = 0;
 351   if(isExpanded(networkIdx))
 352     oldState |= WasExpanded;
 353   if(model()->data(networkIdx, NetworkModel::ItemActiveRole).toBool())
 354     oldState |= WasActive;
 355
 356   _expandedState[networkId] = oldState;
 357 }
 358
 359 void BufferView::setExpandedState(const QModelIndex &networkIdx) {
 360   if(model()->data(networkIdx, NetworkModel::ItemTypeRole) != NetworkModel::NetworkItemType)
 361     return;
 362
 363   if(model()->rowCount(networkIdx) == 0)
 364     return;
 365
 366   NetworkId networkId = model()->data(networkIdx, NetworkModel::NetworkIdRole).value<NetworkId>();
 367
 368   bool networkActive = model()->data(networkIdx, NetworkModel::ItemActiveRole).toBool();
 369   bool expandNetwork = networkActive;
 370   if(_expandedState.contains(networkId)) {
 371     int oldState = _expandedState[networkId];
 372     if((bool)(oldState & WasActive) == networkActive)
 373       expandNetwork = (bool)(oldState & WasExpanded);
 374   }
 375
 376   storeExpandedState(networkIdx); // this call is needed to keep track of the isActive state
 377   if(expandNetwork != isExpanded(networkIdx))
 378     setExpanded(networkIdx, expandNetwork);
 379 }
 380
 381 void BufferView::dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight) {
 382   QTreeView::dataChanged(topLeft, bottomRight);
 383
 384   // determine how many items have been changed and if any of them is a networkitem
 385   // which just swichted from active to inactive or vice versa
 386   if(topLeft.data(NetworkModel::ItemTypeRole) != NetworkModel::NetworkItemType)
 387     return;
 388
 389   for(int i = topLeft.row(); i <= bottomRight.row(); i++) {
 390     QModelIndex networkIdx = topLeft.sibling(i, 0);
 391     setExpandedState(networkIdx);
 392   }
 393 }
 394
 395 void BufferView::toggleHeader(bool checked) {
 396   QAction *action = qobject_cast<QAction *>(sender());
 397   header()->setSectionHidden((action->property("column")).toInt(), !checked);
 398 }
 399
 400 void BufferView::contextMenuEvent(QContextMenuEvent *event) {
 401   QModelIndex index = indexAt(event->pos());
 402   if(!index.isValid())
 403     index = rootIndex();
 404
 405   QMenu contextMenu(this);
 406
 407   if(index.isValid()) {
 408     addActionsToMenu(&contextMenu, index);
 409   }
 410
 411   addFilterActions(&contextMenu, index);
 412
 413   if(!contextMenu.actions().isEmpty())
 414     contextMenu.exec(QCursor::pos());
 415 }
 416
 417 void BufferView::addActionsToMenu(QMenu *contextMenu, const QModelIndex &index) {
 418   QModelIndexList indexList = selectedIndexes();
 419   // make sure the item we clicked on is first
 420   indexList.removeAll(index);
 421   indexList.prepend(index);
 422
 423   Client::mainUi()->actionProvider()->addActions(contextMenu, indexList, this, "menuActionTriggered", (bool)config());
 424 }
 425
 426 void BufferView::addFilterActions(QMenu *contextMenu, const QModelIndex &index) {
 427   BufferViewFilter *filter = qobject_cast<BufferViewFilter *>(model());
 428   if(filter) {
 429     QList<QAction *> filterActions = filter->actions(index);
 430     if(!filterActions.isEmpty()) {
 431       contextMenu->addSeparator();
 432       foreach(QAction *action, filterActions) {
 433         contextMenu->addAction(action);
 434       }
 435     }
 436   }
 437 }
 438
 439 void BufferView::menuActionTriggered(QAction *result) {
 440   NetworkModelActionProvider::ActionType type = (NetworkModelActionProvider::ActionType)result->data().toInt();
 441   switch(type) {
 442     case NetworkModelActionProvider::HideBufferTemporarily:
 443       removeSelectedBuffers();
 444       break;
 445     case NetworkModelActionProvider::HideBufferPermanently:
 446       removeSelectedBuffers(true);
 447       break;
 448     default:
 449       return;
 450   }
 451 }
 452
 453 void BufferView::wheelEvent(QWheelEvent* event) {
 454   if(UiSettings().value("MouseWheelChangesBuffers", QVariant(true)).toBool() == (bool)(event->modifiers() & Qt::AltModifier))
 455     return QTreeView::wheelEvent(event);
 456
 457   int rowDelta = ( event->delta() > 0 ) ? -1 : 1;
 458   QModelIndex currentIndex = selectionModel()->currentIndex();
 459   QModelIndex resultingIndex;
 460   if( model()->hasIndex(  currentIndex.row() + rowDelta, currentIndex.column(), currentIndex.parent() ) )
 461     {
 462       resultingIndex = currentIndex.sibling( currentIndex.row() + rowDelta, currentIndex.column() );
 463     }
 464     else //if we scroll into a the parent node...
 465       {
 466         QModelIndex parent = currentIndex.parent();
 467         QModelIndex aunt = parent.sibling( parent.row() + rowDelta, parent.column() );
 468         if( rowDelta == -1 )
 469           resultingIndex = aunt.child( model()->rowCount( aunt ) - 1, 0 );
 470         else
 471           resultingIndex = aunt.child( 0, 0 );
 472         if( !resultingIndex.isValid() )
 473           return;
 474       }
 475   selectionModel()->setCurrentIndex( resultingIndex, QItemSelectionModel::ClearAndSelect | QItemSelectionModel::Rows );
 476   selectionModel()->select( resultingIndex, QItemSelectionModel::ClearAndSelect );
 477
 478 }
 479
 480 QSize BufferView::sizeHint() const {
 481   return QTreeView::sizeHint();
 482
 483   if(!model())
 484     return QTreeView::sizeHint();
 485
 486   if(model()->rowCount() == 0)
 487     return QSize(120, 50);
 488
 489   int columnSize = 0;
 490   for(int i = 0; i < model()->columnCount(); i++) {
 491     if(!isColumnHidden(i))
 492       columnSize += sizeHintForColumn(i);
 493   }
 494   return QSize(columnSize, 50);
 495 }
 496
 497 // ==============================
 498 //  BufferView Dock
 499 // ==============================
 500 BufferViewDock::BufferViewDock(BufferViewConfig *config, QWidget *parent)
 501   : QDockWidget(config->bufferViewName(), parent)
 502 {
 503   setObjectName("BufferViewDock-" + QString::number(config->bufferViewId()));
 504   toggleViewAction()->setData(config->bufferViewId());
 505   setAllowedAreas(Qt::RightDockWidgetArea|Qt::LeftDockWidgetArea);
 506   connect(config, SIGNAL(bufferViewNameSet(const QString &)), this, SLOT(bufferViewRenamed(const QString &)));
 507 }
 508
 509 void BufferViewDock::bufferViewRenamed(const QString &newName) {
 510   setWindowTitle(newName);
 511   toggleViewAction()->setText(newName);
 512 }