]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/dolphincolumnview.cpp
don't use the term "Bookmarks" anymore, use "Places" instead (includes devices etc.)
[dolphin.git] / src / dolphincolumnview.cpp
index f7f348cdffac5c0a3d18ab72c6d0d5826750fe86..e4669442ccc231519181581a4d8d0bba1c8a0f3a 100644 (file)
 #include <kdirmodel.h>
 
 #include <QAbstractProxyModel>
+#include <QApplication>
 #include <QPoint>
 
+/*
+ * General implementation notes
+ * ----------------------------
+ *
+ * In Qt4.3 the QColumnView widget has a default behavior regarding the
+ * active column and the selection handling, which leads to some usability
+ * problems within Dolphin:
+ *
+ * - No matter which mouse button has been clicked: If the mouse is above
+ *   a folder, the folder content will be loaded in the next column. The problem
+ *   is that this column also will marked as 'active column' within QColumnView,
+ *   hence it is not possible to select more than one folder within a column.
+ *
+ * - The currently opened folder is not always marked in the left column when
+ *   doing drag & drop and selections inside other columns.
+ *
+ * - The currently active column is visually not recognizable.
+ *
+ * - It is not possible for derived classes to remove inactive columns.
+ *
+ * DolphinView tries to bypass those points, but this required some workarounds:
+ *
+ * - QColumnView internally maps the selection model from the ColumnView to the
+ *   active column. As the active column from the Dolphin perspective is different
+ *   as the active column from QColumnView, the selection model is adjusted on
+ *   each interaction by the methods QColumnWidget::obtainSelectionModel(),
+ *   QColumnWidget::releaseSelectionModel() and QColumnView::requestSelectionModel().
+ *   QColumnView offers no hook to adjust this behavior, so those methods have to
+ *   be invoked throughout the code...
+ *
+ * - Some copy/paste code from QColumnView is part of DolphinColumnView::createColumn(), but Qt 4.4
+ *   will offer a solution for this.
+ *
+ * - The mousePressEvent() has been customized to prevent that folders are loaded on each
+ *   mouse click.
+ *
+ * We'll try to give some input for Trolltech if the Dolphin solution is stable enough, so hopefully
+ * some workarounds can be removed when switching to Qt 4.4 or later.
+ */
+
 /**
  * Represents one column inside the DolphinColumnView and has been
  * extended to respect view options and hovering information.
@@ -58,11 +99,16 @@ public:
     inline const KUrl& url() const;
 
     /**
-     * Updates the selection that the folder gets selected which represents
-     * the URL \a url. If \a url is empty, the selection of the column widget
-     * gets cleared.
+     * Obtains the selection model from the column view. This assures that
+     * selections of the column view will always applied to the active column.
+     */
+    void obtainSelectionModel();
+
+    /**
+     * Releases the selection model from the column view and replaces it by
+     * a custom selection model.
      */
-    void updateSelection(const KUrl& url);
+    void releaseSelectionModel();
 
 protected:
     virtual QStyleOptionViewItem viewOptions() const;
@@ -76,6 +122,9 @@ protected:
     virtual void paintEvent(QPaintEvent* event);
     virtual void contextMenuEvent(QContextMenuEvent* event);
 
+protected slots:
+    virtual void selectionChanged(const QItemSelection& selected, const QItemSelection& deselected);
+
 private:
     /** Used by ColumnWidget::setActive(). */
     void activate();
@@ -85,9 +134,10 @@ private:
 
 private:
     bool m_active;
-    bool m_swallowMouseMoveEvents;;
+    bool m_swallowMouseMoveEvents;
     DolphinColumnView* m_view;
     KUrl m_url;
+    KUrl m_childUrl; // URL of the next column that is shown
     QStyleOptionViewItem m_viewOptions;
 
     bool m_dragging;   // TODO: remove this property when the issue #160611 is solved in Qt 4.4
