src/uisupport/bufferview.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 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  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 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 #include <QVBoxLayout>
  32
  33 #include "action.h"
  34 #include "buffermodel.h"
  35 #include "bufferviewfilter.h"
  36 #include "buffersettings.h"
  37 #include "buffersyncer.h"
  38 #include "client.h"
  39 #include "contextmenuactionprovider.h"
  40 #include "graphicalui.h"
  41 #include "network.h"
  42 #include "networkmodel.h"
  43 #include "contextmenuactionprovider.h"
  44
  45 /*****************************************
  46 * The TreeView showing the Buffers
  47 *****************************************/
  48 // Please be carefull when reimplementing methods which are used to inform the view about changes to the data
  49 // to be on the safe side: call QTreeView's method aswell (or TreeViewTouch's)
  50 BufferView::BufferView(QWidget *parent)
  51     : TreeViewTouch(parent)
  52 {
  53     connect(this, SIGNAL(collapsed(const QModelIndex &)), SLOT(storeExpandedState(const QModelIndex &)));
  54     connect(this, SIGNAL(expanded(const QModelIndex &)), SLOT(storeExpandedState(const QModelIndex &)));
  55
  56     setSelectionMode(QAbstractItemView::ExtendedSelection);
  57
  58     QAbstractItemDelegate *oldDelegate = itemDelegate();
  59     BufferViewDelegate *tristateDelegate = new BufferViewDelegate(this);
  60     setItemDelegate(tristateDelegate);
  61     delete oldDelegate;
  62 }
  63
  64
  65 void BufferView::init()
  66 {
  67     header()->setContextMenuPolicy(Qt::ActionsContextMenu);
  68     hideColumn(1);
  69     hideColumn(2);
  70     setIndentation(10);
  71
  72     // New entries will be expanded automatically when added; no need to call expandAll()
  73
  74     header()->hide(); // nobody seems to use this anyway
  75
  76     setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
  77
  78     // breaks with Qt 4.8
  79     if (QString("4.8.0") > qVersion()) // FIXME breaks with Qt versions >= 4.10!
  80         setAnimated(true);
  81
  82     // FIXME This is to workaround bug #663
  83     setUniformRowHeights(true);
  84
  85 #ifndef QT_NO_DRAGANDDROP
  86     setDragEnabled(true);
  87     setAcceptDrops(true);
  88     setDropIndicatorShown(true);
  89 #endif
  90
  91     setSortingEnabled(true);
  92     sortByColumn(0, Qt::AscendingOrder);
  93
  94 #if defined Q_OS_MACOS || defined Q_OS_WIN
  95     // afaik this is better on Mac and Windows
  96     disconnect(this, SIGNAL(activated(QModelIndex)), this, SLOT(joinChannel(QModelIndex)));
  97     connect(this, SIGNAL(activated(QModelIndex)), SLOT(joinChannel(QModelIndex)));
  98 #else
  99     disconnect(this, SIGNAL(doubleClicked(QModelIndex)), this, SLOT(joinChannel(QModelIndex)));
 100     connect(this, SIGNAL(doubleClicked(QModelIndex)), SLOT(joinChannel(QModelIndex)));
 101 #endif
 102 }
 103
 104
 105 void BufferView::setModel(QAbstractItemModel *model)
 106 {
 107     delete selectionModel();
 108
 109     TreeViewTouch::setModel(model);
 110     init();
 111     // remove old Actions
 112     QList<QAction *> oldactions = header()->actions();
 113     foreach(QAction *action, oldactions) {
 114         header()->removeAction(action);
 115         action->deleteLater();
 116     }
 117
 118     if (!model)
 119         return;
 120
 121     QString sectionName;
 122     QAction *showSection;
 123     for (int i = 1; i < model->columnCount(); i++) {
 124         sectionName = (model->headerData(i, Qt::Horizontal, Qt::DisplayRole)).toString();
 125         showSection = new QAction(sectionName, header());
 126         showSection->setCheckable(true);
 127         showSection->setChecked(!isColumnHidden(i));
 128         showSection->setProperty("column", i);
 129         connect(showSection, SIGNAL(toggled(bool)), this, SLOT(toggleHeader(bool)));
 130         header()->addAction(showSection);
 131     }
 132
 133     connect(model, SIGNAL(layoutChanged()), this, SLOT(on_layoutChanged()));
 134
 135     // Make sure collapsation is correct after setting a model
 136     // This might not be needed here, only in BufferView::setFilteredModel().  If issues arise, just
 137     // move down to setFilteredModel (which calls this function).
 138     setExpandedState();
 139 }
 140
 141
 142 void BufferView::setFilteredModel(QAbstractItemModel *model_, BufferViewConfig *config)
 143 {
 144     BufferViewFilter *filter = qobject_cast<BufferViewFilter *>(model());
 145     if (filter) {
 146         filter->setConfig(config);
 147         setConfig(config);
 148         return;
 149     }
 150
 151     if (model()) {
 152         disconnect(this, 0, model(), 0);
 153         disconnect(model(), 0, this, 0);
 154     }
 155
 156     if (!model_) {
 157         setModel(model_);
 158     }
 159     else {
 160         BufferViewFilter *filter = new BufferViewFilter(model_, config);
 161         setModel(filter);
 162         connect(filter, SIGNAL(configChanged()), this, SLOT(on_configChanged()));
 163     }
 164     setConfig(config);
 165 }
 166
 167
 168 void BufferView::setConfig(BufferViewConfig *config)
 169 {
 170     if (_config == config)
 171         return;
 172
 173     if (_config) {
 174         disconnect(_config, 0, this, 0);
 175     }
 176
 177     _config = config;
 178     if (config) {
 179         connect(config, SIGNAL(networkIdSet(const NetworkId &)), this, SLOT(setRootIndexForNetworkId(const NetworkId &)));
 180         setRootIndexForNetworkId(config->networkId());
 181     }
 182     else {
 183         setIndentation(10);
 184         setRootIndex(QModelIndex());
 185     }
 186 }
 187
 188
 189 void BufferView::setRootIndexForNetworkId(const NetworkId &networkId)
 190 {
 191     if (!networkId.isValid() || !model()) {
 192         setIndentation(10);
 193         setRootIndex(QModelIndex());
 194     }
 195     else {
 196         setIndentation(5);
 197         int networkCount = model()->rowCount();
 198         QModelIndex child;
 199         for (int i = 0; i < networkCount; i++) {
 200             child = model()->index(i, 0);
 201             if (networkId == model()->data(child, NetworkModel::NetworkIdRole).value<NetworkId>())
 202                 setRootIndex(child);
 203         }
 204     }
 205 }
 206
 207
 208 void BufferView::joinChannel(const QModelIndex &index)
 209 {
 210     BufferInfo::Type bufferType = (BufferInfo::Type)index.data(NetworkModel::BufferTypeRole).value<int>();
 211
 212     if (bufferType != BufferInfo::ChannelBuffer)
 213         return;
 214
 215     BufferInfo bufferInfo = index.data(NetworkModel::BufferInfoRole).value<BufferInfo>();
 216
 217     Client::userInput(bufferInfo, QString("/JOIN %1").arg(bufferInfo.bufferName()));
 218 }
 219
 220
 221 void BufferView::dropEvent(QDropEvent *event)
 222 {
 223     QModelIndex index = indexAt(event->pos());
 224
 225     QRect indexRect = visualRect(index);
 226     QPoint cursorPos = event->pos();
 227
 228     // check if we're really _on_ the item and not indicating a move to just above or below the item
 229     // Magic margin number for this is from QAbstractItemViewPrivate::position()
 230     const int margin = 2;
 231     if (cursorPos.y() - indexRect.top() < margin
 232         || indexRect.bottom() - cursorPos.y() < margin)
 233         return TreeViewTouch::dropEvent(event);
 234
 235     // If more than one buffer was being dragged, treat this as a rearrangement instead of a merge request
 236     QList<QPair<NetworkId, BufferId> > bufferList = Client::networkModel()->mimeDataToBufferList(event->mimeData());
 237     if (bufferList.count() != 1)
 238         return TreeViewTouch::dropEvent(event);
 239
 240     // Get the Buffer ID of the buffer that was being dragged
 241     BufferId bufferId2 = bufferList[0].second;
 242
 243     // Get the Buffer ID of the target buffer
 244     BufferId bufferId1 = index.data(NetworkModel::BufferIdRole).value<BufferId>();
 245
 246     // If the source and target are the same buffer, this was an aborted rearrangement
 247     if (bufferId1 == bufferId2)
 248         return TreeViewTouch::dropEvent(event);
 249
 250     // Get index of buffer that was being dragged
 251     QModelIndex index2 = Client::networkModel()->bufferIndex(bufferId2);
 252
 253     // If the buffer being dragged is a channel and we're still joined to it, treat this as a rearrangement
 254     // This prevents us from being joined to a channel with no associated UI elements
 255     if (index2.data(NetworkModel::BufferTypeRole) == BufferInfo::ChannelBuffer && index2.data(NetworkModel::ItemActiveRole) == true)
 256         return TreeViewTouch::dropEvent(event);
 257
 258     //If the source buffer is not mergeable(AKA not a Channel and not a Query), try rearranging instead
 259     if (index2.data(NetworkModel::BufferTypeRole) != BufferInfo::ChannelBuffer && index2.data(NetworkModel::BufferTypeRole) != BufferInfo::QueryBuffer)
 260         return TreeViewTouch::dropEvent(event);
 261
 262     // If the target buffer is not mergeable(AKA not a Channel and not a Query), try rearranging instead
 263     if (index.data(NetworkModel::BufferTypeRole) != BufferInfo::ChannelBuffer && index.data(NetworkModel::BufferTypeRole) != BufferInfo::QueryBuffer)
 264         return TreeViewTouch::dropEvent(event);
 265
 266     // Confirm that the user really wants to merge the buffers before doing so
 267     int res = QMessageBox::question(0, tr("Merge buffers permanently?"),
 268         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)),
 269         QMessageBox::Yes|QMessageBox::No, QMessageBox::No);
 270     if (res == QMessageBox::Yes) {
 271         Client::mergeBuffersPermanently(bufferId1, bufferId2);
 272     }
 273 }
 274
 275
 276 void BufferView::removeSelectedBuffers(bool permanently)
 277 {
 278     if (!config())
 279         return;
 280
 281     BufferId bufferId;
 282     QSet<BufferId> removedRows;
 283     foreach(QModelIndex index, selectionModel()->selectedIndexes()) {
 284         if (index.data(NetworkModel::ItemTypeRole) != NetworkModel::BufferItemType)
 285             continue;
 286
 287         bufferId = index.data(NetworkModel::BufferIdRole).value<BufferId>();
 288         if (removedRows.contains(bufferId))
 289             continue;
 290
 291         removedRows << bufferId;
 292     }
 293
 294     foreach(BufferId bufferId, removedRows) {
 295         if (permanently)
 296             config()->requestRemoveBufferPermanently(bufferId);
 297         else
 298             config()->requestRemoveBuffer(bufferId);
 299     }
 300 }
 301
 302
 303 void BufferView::rowsInserted(const QModelIndex &parent, int start, int end)
 304 {
 305     TreeViewTouch::rowsInserted(parent, start, end);
 306
 307     // ensure that newly inserted network nodes are expanded per default
 308     if (parent.data(NetworkModel::ItemTypeRole) != NetworkModel::NetworkItemType)
 309         return;
 310
 311     setExpandedState(parent);
 312 }
 313
 314
 315 void BufferView::on_layoutChanged()
 316 {
 317     int numNets = model()->rowCount(QModelIndex());
 318     for (int row = 0; row < numNets; row++) {
 319         QModelIndex networkIdx = model()->index(row, 0, QModelIndex());
 320         setExpandedState(networkIdx);
 321     }
 322 }
 323
 324
 325 void BufferView::on_configChanged()
 326 {
 327     Q_ASSERT(model());
 328
 329     // Expand/collapse as needed
 330     setExpandedState();
 331
 332     if (config()) {
 333         // update selection to current one
 334         Client::bufferModel()->synchronizeView(this);
 335     }
 336 }
 337
 338
 339 void BufferView::setExpandedState()
 340 {
 341     // Expand all active networks, collapse inactive ones... unless manually changed
 342     QModelIndex networkIdx;
 343     NetworkId networkId;
 344     for (int row = 0; row < model()->rowCount(); row++) {
 345         networkIdx = model()->index(row, 0);
 346         if (model()->rowCount(networkIdx) ==  0)
 347             continue;
 348
 349         networkId = model()->data(networkIdx, NetworkModel::NetworkIdRole).value<NetworkId>();
 350         if (!networkId.isValid())
 351             continue;
 352
 353         setExpandedState(networkIdx);
 354     }
 355 }
 356
 357
 358 void BufferView::storeExpandedState(const QModelIndex &networkIdx)
 359 {
 360     NetworkId networkId = model()->data(networkIdx, NetworkModel::NetworkIdRole).value<NetworkId>();
 361
 362     int oldState = 0;
 363     if (isExpanded(networkIdx))
 364         oldState |= WasExpanded;
 365     if (model()->data(networkIdx, NetworkModel::ItemActiveRole).toBool())
 366         oldState |= WasActive;
 367
 368     _expandedState[networkId] = oldState;
 369 }
 370
 371
 372 void BufferView::setExpandedState(const QModelIndex &networkIdx)
 373 {
 374     if (model()->data(networkIdx, NetworkModel::ItemTypeRole) != NetworkModel::NetworkItemType)
 375         return;
 376
 377     if (model()->rowCount(networkIdx) == 0)
 378         return;
 379
 380     NetworkId networkId = model()->data(networkIdx, NetworkModel::NetworkIdRole).value<NetworkId>();
 381
 382     bool networkActive = model()->data(networkIdx, NetworkModel::ItemActiveRole).toBool();
 383     bool expandNetwork = networkActive;
 384     if (_expandedState.contains(networkId)) {
 385         int oldState = _expandedState[networkId];
 386         if ((bool)(oldState & WasActive) == networkActive)
 387             expandNetwork = (bool)(oldState & WasExpanded);
 388     }
 389
 390     if (expandNetwork != isExpanded(networkIdx)) {
 391         update(networkIdx);
 392         setExpanded(networkIdx, expandNetwork);
 393     }
 394     storeExpandedState(networkIdx); // this call is needed to keep track of the isActive state
 395 }
 396
 397 #if QT_VERSION < 0x050000
 398 void BufferView::dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight)
 399 {
 400     TreeViewTouch::dataChanged(topLeft, bottomRight);
 401 #else
 402 void BufferView::dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector<int> &roles)
 403 {
 404     TreeViewTouch::dataChanged(topLeft, bottomRight, roles);
 405 #endif
 406
 407     // determine how many items have been changed and if any of them is a networkitem
 408     // which just swichted from active to inactive or vice versa
 409     if (topLeft.data(NetworkModel::ItemTypeRole) != NetworkModel::NetworkItemType)
 410         return;
 411
 412     for (int i = topLeft.row(); i <= bottomRight.row(); i++) {
 413         QModelIndex networkIdx = topLeft.sibling(i, 0);
 414         setExpandedState(networkIdx);
 415     }
 416 }
 417
 418
 419 void BufferView::toggleHeader(bool checked)
 420 {
 421     QAction *action = qobject_cast<QAction *>(sender());
 422     header()->setSectionHidden((action->property("column")).toInt(), !checked);
 423 }
 424
 425
 426 void BufferView::contextMenuEvent(QContextMenuEvent *event)
 427 {
 428     QModelIndex index = indexAt(event->pos());
 429     if (!index.isValid())
 430         index = rootIndex();
 431
 432     QMenu contextMenu(this);
 433
 434     if (index.isValid()) {
 435         addActionsToMenu(&contextMenu, index);
 436     }
 437
 438     addFilterActions(&contextMenu, index);
 439
 440     if (!contextMenu.actions().isEmpty())
 441         contextMenu.exec(QCursor::pos());
 442 }
 443
 444
 445 void BufferView::addActionsToMenu(QMenu *contextMenu, const QModelIndex &index)
 446 {
 447     QModelIndexList indexList = selectedIndexes();
 448     // make sure the item we clicked on is first
 449     indexList.removeAll(index);
 450     indexList.prepend(index);
 451
 452     GraphicalUi::contextMenuActionProvider()->addActions(contextMenu, indexList, this, "menuActionTriggered", (bool)config());
 453 }
 454
 455
 456 void BufferView::addFilterActions(QMenu *contextMenu, const QModelIndex &index)
 457 {
 458     BufferViewFilter *filter = qobject_cast<BufferViewFilter *>(model());
 459     if (filter) {
 460         QList<QAction *> filterActions = filter->actions(index);
 461         if (!filterActions.isEmpty()) {
 462             contextMenu->addSeparator();
 463             foreach(QAction *action, filterActions) {
 464                 contextMenu->addAction(action);
 465             }
 466         }
 467     }
 468 }
 469
 470
 471 void BufferView::menuActionTriggered(QAction *result)
 472 {
 473     ContextMenuActionProvider::ActionType type = (ContextMenuActionProvider::ActionType)result->data().toInt();
 474     switch (type) {
 475     case ContextMenuActionProvider::HideBufferTemporarily:
 476         removeSelectedBuffers();
 477         break;
 478     case ContextMenuActionProvider::HideBufferPermanently:
 479         removeSelectedBuffers(true);
 480         break;
 481     default:
 482         return;
 483     }
 484 }
 485
 486
 487 void BufferView::nextBuffer()
 488 {
 489     changeBuffer(Forward);
 490 }
 491
 492
 493 void BufferView::previousBuffer()
 494 {
 495     changeBuffer(Backward);
 496 }
 497
 498
 499 void BufferView::changeBuffer(Direction direction)
 500 {
 501     QModelIndex currentIndex = selectionModel()->currentIndex();
 502     QModelIndex resultingIndex;
 503
 504     QModelIndex lastNetIndex = model()->index(model()->rowCount() - 1, 0, QModelIndex());
 505
 506     if (currentIndex.parent().isValid()) {
 507         //If we are a child node just switch among siblings unless it's the first/last child
 508         resultingIndex = currentIndex.sibling(currentIndex.row() + direction, 0);
 509
 510         if (!resultingIndex.isValid()) {
 511             QModelIndex parent = currentIndex.parent();
 512             if (direction == Backward)
 513                 resultingIndex = parent;
 514             else
 515                 resultingIndex = parent.sibling(parent.row() + direction, 0);
 516         }
 517     }
 518     else {
 519         //If we have a toplevel node, try and get an adjacent child
 520         if (direction == Backward) {
 521             QModelIndex newParent = currentIndex.sibling(currentIndex.row() - 1, 0);
 522             if (currentIndex.row() == 0)
 523                 newParent = lastNetIndex;
 524             if (model()->hasChildren(newParent))
 525                 resultingIndex = newParent.child(model()->rowCount(newParent) - 1, 0);
 526             else
 527                 resultingIndex = newParent;
 528         }
 529         else {
 530             if (model()->hasChildren(currentIndex))
 531                 resultingIndex = currentIndex.child(0, 0);
 532             else
 533                 resultingIndex = currentIndex.sibling(currentIndex.row() + 1, 0);
 534         }
 535     }
 536
 537     if (!resultingIndex.isValid()) {
 538         if (direction == Forward)
 539             resultingIndex = model()->index(0, 0, QModelIndex());
 540         else
 541             resultingIndex = lastNetIndex.child(model()->rowCount(lastNetIndex) - 1, 0);
 542     }
 543
 544     selectionModel()->setCurrentIndex(resultingIndex, QItemSelectionModel::ClearAndSelect | QItemSelectionModel::Rows);
 545     selectionModel()->select(resultingIndex, QItemSelectionModel::ClearAndSelect);
 546 }
 547
 548 void BufferView::selectFirstBuffer()
 549 {
 550     int networksCount = model()->rowCount(QModelIndex());
 551     if (networksCount == 0) {
 552         return;
 553     }
 554
 555     QModelIndex bufferIndex;
 556     for (int row = 0; row < networksCount; row++) {
 557         QModelIndex networkIndex = model()->index(row, 0, QModelIndex());
 558         int childCount = model()->rowCount(networkIndex);
 559         if (childCount > 0) {
 560             bufferIndex = model()->index(0, 0, networkIndex);
 561             break;
 562         }
 563     }
 564
 565     if (!bufferIndex.isValid()) {
 566         return;
 567     }
 568
 569     selectionModel()->setCurrentIndex(bufferIndex, QItemSelectionModel::ClearAndSelect | QItemSelectionModel::Rows);
 570     selectionModel()->select(bufferIndex, QItemSelectionModel::ClearAndSelect);
 571 }
 572
 573 void BufferView::wheelEvent(QWheelEvent *event)
 574 {
 575     if (ItemViewSettings().mouseWheelChangesBuffer() == (bool)(event->modifiers() & Qt::AltModifier))
 576         return TreeViewTouch::wheelEvent(event);
 577
 578     int rowDelta = (event->delta() > 0) ? -1 : 1;
 579     changeBuffer((Direction)rowDelta);
 580 }
 581
 582
 583 void BufferView::hideCurrentBuffer()
 584 {
 585     QModelIndex index = selectionModel()->currentIndex();
 586     if (index.data(NetworkModel::ItemTypeRole) != NetworkModel::BufferItemType)
 587         return;
 588
 589     BufferId bufferId = index.data(NetworkModel::BufferIdRole).value<BufferId>();
 590
 591     //The check above means we won't be looking at a network, which should always be the first row, so we can just go backwards.
 592     changeBuffer(Backward);
 593
 594     config()->requestRemoveBuffer(bufferId);
 595 }
 596
 597 void BufferView::filterTextChanged(const QString& filterString)
 598 {
 599     BufferViewFilter *filter = qobject_cast<BufferViewFilter *>(model());
 600     if (!filter) {
 601         return;
 602     }
 603     filter->setFilterString(filterString);
 604     on_configChanged(); // make sure collapsation is correct
 605 }
 606
 607
 608 QSize BufferView::sizeHint() const
 609 {
 610     return TreeViewTouch::sizeHint();
 611
 612     if (!model())
 613         return TreeViewTouch::sizeHint();
 614
 615     if (model()->rowCount() == 0)
 616         return QSize(120, 50);
 617
 618     int columnSize = 0;
 619     for (int i = 0; i < model()->columnCount(); i++) {
 620         if (!isColumnHidden(i))
 621             columnSize += sizeHintForColumn(i);
 622     }
 623     return QSize(columnSize, 50);
 624 }
 625
 626
 627 void BufferView::changeHighlight(BufferView::Direction direction)
 628 {
 629     // If for some weird reason we get a new delegate
 630     BufferViewDelegate *delegate = qobject_cast<BufferViewDelegate*>(itemDelegate(_currentHighlight));
 631     if (delegate) {
 632         delegate->currentHighlight = QModelIndex();
 633     }
 634
 635     QModelIndex newIndex = _currentHighlight;
 636     if (!newIndex.isValid()) {
 637         newIndex = model()->index(0, 0);
 638     }
 639
 640     if (direction == Backward) {
 641         newIndex = indexBelow(newIndex);
 642     } else {
 643         newIndex = indexAbove(newIndex);
 644     }
 645
 646     if (!newIndex.isValid()) {
 647         return;
 648     }
 649
 650     _currentHighlight = newIndex;
 651
 652     delegate = qobject_cast<BufferViewDelegate*>(itemDelegate(_currentHighlight));
 653     if (delegate) {
 654         delegate->currentHighlight = _currentHighlight;
 655     }
 656     viewport()->update();
 657 }
 658
 659 void BufferView::selectHighlighted()
 660 {
 661     if (_currentHighlight.isValid()) {
 662         selectionModel()->setCurrentIndex(_currentHighlight, QItemSelectionModel::ClearAndSelect | QItemSelectionModel::Rows);
 663         selectionModel()->select(_currentHighlight, QItemSelectionModel::ClearAndSelect);
 664     } else {
 665         selectFirstBuffer();
 666     }
 667
 668     clearHighlight();
 669 }
 670
 671 void BufferView::clearHighlight()
 672 {
 673     // If for some weird reason we get a new delegate
 674     BufferViewDelegate *delegate = qobject_cast<BufferViewDelegate*>(itemDelegate(_currentHighlight));
 675     if (delegate) {
 676         delegate->currentHighlight = QModelIndex();
 677     }
 678     _currentHighlight = QModelIndex();
 679     viewport()->update();
 680 }
 681
 682 // ****************************************
 683 //  BufferViewDelegate
 684 // ****************************************
 685 class ColorsChangedEvent : public QEvent
 686 {
 687 public:
 688     ColorsChangedEvent() : QEvent(QEvent::User) {};
 689 };
 690
 691
 692 BufferViewDelegate::BufferViewDelegate(QObject *parent)
 693     : QStyledItemDelegate(parent)
 694 {
 695 }
 696
 697
 698 void BufferViewDelegate::customEvent(QEvent *event)
 699 {
 700     if (event->type() != QEvent::User)
 701         return;
 702
 703     event->accept();
 704 }
 705
 706
 707 bool BufferViewDelegate::editorEvent(QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index)
 708 {
 709     if (event->type() != QEvent::MouseButtonRelease)
 710         return QStyledItemDelegate::editorEvent(event, model, option, index);
 711
 712     if (!(model->flags(index) & Qt::ItemIsUserCheckable))
 713         return QStyledItemDelegate::editorEvent(event, model, option, index);
 714
 715     QVariant value = index.data(Qt::CheckStateRole);
 716     if (!value.isValid())
 717         return QStyledItemDelegate::editorEvent(event, model, option, index);
 718
 719 #if QT_VERSION < 0x050000
 720     QStyleOptionViewItemV4 viewOpt(option);
 721 #else
 722     QStyleOptionViewItem viewOpt(option);
 723 #endif
 724     initStyleOption(&viewOpt, index);
 725
 726     QRect checkRect = viewOpt.widget->style()->subElementRect(QStyle::SE_ItemViewItemCheckIndicator, &viewOpt, viewOpt.widget);
 727     QMouseEvent *me = static_cast<QMouseEvent *>(event);
 728
 729     if (me->button() != Qt::LeftButton || !checkRect.contains(me->pos()))
 730         return QStyledItemDelegate::editorEvent(event, model, option, index);
 731
 732     Qt::CheckState state = static_cast<Qt::CheckState>(value.toInt());
 733     if (state == Qt::Unchecked)
 734         state = Qt::PartiallyChecked;
 735     else if (state == Qt::PartiallyChecked)
 736         state = Qt::Checked;
 737     else
 738         state = Qt::Unchecked;
 739     model->setData(index, state, Qt::CheckStateRole);
 740     return true;
 741 }
 742
 743
 744 // ==============================
 745 //  BufferView Dock
 746 // ==============================
 747 BufferViewDock::BufferViewDock(BufferViewConfig *config, QWidget *parent)
 748     : QDockWidget(parent),
 749     _childWidget(0),
 750     _widget(new QWidget(parent)),
 751     _filterEdit(new QLineEdit(parent)),
 752     _active(false),
 753     _title(config->bufferViewName())
 754 {
 755     setObjectName("BufferViewDock-" + QString::number(config->bufferViewId()));
 756     toggleViewAction()->setData(config->bufferViewId());
 757     setAllowedAreas(Qt::RightDockWidgetArea|Qt::LeftDockWidgetArea);
 758     connect(config, SIGNAL(bufferViewNameSet(const QString &)), this, SLOT(bufferViewRenamed(const QString &)));
 759     connect(config, SIGNAL(configChanged()), SLOT(configChanged()));
 760     updateTitle();
 761
 762     _widget->setLayout(new QVBoxLayout);
 763     _widget->layout()->setSpacing(0);
 764     _widget->layout()->setContentsMargins(0, 0, 0, 0);
 765
 766     // We need to potentially hide it early, so it doesn't flicker
 767     _filterEdit->setVisible(config->showSearch());
 768     _filterEdit->setFocusPolicy(Qt::ClickFocus);
 769     _filterEdit->installEventFilter(this);
 770     _filterEdit->setPlaceholderText(tr("Search..."));
 771     connect(_filterEdit, SIGNAL(returnPressed()), SLOT(onFilterReturnPressed()));
 772
 773     _widget->layout()->addWidget(_filterEdit);
 774     QDockWidget::setWidget(_widget);
 775 }
 776
 777 void BufferViewDock::setLocked(bool locked) {
 778     if (locked) {
 779         setFeatures(0);
 780     }
 781     else {
 782         setFeatures(QDockWidget::DockWidgetClosable | QDockWidget::DockWidgetMovable | QDockWidget::DockWidgetFloatable);
 783     }
 784 }
 785
 786 void BufferViewDock::updateTitle()
 787 {
 788     QString title = _title;
 789     if (isActive())
 790         title.prepend(QString::fromUtf8("• "));
 791     setWindowTitle(title);
 792 }
 793
 794 void BufferViewDock::configChanged()
 795 {
 796     if (_filterEdit->isVisible() != config()->showSearch()) {
 797         _filterEdit->setVisible(config()->showSearch());
 798         _filterEdit->clear();
 799     }
 800 }
 801
 802 void BufferViewDock::onFilterReturnPressed()
 803 {
 804     if (_oldFocusItem) {
 805         _oldFocusItem->setFocus();
 806         _oldFocusItem = 0;
 807     }
 808
 809     if (!config()->showSearch()) {
 810         _filterEdit->setVisible(false);
 811     }
 812
 813     BufferView *view = bufferView();
 814     if (!view) {
 815         return;
 816     }
 817
 818     if (!_filterEdit->text().isEmpty()) {
 819         view->selectHighlighted();
 820         _filterEdit->clear();
 821     } else {
 822         view->clearHighlight();
 823     }
 824 }
 825
 826 void BufferViewDock::setActive(bool active)
 827 {
 828     if (active != isActive()) {
 829         _active = active;
 830         updateTitle();
 831         if (active) {
 832             raise();  // for tabbed docks
 833         }
 834     }
 835 }
 836
 837 bool BufferViewDock::eventFilter(QObject *object, QEvent *event)
 838 {
 839    if (object != _filterEdit)  {
 840        return false;
 841    }
 842
 843    if (event->type() == QEvent::FocusOut) {
 844        if (!config()->showSearch() && _filterEdit->text().isEmpty()) {
 845            _filterEdit->setVisible(false);
 846            return true;
 847        }
 848    } else if (event->type() == QEvent::KeyRelease) {
 849        QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
 850
 851        BufferView *view = bufferView();
 852        if (!view) {
 853            return false;
 854        }
 855
 856        switch (keyEvent->key()) {
 857        case Qt::Key_Escape: {
 858            _filterEdit->clear();
 859
 860            if (!_oldFocusItem) {
 861                return false;
 862            }
 863
 864            _oldFocusItem->setFocus();
 865            _oldFocusItem = nullptr;
 866            return true;
 867        }
 868        case Qt::Key_Down:
 869            view->changeHighlight(BufferView::Backward);
 870            return true;
 871        case Qt::Key_Up:
 872            view->changeHighlight(BufferView::Forward);
 873            return true;
 874        default:
 875            break;
 876        }
 877
 878        return false;
 879    }
 880
 881    return false;
 882 }
 883
 884 void BufferViewDock::bufferViewRenamed(const QString &newName)
 885 {
 886     _title = newName;
 887     updateTitle();
 888     toggleViewAction()->setText(newName);
 889 }
 890
 891
 892 int BufferViewDock::bufferViewId() const
 893 {
 894     BufferView *view = bufferView();
 895     if (!view)
 896         return 0;
 897
 898     if (view->config())
 899         return view->config()->bufferViewId();
 900     else
 901         return 0;
 902 }
 903
 904
 905 BufferViewConfig *BufferViewDock::config() const
 906 {
 907     BufferView *view = bufferView();
 908     if (!view)
 909         return 0;
 910     else
 911         return view->config();
 912 }
 913
 914 void BufferViewDock::setWidget(QWidget *newWidget)
 915 {
 916     _widget->layout()->addWidget(newWidget);
 917     _childWidget = newWidget;
 918
 919     connect(_filterEdit, SIGNAL(textChanged(QString)), bufferView(), SLOT(filterTextChanged(QString)));
 920 }
 921
 922 void BufferViewDock::activateFilter()
 923 {
 924     if (!_filterEdit->isVisible()) {
 925         _filterEdit->setVisible(true);
 926     }
 927
 928     _oldFocusItem = qApp->focusWidget();
 929
 930     _filterEdit->setFocus();
 931 }
 932
 933
 934 void BufferViewDelegate::paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const
 935 {
 936     QStyleOptionViewItem newOption = option;
 937     if (index == currentHighlight) {
 938         newOption.state |= QStyle::State_HasFocus;
 939     }
 940     QStyledItemDelegate::paint(painter, newOption, index);
 941 }