path: root/src/dolphincolumnview.cpp

/***************************************************************************
 *   Copyright (C) 2007 by Peter Penz <[email protected]>                  *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
 ***************************************************************************/

#include "dolphincolumnview.h"

#include "dolphincontroller.h"
#include "dolphinsettings.h"

#include "dolphin_columnmodesettings.h"

#include <kcolorutils.h>
#include <kcolorscheme.h>
#include <kdirlister.h>
#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.
 */
class ColumnWidget : public QListView
{
public:
    ColumnWidget(QWidget* parent,
                 DolphinColumnView* columnView,
                 const KUrl& url);
    virtual ~ColumnWidget();

    /** Sets the size of the icons. */
    void setDecorationSize(const QSize& size);

    /**
     * An active column is defined as column, which shows the same URL
     * as indicated by the URL navigator. The active column is usually
     * drawn in a lighter color. All operations are applied to this column.
     */
    void setActive(bool active);
    inline bool isActive() const;

    inline const KUrl& url() const;

    /**
     * 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 releaseSelectionModel();

protected:
    virtual QStyleOptionViewItem viewOptions() const;
    virtual void dragEnterEvent(QDragEnterEvent* event);
    virtual void dragLeaveEvent(QDragLeaveEvent* event);
    virtual void dragMoveEvent(QDragMoveEvent* event);
    virtual void dropEvent(QDropEvent* event);
    virtual void mousePressEvent(QMouseEvent* event);
    virtual void mouseMoveEvent(QMouseEvent* event);
    virtual void mouseReleaseEvent(QMouseEvent* event);
    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();

    /** Used by ColumnWidget::setActive(). */
    void deactivate();

private:
    bool m_active;
    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
    QRect m_dropRect;  // TODO: remove this property when the issue #160611 is solved in Qt 4.4
};

ColumnWidget::ColumnWidget(QWidget* parent,
                           DolphinColumnView* columnView,
                           const KUrl& url) :
    QListView(parent),
    m_active(true),
    m_swallowMouseMoveEvents(false),
    m_view(columnView),
    m_url(url),
    m_childUrl(),
    m_dragging(false),
    m_dropRect()
{
    setMouseTracking(true);
    viewport()->setAttribute(Qt::WA_Hover);

    // apply the column mode settings to the widget
    const ColumnModeSettings* settings = DolphinSettings::instance().columnModeSettings();
    Q_ASSERT(settings != 0);

    m_viewOptions = QListView::viewOptions();

    QFont font(settings->fontFamily(), settings->fontSize());
    font.setItalic(settings->italicFont());
    font.setBold(settings->boldFont());
    m_viewOptions.font = font;

    const int iconSize = settings->iconSize();
    m_viewOptions.decorationSize = QSize(iconSize, iconSize);

    activate();
}

ColumnWidget::~ColumnWidget()
{
}

void ColumnWidget::setDecorationSize(const QSize& size)
{
    m_viewOptions.decorationSize = size;
    doItemsLayout();
}

void ColumnWidget::setActive(bool active)
{
    if (active) {
        obtainSelectionModel();
    } else {
        releaseSelectionModel();
    }

    if (m_active == active) {
        return;
    }

    m_active = active;

    if (active) {
        activate();
    } else {
        deactivate();
    }
}

inline bool ColumnWidget::isActive() const
{
    return m_active;
}

const KUrl& ColumnWidget::url() const
{
    return m_url;
}

void ColumnWidget::obtainSelectionModel()
{
    if (selectionModel() != m_view->selectionModel()) {
        selectionModel()->deleteLater();
        setSelectionModel(m_view->selectionModel());
        clearSelection();
    }
}

void ColumnWidget::releaseSelectionModel()
{
    if (selectionModel() == m_view->selectionModel()) {
        QItemSelectionModel* replacementModel = new QItemSelectionModel(model());
        setSelectionModel(replacementModel);
    }
}

QStyleOptionViewItem ColumnWidget::viewOptions() const
{
    return m_viewOptions;
}

void ColumnWidget::dragEnterEvent(QDragEnterEvent* event)
{
    if (event->mimeData()->hasUrls()) {
        event->acceptProposedAction();
    }

    m_dragging = true;
}

void ColumnWidget::dragLeaveEvent(QDragLeaveEvent* event)
{
    QListView::dragLeaveEvent(event);

    // TODO: remove this code when the issue #160611 is solved in Qt 4.4
    m_dragging = false;
    setDirtyRegion(m_dropRect);
}

void ColumnWidget::dragMoveEvent(QDragMoveEvent* event)
{
    QListView::dragMoveEvent(event);

    // 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);
    setDirtyRegion(m_dropRect);
}