@@ -102,6 +152,7 @@ ColumnWidget::ColumnWidget(QWidget* parent,
     m_swallowMouseMoveEvents(false),
     m_view(columnView),
     m_url(url),
+    m_childUrl(),
     m_dragging(false),
     m_dropRect()
 {
@@ -137,6 +188,12 @@ void ColumnWidget::setDecorationSize(const QSize& size)
 
 void ColumnWidget::setActive(bool active)
 {
+    if (active) {
+        obtainSelectionModel();
+    } else {
+        releaseSelectionModel();
+    }
+
     if (m_active == active) {
         return;
     }
@@ -160,29 +217,20 @@ const KUrl& ColumnWidget::url() const
     return m_url;
 }
 
-void ColumnWidget::updateSelection(const KUrl& url)
+void ColumnWidget::obtainSelectionModel()
 {
-    setSelectionMode(SingleSelection);
-    QItemSelectionModel* selModel = selectionModel();
-    if (url.isEmpty()) {
-        if (!m_active) {
-            selModel->clear();
-        }
-    } else {
-        const QAbstractProxyModel* proxyModel = static_cast<const QAbstractProxyModel*>(m_view->model());
-        const KDirModel* dirModel = static_cast<const KDirModel*>(proxyModel->sourceModel());
-        const QModelIndex dirIndex = dirModel->indexForUrl(url);
-        const QModelIndex proxyIndex = proxyModel->mapFromSource(dirIndex);
-
-        const QItemSelection selection = selModel->selection();
-        const bool isIndexSelected = selModel->isSelected(proxyIndex);
+    if (selectionModel() != m_view->selectionModel()) {
+        selectionModel()->deleteLater();
+        setSelectionModel(m_view->selectionModel());
+        clearSelection();
+    }
+}
 
-        if (!m_active && ((selection.count() > 1) || !isIndexSelected)) {
-            selModel->clear();
-        }
-        if (!isIndexSelected) {
-            selModel->select(proxyIndex, QItemSelectionModel::Select);
-        }
+void ColumnWidget::releaseSelectionModel()
+{
+    if (selectionModel() == m_view->selectionModel()) {
+        QItemSelectionModel* replacementModel = new QItemSelectionModel(model());
+        setSelectionModel(replacementModel);
     }
 }
 
@@ -213,7 +261,7 @@ void ColumnWidget::dragMoveEvent(QDragMoveEvent* event)
 {
     QListView::dragMoveEvent(event);
 
-   // TODO: remove this code when the issue #160611 is solved in Qt 4.4
+    // TODO: remove this code when the issue #160611 is solved in Qt 4.4
     const QModelIndex index = indexAt(event->pos());
     setDirtyRegion(m_dropRect);
     m_dropRect = visualRect(index);
@@ -235,32 +283,78 @@ void ColumnWidget::dropEvent(QDropEvent* event)
 
 void ColumnWidget::mousePressEvent(QMouseEvent* event)
 {
-    QListView::mousePressEvent(event);
+    // On each mouse press event QColumnView triggers the loading of the
+    // current folder in the next column. This is not wanted for Dolphin when
+    // opening a context menu or when the CTRL modifier is pressed. Beside usability
+    // aspects the loading of the folder also implies losing the current selection,
+    // which makes it impossible to select folders from the current column. To bypass
+    // this behavior QListView::mousePressEvent() is not invoked in those cases, which
+    // is not a nice solution. Maybe another solution can be found in future versions
+    // of QColumnView.
 
-    const QModelIndex index = indexAt(event->pos());
+    m_view->requestSelectionModel(this);
 
-    bool requestActivation = false;
+    bool swallowMousePressEvent = false;
+    const QModelIndex index = indexAt(event->pos());
     if (index.isValid()) {
-        // A click on an item has been done. Only request an activation
-        // if the item is not a directory.
+        // a click on an item has been done
         const QAbstractProxyModel* proxyModel = static_cast<const QAbstractProxyModel*>(m_view->model());
         const KDirModel* dirModel = static_cast<const KDirModel*>(proxyModel->sourceModel());
         const QModelIndex dirIndex = proxyModel->mapToSource(index);
-        KFileItem* item = dirModel->itemForIndex(dirIndex);
-        requestActivation = (item != 0) && !item->isDir();
+        KFileItem item = dirModel->itemForIndex(dirIndex);
+        if (!item.isNull()) {
+            QItemSelectionModel* selModel = selectionModel();
+
+            bool activate = true;
+            const Qt::KeyboardModifiers modifier = QApplication::keyboardModifiers();
+            if (modifier & Qt::ControlModifier) {
+                m_view->requestActivation(this);
+                if (!selModel->hasSelection()) {
+                    // Assure to set the current index, so that a selection by the SHIFT key
+                    // will work. TODO: If the index specifies a folder, the loading of the folder will
+                    // be triggered by QColumnView although this is not wanted by Dolphin.
+                    selModel->setCurrentIndex(index, QItemSelectionModel::Select);
+                }
+                selModel->select(index, QItemSelectionModel::Toggle);
+                swallowMousePressEvent = true;
+            } else if (item.isDir()) {
+                m_childUrl = item.url();
+                viewport()->update();
+
+                // Only request the activation if not the left button is pressed.
+                // The left button on a directory opens a new column, hence requesting
+                // an activation is useless as the new column will request the activation
+                // afterwards.
+                if (event->button() == Qt::LeftButton) {
+                    activate = false;
+                }
+            }
+
+            if (activate) {
+                m_view->requestActivation(this);
+            }
+
+            // TODO: is the assumption OK that Qt::RightButton always represents the context menu button?
+            if (event->button() == Qt::RightButton) {
+                swallowMousePressEvent = true;
+                if (!selModel->isSelected(index)) {
+                    clearSelection();
+                }
+                selModel->select(index, QItemSelectionModel::Select);
+            }
+        }
     } else {
         // a click on the viewport has been done
-        requestActivation = true;
+        m_view->requestActivation(this);
 
         // Swallow mouse move events if a click is done on the viewport. Otherwise the QColumnView
         // triggers an unwanted loading of directories on hovering folder items.
         m_swallowMouseMoveEvents = true;
+        clearSelection();
     }
 
-    if (requestActivation) {
-        m_view->requestActivation(this);
-    } else {
-        m_view->updateSelections();
+    if (!swallowMousePressEvent) {
+        QListView::mousePressEvent(event);
     }
 }
 
@@ -281,6 +375,27 @@ void ColumnWidget::mouseReleaseEvent(QMouseEvent* event)
 
 void ColumnWidget::paintEvent(QPaintEvent* event)
 {
+    if (!m_childUrl.isEmpty()) {
+        // indicate the shown URL of the next column by highlighting the shown folder item
+        const QAbstractProxyModel* proxyModel = static_cast<const QAbstractProxyModel*>(m_view->model());
+        const KDirModel* dirModel = static_cast<const KDirModel*>(proxyModel->sourceModel());
+        const QModelIndex dirIndex = dirModel->indexForUrl(m_childUrl);
+        const QModelIndex proxyIndex = proxyModel->mapFromSource(dirIndex);
+        if (proxyIndex.isValid() && !selectionModel()->isSelected(proxyIndex)) {
+            const QRect itemRect = visualRect(proxyIndex);
+            QPainter painter(viewport());
+            painter.save();
+
+            QColor color = KColorScheme(KColorScheme::View).foreground();
+            color.setAlpha(32);
+            painter.setPen(Qt::NoPen);
+            painter.setBrush(color);
+            painter.drawRect(itemRect);
+
+            painter.restore();
+        }
+    }
+
     QListView::paintEvent(event);
 
     // TODO: remove this code when the issue #160611 is solved in Qt 4.4
@@ -307,6 +422,15 @@ void ColumnWidget::contextMenuEvent(QContextMenuEvent* event)
     }
 }
 
+void ColumnWidget::selectionChanged(const QItemSelection& selected, const QItemSelection& deselected)
+{
+    // inactive views should not have any selection
+    if (!m_active) {
+        clearSelection();
+    }
+    QListView::selectionChanged(selected, deselected);
+}
+
 void ColumnWidget::activate()
 {
     const QColor bgColor = KColorScheme(KColorScheme::View).background();
@@ -341,7 +465,7 @@ DolphinColumnView::DolphinColumnView(QWidget* parent, DolphinController* control
     setAcceptDrops(true);
     setDragDropMode(QAbstractItemView::DragDrop);
     setDropIndicatorShown(false);
-    setSelectionMode(SingleSelection);
+    setSelectionMode(ExtendedSelection);
 
     if (KGlobalSettings::singleClick()) {
         connect(this, SIGNAL(clicked(const QModelIndex&)),
@@ -368,6 +492,16 @@ DolphinColumnView::~DolphinColumnView()
 {
 }
 
+void DolphinColumnView::invertSelection()
+{
+    selectActiveColumn(QItemSelectionModel::Toggle);
+}
+
+void DolphinColumnView::selectAll()
+{
+    selectActiveColumn(QItemSelectionModel::Select);
+}
+
 QAbstractItemView* DolphinColumnView::createColumn(const QModelIndex& index)
 {
     // let the column widget be aware about its URL...
@@ -381,9 +515,9 @@ QAbstractItemView* DolphinColumnView::createColumn(const QModelIndex& index)
         const KDirModel* dirModel = static_cast<const KDirModel*>(proxyModel->sourceModel());
 
         const QModelIndex dirModelIndex = proxyModel->mapToSource(index);
-        KFileItem* fileItem = dirModel->itemForIndex(dirModelIndex);
-        if (fileItem != 0) {
-            columnUrl = fileItem->url();
+        KFileItem fileItem = dirModel->itemForIndex(dirModelIndex);
+        if (!fileItem.isNull()) {
+            columnUrl = fileItem.url();
         }
     }
 
@@ -455,20 +589,6 @@ void DolphinColumnView::dropEvent(QDropEvent* event)
     QColumnView::dropEvent(event);
 }
 
-void DolphinColumnView::showEvent(QShowEvent* event)
-{
-    QColumnView::showEvent(event);
-    if (!event->spontaneous()) {
-        // QColumnView might clear the selection for folders that are shown in the next column.
-        // As this is not wanted the selection is updated if the directory lister has been completed.
-        const QAbstractProxyModel* proxyModel = static_cast<const QAbstractProxyModel*>(model());
-        const KDirModel* dirModel = static_cast<const KDirModel*>(proxyModel->sourceModel());
-        KDirLister* dirLister = dirModel->dirLister();
-        connect(dirLister, SIGNAL(completed()),
-                this, SLOT(updateSelections()));
-    }
-}
-
 void DolphinColumnView::zoomIn()
 {
     if (isZoomInPossible()) {
@@ -532,23 +652,6 @@ void DolphinColumnView::updateDecorationSize()
     doItemsLayout();
 }
 
-void DolphinColumnView::updateSelections()
-{
-    ColumnWidget* previousWidget = 0;
-    foreach (QObject* object, viewport()->children()) {
-        if (object->inherits("QListView")) {
-            ColumnWidget* widget = static_cast<ColumnWidget*>(object);
-            if (previousWidget != 0) {
-                previousWidget->updateSelection(widget->url());
-            }
-            previousWidget = widget;
-       }
-    }
-    if (previousWidget != 0) {
-        previousWidget->updateSelection(KUrl());
-    }
-}
-
 bool DolphinColumnView::isZoomInPossible() const
 {
     ColumnModeSettings* settings = DolphinSettings::instance().columnModeSettings();
@@ -569,11 +672,57 @@ void DolphinColumnView::requestActivation(QWidget* column)
             const bool isActive = (widget == column);
             widget->setActive(isActive);
             if (isActive) {
-                m_controller->setUrl(widget->url());
+               m_controller->setUrl(widget->url());
             }
-       }
+        }
+    }
+}
+
+void DolphinColumnView::requestSelectionModel(QAbstractItemView* view)
+{
+    foreach (QObject* object, viewport()->children()) {
+        if (object->inherits("QListView")) {
+            ColumnWidget* widget = static_cast<ColumnWidget*>(object);
+            if (widget == view) {
+                widget->obtainSelectionModel();
+            } else {
+                widget->releaseSelectionModel();
+            }
+        }
+    }
+}
+
+void DolphinColumnView::selectActiveColumn(QItemSelectionModel::SelectionFlags flags)
+{
+    // TODO: this approach of selecting the active column is very slow. It should be
+    // possible to speedup the implementation by using QItemSelection, but all adempts
+    // have failed yet...
+
+    // assure that the selection model of the active column is set properly, otherwise
+    // no visual update of the selections is done
+    const KUrl& activeUrl = m_controller->url();
+    foreach (QObject* object, viewport()->children()) {
+        if (object->inherits("QListView")) {
+            ColumnWidget* widget = static_cast<ColumnWidget*>(object);
+            if (widget->url() == activeUrl) {
+                widget->obtainSelectionModel();
+            } else {
+                widget->releaseSelectionModel();
+            }
+        }
+    }
+
+    QItemSelectionModel* selModel = selectionModel();
+
+    const QAbstractProxyModel* proxyModel = static_cast<const QAbstractProxyModel*>(model());
+    const KDirModel* dirModel = static_cast<const KDirModel*>(proxyModel->sourceModel());
+    KDirLister* dirLister = dirModel->dirLister();
+
+    const KFileItemList list = dirLister->itemsForDir(activeUrl);
+    foreach (KFileItem* item, list) {
+        const QModelIndex index = dirModel->indexForUrl(item->url());
+        selModel->select(proxyModel->mapFromSource(index), flags);
     }
-    updateSelections();
 }
 
 #include "dolphincolumnview.moc"