X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/fabf5681f5ae71e7ad7cc1c4876917a31b9b40a6..16e3d669de256aab86f957cd5b3bee91bd2fbbff:/src/kitemviews/kitemlistcontainer.cpp

diff --git a/src/kitemviews/kitemlistcontainer.cpp b/src/kitemviews/kitemlistcontainer.cpp
index 28e526a6f..69a0a5f27 100644
--- a/src/kitemviews/kitemlistcontainer.cpp
+++ b/src/kitemviews/kitemlistcontainer.cpp
@@ -26,56 +26,81 @@
 #include "kitemlistview.h"
 #include "kitemmodelbase.h"
 
+#include "private/kitemlistsmoothscroller.h"
+
 #include <QApplication>
 #include <QGraphicsScene>
 #include <QGraphicsView>
-#include <QPropertyAnimation>
 #include <QScrollBar>
 #include <QStyle>
+#include <QStyleOption>
 
-#include <KDebug>
 
+/**
+ * Replaces the default viewport of KItemListContainer by a
+ * non-scrollable viewport. The scrolling is done in an optimized
+ * way by KItemListView internally.
+ */
 class KItemListContainerViewport : public QGraphicsView
 {
-public:
-    KItemListContainerViewport(QGraphicsScene* scene, QWidget* parent)
-        : QGraphicsView(scene, parent)
-    {
-        setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
-        setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
-        setViewportMargins(0, 0, 0, 0);
-        setFrameShape(QFrame::NoFrame);
-    }
+    Q_OBJECT
 
-    void scrollContentsBy(int dx, int dy)
-    {
-        Q_UNUSED(dx);
-        Q_UNUSED(dy);
-        // Do nothing. This prevents that e.g. the wheel-event
-        // results in a moving of the scene items.
-    }
+public:
+    KItemListContainerViewport(QGraphicsScene* scene, QWidget* parent);
+protected:
+    virtual void wheelEvent(QWheelEvent* event);
 };
 
+KItemListContainerViewport::KItemListContainerViewport(QGraphicsScene* scene, QWidget* parent) :
+    QGraphicsView(scene, parent)
+{
+    setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
+    setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
+    setViewportMargins(0, 0, 0, 0);
+    setFrameShape(QFrame::NoFrame);
+}
+
+void KItemListContainerViewport::wheelEvent(QWheelEvent* event)
+{
+    // Assure that the wheel-event gets forwarded to the parent
+    // and not handled at all by QGraphicsView.
+    event->ignore();
+}
+
 KItemListContainer::KItemListContainer(KItemListController* controller, QWidget* parent) :
     QAbstractScrollArea(parent),
     m_controller(controller),
-    m_sliderMovedByUser(false),
-    m_viewOffsetAnimation(0)
+    m_horizontalSmoothScroller(0),
+    m_verticalSmoothScroller(0)
 {
     Q_ASSERT(controller);
     controller->setParent(this);
-    initialize();
-}
 
-KItemListContainer::KItemListContainer(QWidget* parent) :
-    QAbstractScrollArea(parent),
-    m_controller(0)
-{
-    initialize();
+    QGraphicsView* graphicsView = new KItemListContainerViewport(new QGraphicsScene(this), this);
+    setViewport(graphicsView);
+
+    m_horizontalSmoothScroller = new KItemListSmoothScroller(horizontalScrollBar(), this);
+    m_verticalSmoothScroller = new KItemListSmoothScroller(verticalScrollBar(), this);
+
+    if (controller->model()) {
+        slotModelChanged(controller->model(), 0);
+    }
+    if (controller->view()) {
+        slotViewChanged(controller->view(), 0);
+    }
+
+    connect(controller, &KItemListController::modelChanged,
+            this, &KItemListContainer::slotModelChanged);
+    connect(controller, &KItemListController::viewChanged,
+            this, &KItemListContainer::slotViewChanged);
 }
 
 KItemListContainer::~KItemListContainer()
 {
+    // Don't rely on the QObject-order to delete the controller, otherwise
+    // the QGraphicsScene might get deleted before the view.
+    delete m_controller;
+    m_controller = 0;
 }
 
 KItemListController* KItemListContainer::controller() const