void ColumnWidget::dropEvent(QDropEvent* event)
{
    const KUrl::List urls = KUrl::List::fromMimeData(event->mimeData());
    if (!urls.isEmpty()) {
        event->acceptProposedAction();
        m_view->m_controller->indicateDroppedUrls(urls,
                                                  indexAt(event->pos()),
                                                  event->source());
    }
    QListView::dropEvent(event);
    m_dragging = false;
}

void ColumnWidget::mousePressEvent(QMouseEvent* 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.

    m_view->requestSelectionModel(this);

    bool swallowMousePressEvent = false;
    const QModelIndex index = indexAt(event->pos());
    if (index.isValid()) {
        // 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);
        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
        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 (!swallowMousePressEvent) {
        QListView::mousePressEvent(event);
    }
}

void ColumnWidget::mouseMoveEvent(QMouseEvent* event)
{
    // see description in ColumnView::mousePressEvent()
    if (!m_swallowMouseMoveEvents) {
        QListView::mouseMoveEvent(event);
    }
}

void ColumnWidget::mouseReleaseEvent(QMouseEvent* event)
{
    QListView::mouseReleaseEvent(event);
    m_swallowMouseMoveEvents = false;
}


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
    if (m_dragging) {
        const QBrush& brush = m_viewOptions.palette.brush(QPalette::Normal, QPalette::Highlight);
        DolphinController::drawHoverIndication(viewport(), m_dropRect, brush);
    }
}

void ColumnWidget::contextMenuEvent(QContextMenuEvent* event)
{
    if (!m_active) {
        m_view->requestActivation(this);
    }

    QListView::contextMenuEvent(event);

    const QModelIndex index = indexAt(event->pos());
    if (index.isValid() || m_active) {
        // Only open a context menu above an item or if the mouse is above
        // the active column.
        const QPoint pos = m_view->viewport()->mapFromGlobal(event->globalPos());
        m_view->m_controller->triggerContextMenuRequest(pos);
    }
}

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();
    QPalette palette = viewport()->palette();
    palette.setColor(viewport()->backgroundRole(), bgColor);
    viewport()->setPalette(palette);

    update();
}

void ColumnWidget::deactivate()
{
    QColor bgColor = KColorScheme(KColorScheme::View).background();
    const QColor fgColor = KColorScheme(KColorScheme::View).foreground();
    bgColor = KColorUtils::mix(bgColor, fgColor, 0.04);

    QPalette palette = viewport()->palette();
    palette.setColor(viewport()->backgroundRole(), bgColor);
    viewport()->setPalette(palette);

    update();
}

// ---

DolphinColumnView::DolphinColumnView(QWidget* parent, DolphinController* controller) :
    QColumnView(parent),
    m_controller(controller)
{
    Q_ASSERT(controller != 0);

    setAcceptDrops(true);
    setDragDropMode(QAbstractItemView::DragDrop);
    setDropIndicatorShown(false);
    setSelectionMode(ExtendedSelection);

    if (KGlobalSettings::singleClick()) {
        connect(this, SIGNAL(clicked(const QModelIndex&)),
                this, SLOT(triggerItem(const QModelIndex&)));
    } else {
        connect(this, SIGNAL(doubleClicked(const QModelIndex&)),
                this, SLOT(triggerItem(const QModelIndex&)));
    }
    connect(this, SIGNAL(entered(const QModelIndex&)),
            controller, SLOT(emitItemEntered(const QModelIndex&)));
    connect(this, SIGNAL(viewportEntered()),
            controller, SLOT(emitViewportEntered()));
    connect(controller, SIGNAL(zoomIn()),
            this, SLOT(zoomIn()));
    connect(controller, SIGNAL(zoomOut()),
            this, SLOT(zoomOut()));
    connect(controller, SIGNAL(urlChanged(const KUrl&)),
            this, SLOT(updateColumnsState(const KUrl&)));

    updateDecorationSize();
}

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...
    KUrl columnUrl;
    if (viewport()->children().count() == 0) {
        // For the first column widget the directory lister has not been started
        // yet, hence use the URL from the controller instead.
        columnUrl = m_controller->url();
    } else {
        const QAbstractProxyModel* proxyModel = static_cast<const QAbstractProxyModel*>(model());
        const KDirModel* dirModel = static_cast<const KDirModel*>(proxyModel->sourceModel());

        const QModelIndex dirModelIndex = proxyModel->mapToSource(index);
        KFileItem fileItem = dirModel->itemForIndex(dirModelIndex);
        if (!fileItem.isNull()) {
            columnUrl = fileItem.url();
        }
    }

    ColumnWidget* view = new ColumnWidget(viewport(), this, columnUrl);

    // The following code has been copied 1:1 from QColumnView::createColumn().
    // Copyright (C) 1992-2007 Trolltech ASA. In Qt 4.4 the new method
    // QColumnView::initializeColumn() will be available for this.

    view->setFrameShape(QFrame::NoFrame);
    view->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
    view->setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
    view->setMinimumWidth(100);
    view->setAttribute(Qt::WA_MacShowFocusRect, false);

    // copy the 'view' behavior
    view->setDragDropMode(dragDropMode());
    view->setDragDropOverwriteMode(dragDropOverwriteMode());
    view->setDropIndicatorShown(showDropIndicator());
    view->setAlternatingRowColors(alternatingRowColors());
    view->setAutoScroll(hasAutoScroll());
    view->setEditTriggers(editTriggers());
    view->setHorizontalScrollMode(horizontalScrollMode());
    view->setIconSize(iconSize());
    view->setSelectionBehavior(selectionBehavior());
    view->setSelectionMode(selectionMode());
    view->setTabKeyNavigation(tabKeyNavigation());
    view->setTextElideMode(textElideMode());
    view->setVerticalScrollMode(verticalScrollMode());

    view->setModel(model());

    // set the delegate to be the columnview delegate
    QAbstractItemDelegate* delegate = view->itemDelegate();
    view->setItemDelegate(itemDelegate());
    delete delegate;

    view->setRootIndex(index);

    if (model()->canFetchMore(index)) {
        model()->fetchMore(index);
    }

    return view;
}

