Fixes #481 - Sort buffer views alphabetically.
[quassel.git] / src / uisupport / bufferviewfilter.cpp
index 2de916b..4ef0ec8 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-09 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
 
 #include "bufferinfo.h"
 #include "buffermodel.h"
+#include "buffersettings.h"
 #include "client.h"
+#include "clientbufferviewconfig.h"
 #include "iconloader.h"
 #include "networkmodel.h"
 
-#include "uisettings.h"
-
 class CheckRemovalEvent : public QEvent {
 public:
   CheckRemovalEvent(const QModelIndex &source_index) : QEvent(QEvent::User), index(source_index) {};
@@ -45,28 +45,32 @@ BufferViewFilter::BufferViewFilter(QAbstractItemModel *model, BufferViewConfig *
   : QSortFilterProxyModel(model),
     _config(0),
     _sortOrder(Qt::AscendingOrder),
-    _userOfflineIcon(SmallIcon("user-offline")),
-    _userAwayIcon(SmallIcon("user-away")),
-    _userOnlineIcon(SmallIcon("user-online"))
+    _userOfflineIcon(SmallIcon("im-user-offline")),
+    _userAwayIcon(SmallIcon("im-user-away")),
+    _userOnlineIcon(SmallIcon("im-user")),
+    _editMode(false),
+    _enableEditMode(tr("Show / Hide buffers"), this)
 {
   setConfig(config);
   setSourceModel(model);
 
   setDynamicSortFilter(true);
 
-  loadColors();
-
   connect(this, SIGNAL(_dataChanged(const QModelIndex &, const QModelIndex &)),
          this, SLOT(_q_sourceDataChanged(QModelIndex,QModelIndex)));
+
+  _enableEditMode.setCheckable(true);
+  _enableEditMode.setChecked(_editMode);
+  connect(&_enableEditMode, SIGNAL(toggled(bool)), this, SLOT(enableEditMode(bool)));
+
+  BufferSettings bufferSettings;
+  _showUserStateIcons = bufferSettings.showUserStateIcons();
+  bufferSettings.notify("ShowUserStateIcons", this, SLOT(showUserStateIconsChanged()));
 }
 
-void BufferViewFilter::loadColors() {
-  UiSettings s("QtUiStyle/Colors");
-  _FgColorInactiveActivity = s.value("inactiveActivityFG", QVariant(QColor(Qt::gray))).value<QColor>();
-  _FgColorNoActivity = s.value("noActivityFG", QVariant(QColor(Qt::black))).value<QColor>();
-  _FgColorHighlightActivity = s.value("highlightActivityFG", QVariant(QColor(Qt::magenta))).value<QColor>();
-  _FgColorNewMessageActivity = s.value("newMessageActivityFG", QVariant(QColor(Qt::green))).value<QColor>();
-  _FgColorOtherActivity = s.value("otherActivityFG", QVariant(QColor(Qt::darkGreen))).value<QColor>();
+void BufferViewFilter::showUserStateIconsChanged() {
+  BufferSettings bufferSettings;
+  _showUserStateIcons = bufferSettings.showUserStateIcons();
 }
 
 void BufferViewFilter::setConfig(BufferViewConfig *config) {
@@ -81,6 +85,7 @@ void BufferViewFilter::setConfig(BufferViewConfig *config) {
 
   if(!config) {
     invalidate();
+    setObjectName("");
     return;
   }
 
@@ -111,14 +116,69 @@ void BufferViewFilter::configInitialized() {
 
   disconnect(config(), SIGNAL(initDone()), this, SLOT(configInitialized()));
 
+  setObjectName(config()->bufferViewName());
+
   invalidate();
   emit configChanged();
 }
 
+QList<QAction *> BufferViewFilter::actions(const QModelIndex &index) {
+  Q_UNUSED(index)
+  QList<QAction *> actionList;
+  actionList << &_enableEditMode;
+  return actionList;
+}
+
+void BufferViewFilter::enableEditMode(bool enable) {
+  if(_editMode == enable) {
+    return;
+  }
+  _editMode = enable;
+
+  if(!config())
+    return;
+
+  if(enable == false) {
+    int numBuffers = config()->bufferList().count();
+    QSet<BufferId>::const_iterator iter;
+    for(iter = _toAdd.constBegin(); iter != _toAdd.constEnd(); iter++) {
+      if(config()->bufferList().contains(*iter))
+       continue;
+      config()->requestAddBuffer(*iter, numBuffers);
+    }
+    for(iter = _toTempRemove.constBegin(); iter != _toTempRemove.constEnd(); iter++) {
+      if(config()->temporarilyRemovedBuffers().contains(*iter))
+        continue;
+      config()->requestRemoveBuffer(*iter);
+    }
+    for(iter = _toRemove.constBegin(); iter != _toRemove.constEnd(); iter++) {
+      if(config()->removedBuffers().contains(*iter))
+        continue;
+      config()->requestRemoveBufferPermanently(*iter);
+    }
+  }
+  _toAdd.clear();
+  _toTempRemove.clear();
+  _toRemove.clear();
+
+  invalidate();
+}
+
+
 Qt::ItemFlags BufferViewFilter::flags(const QModelIndex &index) const {
-  Qt::ItemFlags flags = mapToSource(index).flags();
-  if(_config && (index == QModelIndex() || index.parent() == QModelIndex()))
-    flags |= Qt::ItemIsDropEnabled;
+  QModelIndex source_index = mapToSource(index);
+  Qt::ItemFlags flags = sourceModel()->flags(source_index);
+  if(config()) {
+    if(source_index == QModelIndex() || sourceModel()->data(source_index, NetworkModel::ItemTypeRole) == NetworkModel::NetworkItemType) {
+      flags |= Qt::ItemIsDropEnabled;
+    } else if(_editMode) {
+      flags |= Qt::ItemIsUserCheckable | Qt::ItemIsTristate;
+    }
+    ClientBufferViewConfig *clientConf = qobject_cast<ClientBufferViewConfig *>(config());
+    if(clientConf && clientConf->isLocked()) {
+      flags &= ~(Qt::ItemIsDropEnabled | Qt::ItemIsDragEnabled);
+    }
+  }
   return flags;
 }
 
@@ -127,8 +187,9 @@ bool BufferViewFilter::dropMimeData(const QMimeData *data, Qt::DropAction action
     return QSortFilterProxyModel::dropMimeData(data, action, row, column, parent);
 
   NetworkId droppedNetworkId;
-  if(parent.data(NetworkModel::ItemTypeRole) == NetworkModel::NetworkItemType)
-    droppedNetworkId = parent.data(NetworkModel::NetworkIdRole).value<NetworkId>();
+  QModelIndex source_parent = mapToSource(parent);
+  if(sourceModel()->data(source_parent, NetworkModel::ItemTypeRole) == NetworkModel::NetworkItemType)
+    droppedNetworkId = sourceModel()->data(source_parent, NetworkModel::NetworkIdRole).value<NetworkId>();
 
   QList< QPair<NetworkId, BufferId> > bufferList = NetworkModel::mimeDataToBufferList(data);
   BufferId bufferId;
@@ -142,7 +203,8 @@ bool BufferViewFilter::dropMimeData(const QMimeData *data, Qt::DropAction action
        row = 0;
 
       if(row < rowCount(parent)) {
-       BufferId beforeBufferId = parent.child(row, 0).data(NetworkModel::BufferIdRole).value<BufferId>();
+       QModelIndex source_child = mapToSource(index(row, 0, parent));
+       BufferId beforeBufferId = sourceModel()->data(source_child, NetworkModel::BufferIdRole).value<BufferId>();
        pos = config()->bufferList().indexOf(beforeBufferId);
        if(_sortOrder == Qt::DescendingOrder)
          pos++;
@@ -201,11 +263,12 @@ bool BufferViewFilter::filterAcceptBuffer(const QModelIndex &source_bufferIndex)
   BufferId bufferId = sourceModel()->data(source_bufferIndex, NetworkModel::BufferIdRole).value<BufferId>();
   Q_ASSERT(bufferId.isValid());
 
-  int activityLevel = source_bufferIndex.data(NetworkModel::BufferActivityRole).toInt();
+  int activityLevel = sourceModel()->data(source_bufferIndex, NetworkModel::BufferActivityRole).toInt();
 
-  if(!config()->bufferList().contains(bufferId)) {
+  if(!config()->bufferList().contains(bufferId) && !_editMode) {
     // add the buffer if...
-    if(config()->isInitialized() && !config()->removedBuffers().contains(bufferId) // it hasn't been manually removed and either
+    if(config()->isInitialized()
+       && !config()->removedBuffers().contains(bufferId) // it hasn't been manually removed and either
        && ((config()->addNewBuffersAutomatically() && !config()->temporarilyRemovedBuffers().contains(bufferId)) // is totally unknown to us (a new buffer)...
           || (config()->temporarilyRemovedBuffers().contains(bufferId) && activityLevel > BufferInfo::OtherActivity))) { // or was just temporarily hidden and has a new message waiting for us.
       addBuffer(bufferId);
@@ -217,14 +280,18 @@ bool BufferViewFilter::filterAcceptBuffer(const QModelIndex &source_bufferIndex)
   if(config()->networkId().isValid() && config()->networkId() != sourceModel()->data(source_bufferIndex, NetworkModel::NetworkIdRole).value<NetworkId>())
     return false;
 
-  if(!(config()->allowedBufferTypes() & (BufferInfo::Type)source_bufferIndex.data(NetworkModel::BufferTypeRole).toInt()))
+  int allowedBufferTypes = config()->allowedBufferTypes();
+  if(!config()->networkId().isValid())
+    allowedBufferTypes &= ~BufferInfo::StatusBuffer;
+  if(!(allowedBufferTypes & sourceModel()->data(source_bufferIndex, NetworkModel::BufferTypeRole).toInt()))
     return false;
 
   // the following dynamic filters may not trigger if the buffer is currently selected.
-  if(bufferId == Client::bufferModel()->standardSelectionModel()->currentIndex().data(NetworkModel::BufferIdRole).value<BufferId>())
+  QModelIndex currentIndex = Client::bufferModel()->standardSelectionModel()->currentIndex();
+  if(bufferId == Client::bufferModel()->data(currentIndex, NetworkModel::BufferIdRole).value<BufferId>())
     return true;
 
-  if(config()->hideInactiveBuffers() && !source_bufferIndex.data(NetworkModel::ItemActiveRole).toBool() && activityLevel <= BufferInfo::OtherActivity)
+  if(config()->hideInactiveBuffers() && !sourceModel()->data(source_bufferIndex, NetworkModel::ItemActiveRole).toBool() && activityLevel <= BufferInfo::OtherActivity)
     return false;
 
   if(config()->minimumActivity() > activityLevel)
@@ -252,14 +319,21 @@ bool BufferViewFilter::filterAcceptsRow(int source_row, const QModelIndex &sourc
     return false;
   }
 
-  if(!source_parent.isValid())
+  NetworkModel::ItemType childType = (NetworkModel::ItemType)sourceModel()->data(child, NetworkModel::ItemTypeRole).toInt();
+  switch(childType) {
+  case NetworkModel::NetworkItemType:
     return filterAcceptNetwork(child);
-  else
+  case NetworkModel::BufferItemType:
     return filterAcceptBuffer(child);
+  default:
+    return false;
+  }
 }
 
 bool BufferViewFilter::lessThan(const QModelIndex &source_left, const QModelIndex &source_right) const {
-  int itemType = sourceModel()->data(source_left, NetworkModel::ItemTypeRole).toInt();
+  int leftItemType = sourceModel()->data(source_left, NetworkModel::ItemTypeRole).toInt();
+  int rightItemType = sourceModel()->data(source_right, NetworkModel::ItemTypeRole).toInt();
+  int itemType = leftItemType & rightItemType;
   switch(itemType) {
   case NetworkModel::NetworkItemType:
     return networkLessThan(source_left, source_right);
@@ -274,7 +348,13 @@ bool BufferViewFilter::bufferLessThan(const QModelIndex &source_left, const QMod
   BufferId leftBufferId = sourceModel()->data(source_left, NetworkModel::BufferIdRole).value<BufferId>();
   BufferId rightBufferId = sourceModel()->data(source_right, NetworkModel::BufferIdRole).value<BufferId>();
   if(config()) {
-    return config()->bufferList().indexOf(leftBufferId) < config()->bufferList().indexOf(rightBufferId);
+    int leftPos = config()->bufferList().indexOf(leftBufferId);
+    int rightPos = config()->bufferList().indexOf(rightBufferId);
+    if(leftPos == -1 && rightPos == -1)
+      return QSortFilterProxyModel::lessThan(source_left, source_right);
+    if(leftPos == -1 || rightPos == -1)
+      return !(leftPos < rightPos);
+    return leftPos < rightPos;
   } else
     return bufferIdLessThan(leftBufferId, rightBufferId);
 }
@@ -283,34 +363,38 @@ bool BufferViewFilter::networkLessThan(const QModelIndex &source_left, const QMo
   NetworkId leftNetworkId = sourceModel()->data(source_left, NetworkModel::NetworkIdRole).value<NetworkId>();
   NetworkId rightNetworkId = sourceModel()->data(source_right, NetworkModel::NetworkIdRole).value<NetworkId>();
 
-  if(config() && config()->sortAlphabetically())
-    return QSortFilterProxyModel::lessThan(source_left, source_right);
-  else
-    return leftNetworkId < rightNetworkId;
+  return QSortFilterProxyModel::lessThan(source_left, source_right);
 }
 
 QVariant BufferViewFilter::data(const QModelIndex &index, int role) const {
   switch(role) {
   case Qt::DecorationRole:
     return icon(index);
-  case Qt::ForegroundRole:
-    return foreground(index);
+  case Qt::CheckStateRole:
+    return checkedState(index);
   default:
     return QSortFilterProxyModel::data(index, role);
   }
 }
 
 QVariant BufferViewFilter::icon(const QModelIndex &index) const {
+  if(!_showUserStateIcons || (config() && config()->disableDecoration()))
+    return QVariant();
+
   if(index.column() != 0)
     return QVariant();
 
-  if(index.data(NetworkModel::BufferTypeRole).toInt() != BufferInfo::QueryBuffer)
+  QModelIndex source_index = mapToSource(index);
+  if(sourceModel()->data(source_index, NetworkModel::ItemTypeRole).toInt() != NetworkModel::BufferItemType)
     return QVariant();
 
-  if(!index.data(NetworkModel::ItemActiveRole).toBool())
+  if(sourceModel()->data(source_index, NetworkModel::BufferTypeRole).toInt() != BufferInfo::QueryBuffer)
+    return QVariant();
+
+  if(!sourceModel()->data(source_index, NetworkModel::ItemActiveRole).toBool())
     return _userOfflineIcon;
 
-  if(index.data(NetworkModel::UserAwayRole).toBool())
+  if(sourceModel()->data(source_index, NetworkModel::UserAwayRole).toBool())
     return _userAwayIcon;
   else
     return _userOnlineIcon;
@@ -318,20 +402,69 @@ QVariant BufferViewFilter::icon(const QModelIndex &index) const {
   return QVariant();
 }
 
-QVariant BufferViewFilter::foreground(const QModelIndex &index) const {
-  BufferInfo::ActivityLevel activity = (BufferInfo::ActivityLevel)index.data(NetworkModel::BufferActivityRole).toInt();
+QVariant BufferViewFilter::checkedState(const QModelIndex &index) const {
+  if(!_editMode || !config())
+    return QVariant();
+
+  QModelIndex source_index = mapToSource(index);
+  if(source_index == QModelIndex() || sourceModel()->data(source_index, NetworkModel::ItemTypeRole) == NetworkModel::NetworkItemType)
+    return QVariant();
+
+  BufferId bufferId = sourceModel()->data(source_index, NetworkModel::BufferIdRole).value<BufferId>();
+  if(_toAdd.contains(bufferId))
+    return Qt::Checked;
+
+  if(_toTempRemove.contains(bufferId))
+    return Qt::PartiallyChecked;
 
-  if(activity & BufferInfo::Highlight)
-    return _FgColorHighlightActivity;
-  if(activity & BufferInfo::NewMessage)
-    return _FgColorNewMessageActivity;
-  if(activity & BufferInfo::OtherActivity)
-    return _FgColorOtherActivity;
+  if(_toRemove.contains(bufferId))
+    return Qt::Unchecked;
 
-  if(!index.data(NetworkModel::ItemActiveRole).toBool() || index.data(NetworkModel::UserAwayRole).toBool())
-    return _FgColorInactiveActivity;
+  if(config()->bufferList().contains(bufferId))
+    return Qt::Checked;
 
-  return _FgColorNoActivity;
+  if(config()->temporarilyRemovedBuffers().contains(bufferId))
+    return Qt::PartiallyChecked;
+
+  return Qt::Unchecked;
+}
+
+bool BufferViewFilter::setData(const QModelIndex &index, const QVariant &value, int role) {
+  switch(role) {
+  case Qt::CheckStateRole:
+    return setCheckedState(index, Qt::CheckState(value.toInt()));
+  default:
+    return QSortFilterProxyModel::setData(index, value, role);
+  }
+}
+
+bool BufferViewFilter::setCheckedState(const QModelIndex &index, Qt::CheckState state) {
+  QModelIndex source_index = mapToSource(index);
+  BufferId bufferId = sourceModel()->data(source_index, NetworkModel::BufferIdRole).value<BufferId>();
+  if(!bufferId.isValid())
+    return false;
+
+  switch(state) {
+  case Qt::Unchecked:
+    _toAdd.remove(bufferId);
+    _toTempRemove.remove(bufferId);
+    _toRemove << bufferId;
+    break;
+  case Qt::PartiallyChecked:
+    _toAdd.remove(bufferId);
+    _toTempRemove << bufferId;
+    _toRemove.remove(bufferId);
+    break;
+  case Qt::Checked:
+    _toAdd << bufferId;
+    _toTempRemove.remove(bufferId);
+    _toRemove.remove(bufferId);
+    break;
+  default:
+    return false;
+  }
+  emit dataChanged(index, index);
+  return true;
 }
 
 void BufferViewFilter::checkPreviousCurrentForRemoval(const QModelIndex &current, const QModelIndex &previous) {
@@ -356,10 +489,7 @@ void BufferViewFilter::checkItemsForRemoval(const QModelIndex &topLeft, const QM
   emit _dataChanged(source_topLeft, source_bottomRight);
 }
 
-// ******************************
-//  Helper
-// ******************************
-bool bufferIdLessThan(const BufferId &left, const BufferId &right) {
+bool BufferViewFilter::bufferIdLessThan(const BufferId &left, const BufferId &right) {
   Q_CHECK_PTR(Client::networkModel());
   if(!Client::networkModel())
     return true;