@@ -83,6 +108,33 @@ KItemListController* KItemListContainer::controller() const
     return m_controller;
 }
 
+void KItemListContainer::setEnabledFrame(bool enable)
+{
+    QGraphicsView* graphicsView = qobject_cast<QGraphicsView*>(viewport());
+    if (enable) {
+        setFrameShape(QFrame::StyledPanel);
+        graphicsView->setPalette(palette());
+        graphicsView->viewport()->setAutoFillBackground(true);
+    } else {
+        setFrameShape(QFrame::NoFrame);
+        // Make the background of the container transparent and apply the window-text color
+        // to the text color, so that enough contrast is given for all color
+        // schemes
+        QPalette p = graphicsView->palette();
+        p.setColor(QPalette::Active,   QPalette::Text, p.color(QPalette::Active,   QPalette::WindowText));
+        p.setColor(QPalette::Inactive, QPalette::Text, p.color(QPalette::Inactive, QPalette::WindowText));
+        p.setColor(QPalette::Disabled, QPalette::Text, p.color(QPalette::Disabled, QPalette::WindowText));
+        graphicsView->setPalette(p);
+        graphicsView->viewport()->setAutoFillBackground(false);
+    }
+}
+
+bool KItemListContainer::enabledFrame() const
+{
+    const QGraphicsView* graphicsView = qobject_cast<QGraphicsView*>(viewport());
+    return graphicsView->autoFillBackground();
+}
+
 void KItemListContainer::keyPressEvent(QKeyEvent* event)
 {
     // TODO: We should find a better way to handle the key press events in the view.
@@ -111,94 +163,57 @@ void KItemListContainer::resizeEvent(QResizeEvent* event)
 
 void KItemListContainer::scrollContentsBy(int dx, int dy)
 {
-    KItemListView* view = m_controller->view();
-    if (!view) {
-        return;
-    }
-
-    const qreal currentOffset = view->offset();
-    qreal offsetDiff = (view->scrollOrientation() == Qt::Vertical) ? dy : dx;
-
-    const bool animRunning = (m_viewOffsetAnimation->state() == QAbstractAnimation::Running);
-    if (animRunning) {
-        // Stopping a running animation means skipping the range from the current offset
-        // until the target offset. To prevent skipping of the range the difference
-        // is added to the new target offset.
-        m_viewOffsetAnimation->stop();
-        const qreal targetOffset = m_viewOffsetAnimation->endValue().toReal();
-        offsetDiff += (currentOffset - targetOffset);
-    }
-
-    const qreal newOffset = currentOffset - offsetDiff;
-
-    if (m_sliderMovedByUser || animRunning) {
-        m_viewOffsetAnimation->stop();
-        m_viewOffsetAnimation->setStartValue(currentOffset);
-        m_viewOffsetAnimation->setEndValue(newOffset);
-        m_viewOffsetAnimation->setEasingCurve(animRunning ? QEasingCurve::OutQuad : QEasingCurve::InOutQuad);
-        m_viewOffsetAnimation->start();
-    } else {
-        view->setOffset(newOffset);
-    }
+    m_horizontalSmoothScroller->scrollContentsBy(dx);
+    m_verticalSmoothScroller->scrollContentsBy(dy);
 }
 
-bool KItemListContainer::eventFilter(QObject* obj, QEvent* event)
+void KItemListContainer::wheelEvent(QWheelEvent* event)
 {
-    Q_ASSERT(obj == horizontalScrollBar() || obj == verticalScrollBar());
-
-    // Check whether the scrollbar has been adjusted by a mouse-event
-    // triggered by the user and remember this in m_sliderMovedByUser.
-    // The smooth scrolling will only get active if m_sliderMovedByUser
-    // is true (see scrollContentsBy()).
-    const bool scrollVertical = (m_controller->view()->scrollOrientation() == Qt::Vertical);
-    const bool checkEvent = ( scrollVertical && obj == verticalScrollBar()) ||
-                            (!scrollVertical && obj == horizontalScrollBar());
-    if (checkEvent) {
-        switch (event->type()) {
-        case QEvent::MouseButtonPress:
-            m_sliderMovedByUser = true;
-           break;
-
-        case QEvent::MouseButtonRelease:
-            m_sliderMovedByUser = false;
-            break;
-
-        case QEvent::Wheel:
-            wheelEvent(static_cast<QWheelEvent*>(event));
-            break;
-
-        default:
-            break;
-         }
+    if (event->modifiers().testFlag(Qt::ControlModifier)) {
+        event->ignore();
+        return;
     }
 
-    return QAbstractScrollArea::eventFilter(obj, event);
-}
-
-void KItemListContainer::wheelEvent(QWheelEvent* event)
-{
     KItemListView* view = m_controller->view();
-    if (!view || event->orientation() != view->scrollOrientation()) {
+    if (!view) {
+        event->ignore();
         return;
     }
 
-    const int numDegrees = event->delta() / 8;
-    const int numSteps = numDegrees / 15;
-
-    const bool previous = m_sliderMovedByUser;
-    m_sliderMovedByUser = true;
-    if (view->scrollOrientation() == Qt::Vertical) {
-        const int value = verticalScrollBar()->value();
-        verticalScrollBar()->setValue(value - numSteps * view->size().height());
+    const bool scrollHorizontally = (event->orientation() == Qt::Horizontal) ||
+                                    (event->orientation() == Qt::Vertical && !verticalScrollBar()->isVisible());
+    KItemListSmoothScroller* smoothScroller = scrollHorizontally ?
+                                              m_horizontalSmoothScroller : m_verticalSmoothScroller;
+
+    const QScrollBar* scrollBar = smoothScroller->scrollBar();
+    if (!event->pixelDelta().isNull()) {
+        const int numPixels =  event->pixelDelta().y();
+        if (event->modifiers().testFlag(Qt::ShiftModifier)) {
+            const int scrollingDirection = numPixels > 0 ? 1 : -1;
+            smoothScroller->scrollTo(scrollBar->value() - scrollBar->pageStep() * scrollingDirection);
+        } else {
+            smoothScroller->scrollTo(scrollBar->value() - numPixels);
+        }
     } else {
-        const int value = horizontalScrollBar()->value();
-        horizontalScrollBar()->setValue(value - numSteps * view->size().width());
+        const int numDegrees = event->angleDelta().y() / 8;
+        const int numSteps = qApp->wheelScrollLines() * numDegrees / 15;
+        if (event->modifiers().testFlag(Qt::ShiftModifier)) {
+            const int scrollingDirection = numSteps > 0 ? 1 : -1;
+            smoothScroller->scrollTo(scrollBar->value() - scrollBar->pageStep() * scrollingDirection);
+        } else {
+            smoothScroller->scrollTo(scrollBar->value() - numSteps * scrollBar->pageStep() / 12);
+        }
     }
-    m_sliderMovedByUser = previous;
 
     event->accept();
 }
 
+void KItemListContainer::slotScrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous)
+{
+    Q_UNUSED(previous);
+    updateSmoothScrollers(current);
+}
+
 void KItemListContainer::slotModelChanged(KItemModelBase* current, KItemModelBase* previous)
 {
     Q_UNUSED(current);
@@ -210,111 +225,206 @@ void KItemListContainer::slotViewChanged(KItemListView* current, KItemListView*
     QGraphicsScene* scene = static_cast<QGraphicsView*>(viewport())->scene();
     if (previous) {
         scene->removeItem(previous);
-        disconnect(previous, SIGNAL(offsetChanged(int,int)), this, SLOT(updateScrollBars()));
-        disconnect(previous, SIGNAL(maximumOffsetChanged(int,int)), this, SLOT(updateScrollBars()));
-        m_viewOffsetAnimation->setTargetObject(0);
+        disconnect(previous, &KItemListView::scrollOrientationChanged,
+                   this, &KItemListContainer::slotScrollOrientationChanged);
+        disconnect(previous, &KItemListView::scrollOffsetChanged,
+                   this, &KItemListContainer::updateScrollOffsetScrollBar);
+        disconnect(previous, &KItemListView::maximumScrollOffsetChanged,
+                   this, &KItemListContainer::updateScrollOffsetScrollBar);
+        disconnect(previous, &KItemListView::itemOffsetChanged,
+                   this, &KItemListContainer::updateItemOffsetScrollBar);
+        disconnect(previous, &KItemListView::maximumItemOffsetChanged,
+                   this, &KItemListContainer::updateItemOffsetScrollBar);
+        disconnect(previous, &KItemListView::scrollTo, this, &KItemListContainer::scrollTo);
+        m_horizontalSmoothScroller->setTargetObject(0);
+        m_verticalSmoothScroller->setTargetObject(0);
     }
     if (current) {
         scene->addItem(current);
-        connect(current, SIGNAL(offsetChanged(int,int)), this, SLOT(updateScrollBars()));
-        connect(current, SIGNAL(maximumOffsetChanged(int,int)), this, SLOT(updateScrollBars()));
-        m_viewOffsetAnimation->setTargetObject(current);
+        connect(current, &KItemListView::scrollOrientationChanged,
+                this, &KItemListContainer::slotScrollOrientationChanged);
+        connect(current, &KItemListView::scrollOffsetChanged,
+                this, &KItemListContainer::updateScrollOffsetScrollBar);
+        connect(current, &KItemListView::maximumScrollOffsetChanged,
+                this, &KItemListContainer::updateScrollOffsetScrollBar);
+        connect(current, &KItemListView::itemOffsetChanged,
+                this, &KItemListContainer::updateItemOffsetScrollBar);
+        connect(current, &KItemListView::maximumItemOffsetChanged,
+                this, &KItemListContainer::updateItemOffsetScrollBar);
+        connect(current, &KItemListView::scrollTo, this, &KItemListContainer::scrollTo);
+        m_horizontalSmoothScroller->setTargetObject(current);
+        m_verticalSmoothScroller->setTargetObject(current);
+        updateSmoothScrollers(current->scrollOrientation());
     }
 }
 
-void KItemListContainer::updateScrollBars()
+void KItemListContainer::scrollTo(qreal offset)
+{
+    const KItemListView* view = m_controller->view();
+    if (view) {
+        if (view->scrollOrientation() == Qt::Vertical) {
+            m_verticalSmoothScroller->scrollTo(offset);
+        } else {
+            m_horizontalSmoothScroller->scrollTo(offset);
+        }
+    }
+}
+
+void KItemListContainer::updateScrollOffsetScrollBar()
 {
     const KItemListView* view = m_controller->view();
     if (!view) {
         return;
     }
 
-    QScrollBar* scrollBar = 0;
+    KItemListSmoothScroller* smoothScroller = 0;
+    QScrollBar* scrollOffsetScrollBar = 0;
     int singleStep = 0;
     int pageStep = 0;
-    QScrollBar* otherScrollBar = 0;
+    int maximum = 0;
     if (view->scrollOrientation() == Qt::Vertical) {
-        scrollBar = verticalScrollBar();
+        smoothScroller = m_verticalSmoothScroller;
+        scrollOffsetScrollBar = verticalScrollBar();
         singleStep = view->itemSize().height();
-        pageStep = view->size().height();
-        otherScrollBar = horizontalScrollBar();
+        // We cannot use view->size().height() because this height might
+        // include the header widget, which is not part of the scrolled area.
+        pageStep = view->verticalPageStep();
+
+        // However, the total height of the view must be considered for the
+        // maximum value of the scroll bar. Note that the view's scrollOffset()
+        // refers to the offset of the top part of the view, which might be
+        // hidden behind the header.
+        maximum = qMax(0, int(view->maximumScrollOffset() - view->size().height()));
     } else {
-        scrollBar = horizontalScrollBar();
+        smoothScroller = m_horizontalSmoothScroller;
+        scrollOffsetScrollBar = horizontalScrollBar();
         singleStep = view->itemSize().width();
         pageStep = view->size().width();
-        otherScrollBar = verticalScrollBar();
+        maximum = qMax(0, int(view->maximumScrollOffset() - view->size().width()));
     }
 
-    const int value = view->offset();
-    const int maximum = qMax(0, int(view->maximumOffset() - pageStep));
-    if (m_viewOffsetAnimation->state() == QAbstractAnimation::Running) {
-        if (maximum == scrollBar->maximum()) {
-            // The value has been changed by the animation, no update
-            // of the scrollbars is required as their target state will be
-            // reached with the end of the animation.
-            return;
+    const int value = view->scrollOffset();
+    if (smoothScroller->requestScrollBarUpdate(maximum)) {
+        const bool updatePolicy = (scrollOffsetScrollBar->maximum() > 0 && maximum == 0)
+                                  || horizontalScrollBarPolicy() == Qt::ScrollBarAlwaysOn;
+
+        scrollOffsetScrollBar->setSingleStep(singleStep);
+        scrollOffsetScrollBar->setPageStep(pageStep);
+        scrollOffsetScrollBar->setMinimum(0);
+        scrollOffsetScrollBar->setMaximum(maximum);
+        scrollOffsetScrollBar->setValue(value);
+
+        if (updatePolicy) {
+            // Prevent a potential endless layout loop (see bug #293318).
+            updateScrollOffsetScrollBarPolicy();
         }
+    }
+}
 
-        // The maximum has been changed which indicates that the content
-        // of the view has been changed. Stop the animation in any case and
-        // update the scrollbars immediately.
-        m_viewOffsetAnimation->stop();
+void KItemListContainer::updateItemOffsetScrollBar()
+{
+    const KItemListView* view = m_controller->view();
+    if (!view) {
+        return;
     }
 
-    scrollBar->setSingleStep(singleStep);
-    scrollBar->setPageStep(pageStep);
-    scrollBar->setMinimum(0);
-    scrollBar->setMaximum(maximum);
-    scrollBar->setValue(value);
+    KItemListSmoothScroller* smoothScroller = 0;
+    QScrollBar* itemOffsetScrollBar = 0;
+    int singleStep = 0;
+    int pageStep = 0;
+    if (view->scrollOrientation() == Qt::Vertical) {
+        smoothScroller = m_horizontalSmoothScroller;
+        itemOffsetScrollBar = horizontalScrollBar();
+        singleStep = view->size().width() / 10;
+        pageStep = view->size().width();
+    } else {
+        smoothScroller = m_verticalSmoothScroller;
+        itemOffsetScrollBar = verticalScrollBar();
+        singleStep = view->size().height() / 10;
+        pageStep = view->size().height();
+    }
 
-    // Make sure that the other scroll bar is hidden
-    otherScrollBar->setMaximum(0);
-    otherScrollBar->setValue(0);
+    const int value = view->itemOffset();
+    const int maximum = qMax(0, int(view->maximumItemOffset()) - pageStep);
+    if (smoothScroller->requestScrollBarUpdate(maximum)) {
+        itemOffsetScrollBar->setSingleStep(singleStep);
+        itemOffsetScrollBar->setPageStep(pageStep);
+        itemOffsetScrollBar->setMinimum(0);
+        itemOffsetScrollBar->setMaximum(maximum);
+        itemOffsetScrollBar->setValue(value);
+    }
 }
 
 void KItemListContainer::updateGeometries()
 {
     QRect rect = geometry();
 
-    int widthDec = frameWidth() * 2;
-    if (verticalScrollBar()->isVisible()) {
-        widthDec += style()->pixelMetric(QStyle::PM_ScrollBarExtent);
+    int extra = frameWidth() * 2;
+    QStyleOption option;
+    option.initFrom(this);
+    int scrollbarSpacing = 0;
+    if (style()->styleHint(QStyle::SH_ScrollView_FrameOnlyAroundContents, &option, this)) {
+        scrollbarSpacing = style()->pixelMetric(QStyle::PM_ScrollView_ScrollBarSpacing, &option, this);
     }
 
-    int heightDec = frameWidth() * 2;
-    if (horizontalScrollBar()->isVisible()) {
-        heightDec += style()->pixelMetric(QStyle::PM_ScrollBarExtent);
-    }
+    const int widthDec = verticalScrollBar()->isVisible()
+                         ? extra + scrollbarSpacing + style()->pixelMetric(QStyle::PM_ScrollBarExtent, &option, this)
+                         : extra;
 
-    rect.adjust(0, 0, -widthDec, -heightDec);
+    const int heightDec = horizontalScrollBar()->isVisible()
+                          ? extra + scrollbarSpacing + style()->pixelMetric(QStyle::PM_ScrollBarExtent, &option, this)
+                          : extra;
 
-    m_controller->view()->setGeometry(QRect(0, 0, rect.width(), rect.height()));
+    const QRectF newGeometry(0, 0, rect.width() - widthDec,
+                             rect.height() - heightDec);
+    if (m_controller->view()->geometry() != newGeometry) {
+        m_controller->view()->setGeometry(newGeometry);
 
-    static_cast<KItemListContainerViewport*>(viewport())->scene()->setSceneRect(0, 0, rect.width(), rect.height());
-    static_cast<KItemListContainerViewport*>(viewport())->viewport()->setGeometry(QRect(0, 0, rect.width(), rect.height()));
+        // Get the real geometry of the view again since the scrollbars
+        // visibilities and the view geometry may have changed in re-layout.
+        static_cast<KItemListContainerViewport*>(viewport())->scene()->setSceneRect(m_controller->view()->geometry());
+        static_cast<KItemListContainerViewport*>(viewport())->viewport()->setGeometry(m_controller->view()->geometry().toRect());
 
-    updateScrollBars();
+        updateScrollOffsetScrollBar();
+        updateItemOffsetScrollBar();
+    }
 }
 
-void KItemListContainer::initialize()
+void KItemListContainer::updateSmoothScrollers(Qt::Orientation orientation)
 {
-    if (!m_controller) {
-        m_controller = new KItemListController(this);
+    if (orientation == Qt::Vertical) {
+        m_verticalSmoothScroller->setPropertyName("scrollOffset");
+        m_horizontalSmoothScroller->setPropertyName("itemOffset");
+    } else {
+        m_horizontalSmoothScroller->setPropertyName("scrollOffset");
+        m_verticalSmoothScroller->setPropertyName("itemOffset");
     }
+}
 
-    connect(m_controller, SIGNAL(modelChanged(KItemModelBase*,KItemModelBase*)),
-            this, SLOT(slotModelChanged(KItemModelBase*,KItemModelBase*)));
-    connect(m_controller, SIGNAL(viewChanged(KItemListView*,KItemListView*)),
-            this, SLOT(slotViewChanged(KItemListView*,KItemListView*)));
+void KItemListContainer::updateScrollOffsetScrollBarPolicy()
+{
+    const KItemListView* view = m_controller->view();
+    Q_ASSERT(view);
+    const bool vertical = (view->scrollOrientation() == Qt::Vertical);
 
-    QGraphicsView* graphicsView = new KItemListContainerViewport(new QGraphicsScene(this), this);
-    setViewport(graphicsView);
+    QStyleOption option;
+    option.initFrom(this);
+    const int scrollBarInc = style()->pixelMetric(QStyle::PM_ScrollBarExtent, &option, this);
 
-    m_viewOffsetAnimation = new QPropertyAnimation(this, "offset");
-    m_viewOffsetAnimation->setDuration(500);
+    QSizeF newViewSize = m_controller->view()->size();
+    if (vertical) {
+        newViewSize.rwidth() += scrollBarInc;
+    } else {
+        newViewSize.rheight() += scrollBarInc;
+    }
 
-    horizontalScrollBar()->installEventFilter(this);
-    verticalScrollBar()->installEventFilter(this);
+    const Qt::ScrollBarPolicy policy = view->scrollBarRequired(newViewSize)
+                                       ? Qt::ScrollBarAlwaysOn : Qt::ScrollBarAsNeeded;
+    if (vertical) {
+        setVerticalScrollBarPolicy(policy);
+    } else {
+        setHorizontalScrollBarPolicy(policy);
+    }
 }
 
 #include "kitemlistcontainer.moc"