void DolphinColumnView::mousePressEvent(QMouseEvent* event)
{
    m_controller->triggerActivation();
    QColumnView::mousePressEvent(event);
}

void DolphinColumnView::dragEnterEvent(QDragEnterEvent* event)
{
    if (event->mimeData()->hasUrls()) {
        event->acceptProposedAction();
    }
}

void DolphinColumnView::dropEvent(QDropEvent* event)
{
    const KUrl::List urls = KUrl::List::fromMimeData(event->mimeData());
    if (!urls.isEmpty()) {
        m_controller->indicateDroppedUrls(urls,
                                          indexAt(event->pos()),
                                          event->source());
        event->acceptProposedAction();
    }
    QColumnView::dropEvent(event);
}

void DolphinColumnView::zoomIn()
{
    if (isZoomInPossible()) {
        ColumnModeSettings* settings = DolphinSettings::instance().columnModeSettings();
        // TODO: get rid of K3Icon sizes
        switch (settings->iconSize()) {
        case K3Icon::SizeSmall:  settings->setIconSize(K3Icon::SizeMedium); break;
        case K3Icon::SizeMedium: settings->setIconSize(K3Icon::SizeLarge); break;
        default: Q_ASSERT(false); break;
        }
        updateDecorationSize();
    }
}

void DolphinColumnView::zoomOut()
{
    if (isZoomOutPossible()) {
        ColumnModeSettings* settings = DolphinSettings::instance().columnModeSettings();
        // TODO: get rid of K3Icon sizes
        switch (settings->iconSize()) {
        case K3Icon::SizeLarge:  settings->setIconSize(K3Icon::SizeMedium); break;
        case K3Icon::SizeMedium: settings->setIconSize(K3Icon::SizeSmall); break;
        default: Q_ASSERT(false); break;
        }
        updateDecorationSize();
    }
}

void DolphinColumnView::triggerItem(const QModelIndex& index)
{
    m_controller->triggerItem(index);
    updateColumnsState(m_controller->url());
}

void DolphinColumnView::updateColumnsState(const KUrl& url)
{
    foreach (QObject* object, viewport()->children()) {
        if (object->inherits("QListView")) {
            ColumnWidget* widget = static_cast<ColumnWidget*>(object);
            widget->setActive(widget->url() == url);
        }
    }
}


void DolphinColumnView::updateDecorationSize()
{
    ColumnModeSettings* settings = DolphinSettings::instance().columnModeSettings();
    const int iconSize = settings->iconSize();

    foreach (QObject* object, viewport()->children()) {
        if (object->inherits("QListView")) {
            ColumnWidget* widget = static_cast<ColumnWidget*>(object);
            widget->setDecorationSize(QSize(iconSize, iconSize));
        }
    }

    m_controller->setZoomInPossible(isZoomInPossible());
    m_controller->setZoomOutPossible(isZoomOutPossible());

    doItemsLayout();
}

bool DolphinColumnView::isZoomInPossible() const
{
    ColumnModeSettings* settings = DolphinSettings::instance().columnModeSettings();
    return settings->iconSize() < K3Icon::SizeLarge;
}

bool DolphinColumnView::isZoomOutPossible() const
{
    ColumnModeSettings* settings = DolphinSettings::instance().columnModeSettings();
    return settings->iconSize() > K3Icon::SizeSmall;
}

void DolphinColumnView::requestActivation(QWidget* column)
{
    foreach (QObject* object, viewport()->children()) {
        if (object->inherits("QListView")) {
            ColumnWidget* widget = static_cast<ColumnWidget*>(object);
            const bool isActive = (widget == column);
            widget->setActive(isActive);
            if (isActive) {
               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);
    }
}

#include "dolphincolumnview.moc"