src/kitemviews/kitemlistcontainer.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   Based on the Itemviews NG project from Trolltech Labs:                *
   5  *   http://qt.gitorious.org/qt-labs/itemviews-ng                          *
   6  *                                                                         *
   7  *   This program is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU General Public License as published by  *
   9  *   the Free Software Foundation; either version 2 of the License, or     *
  10  *   (at your option) any later version.                                   *
  11  *                                                                         *
  12  *   This program is distributed in the hope that it will be useful,       *
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  15  *   GNU General Public License for more details.                          *
  16  *                                                                         *
  17  *   You should have received a copy of the GNU General Public License     *
  18  *   along with this program; if not, write to the                         *
  19  *   Free Software Foundation, Inc.,                                       *
  20  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  21  ***************************************************************************/
  22
  23 #include "kitemlistcontainer.h"
  24
  25 #include "kitemlistcontroller.h"
  26 #include "kitemlistview.h"
  27 #include "kitemmodelbase.h"
  28
  29 #include "private/kitemlistsmoothscroller.h"
  30
  31 #include <QApplication>
  32 #include <QGraphicsScene>
  33 #include <QGraphicsView>
  34 #include <QPropertyAnimation>
  35 #include <QScrollBar>
  36 #include <QStyle>
  37 #include <QStyleOption>
  38
  39 #include <KDebug>
  40
  41 /**
  42  * Replaces the default viewport of KItemListContainer by a
  43  * non-scrollable viewport. The scrolling is done in an optimized
  44  * way by KItemListView internally.
  45  */
  46 class KItemListContainerViewport : public QGraphicsView
  47 {
  48 public:
  49     KItemListContainerViewport(QGraphicsScene* scene, QWidget* parent);
  50 protected:
  51     virtual void wheelEvent(QWheelEvent* event);
  52 };
  53
  54 KItemListContainerViewport::KItemListContainerViewport(QGraphicsScene* scene, QWidget* parent) :
  55     QGraphicsView(scene, parent)
  56 {
  57     setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
  58     setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
  59     setViewportMargins(0, 0, 0, 0);
  60     setFrameShape(QFrame::NoFrame);
  61 }
  62
  63 void KItemListContainerViewport::wheelEvent(QWheelEvent* event)
  64 {
  65     // Assure that the wheel-event gets forwarded to the parent
  66     // and not handled at all by QGraphicsView.
  67     event->ignore();
  68 }
  69
  70 KItemListContainer::KItemListContainer(KItemListController* controller, QWidget* parent) :
  71     QAbstractScrollArea(parent),
  72     m_controller(controller),
  73     m_horizontalSmoothScroller(0),
  74     m_verticalSmoothScroller(0)
  75 {
  76     Q_ASSERT(controller);
  77     controller->setParent(this);
  78
  79     QGraphicsView* graphicsView = new KItemListContainerViewport(new QGraphicsScene(this), this);
  80     setViewport(graphicsView);
  81
  82     m_horizontalSmoothScroller = new KItemListSmoothScroller(horizontalScrollBar(), this);
  83     m_verticalSmoothScroller = new KItemListSmoothScroller(verticalScrollBar(), this);
  84
  85     if (controller->model()) {
  86         slotModelChanged(controller->model(), 0);
  87     }
  88     if (controller->view()) {
  89         slotViewChanged(controller->view(), 0);
  90     }
  91
  92     connect(controller, &KItemListController::modelChanged,
  93             this, &KItemListContainer::slotModelChanged);
  94     connect(controller, &KItemListController::viewChanged,
  95             this, &KItemListContainer::slotViewChanged);
  96 }
  97
  98 KItemListContainer::~KItemListContainer()
  99 {
 100     // Don't rely on the QObject-order to delete the controller, otherwise
 101     // the QGraphicsScene might get deleted before the view.
 102     delete m_controller;
 103     m_controller = 0;
 104 }
 105
 106 KItemListController* KItemListContainer::controller() const
 107 {
 108     return m_controller;
 109 }
 110
 111 void KItemListContainer::setEnabledFrame(bool enable)
 112 {
 113     QGraphicsView* graphicsView = qobject_cast<QGraphicsView*>(viewport());
 114     if (enable) {
 115         setFrameShape(QFrame::StyledPanel);
 116         graphicsView->setPalette(palette());
 117         graphicsView->viewport()->setAutoFillBackground(true);
 118     } else {
 119         setFrameShape(QFrame::NoFrame);
 120         // Make the background of the container transparent and apply the window-text color
 121         // to the text color, so that enough contrast is given for all color
 122         // schemes
 123         QPalette p = graphicsView->palette();
 124         p.setColor(QPalette::Active,   QPalette::Text, p.color(QPalette::Active,   QPalette::WindowText));
 125         p.setColor(QPalette::Inactive, QPalette::Text, p.color(QPalette::Inactive, QPalette::WindowText));
 126         p.setColor(QPalette::Disabled, QPalette::Text, p.color(QPalette::Disabled, QPalette::WindowText));
 127         graphicsView->setPalette(p);
 128         graphicsView->viewport()->setAutoFillBackground(false);
 129     }
 130 }
 131
 132 bool KItemListContainer::enabledFrame() const
 133 {
 134     const QGraphicsView* graphicsView = qobject_cast<QGraphicsView*>(viewport());
 135     return graphicsView->autoFillBackground();
 136 }
 137
 138 void KItemListContainer::keyPressEvent(QKeyEvent* event)
 139 {
 140     // TODO: We should find a better way to handle the key press events in the view.
 141     // The reasons why we need this hack are:
 142     // 1. Without reimplementing keyPressEvent() here, the event would not reach the QGraphicsView.
 143     // 2. By default, the KItemListView does not have the keyboard focus in the QGraphicsScene, so
 144     //    simply sending the event to the QGraphicsView which is the KItemListContainer's viewport
 145     //    does not work.
 146     KItemListView* view = m_controller->view();
 147     if (view) {
 148         QApplication::sendEvent(view, event);
 149     }
 150 }
 151
 152 void KItemListContainer::showEvent(QShowEvent* event)
 153 {
 154     QAbstractScrollArea::showEvent(event);
 155     updateGeometries();
 156 }
 157
 158 void KItemListContainer::resizeEvent(QResizeEvent* event)
 159 {
 160     QAbstractScrollArea::resizeEvent(event);
 161     updateGeometries();
 162 }
 163
 164 void KItemListContainer::scrollContentsBy(int dx, int dy)
 165 {
 166     m_horizontalSmoothScroller->scrollContentsBy(dx);
 167     m_verticalSmoothScroller->scrollContentsBy(dy);
 168 }
 169
 170 void KItemListContainer::wheelEvent(QWheelEvent* event)
 171 {
 172     if (event->modifiers().testFlag(Qt::ControlModifier)) {
 173         event->ignore();
 174         return;
 175     }
 176
 177     KItemListView* view = m_controller->view();
 178     if (!view) {
 179         event->ignore();
 180         return;
 181     }
 182
 183     const bool scrollHorizontally = (event->orientation() == Qt::Horizontal) ||
 184                                     (event->orientation() == Qt::Vertical && !verticalScrollBar()->isVisible());
 185     KItemListSmoothScroller* smoothScroller = scrollHorizontally ?
 186                                               m_horizontalSmoothScroller : m_verticalSmoothScroller;
 187
 188     const int numDegrees = event->delta() / 8;
 189     const int numSteps = numDegrees / 15;
 190
 191     const QScrollBar* scrollBar = smoothScroller->scrollBar();
 192     smoothScroller->scrollTo(scrollBar->value() - numSteps * scrollBar->pageStep() / 4);
 193
 194     event->accept();
 195 }
 196
 197 void KItemListContainer::slotScrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous)
 198 {
 199     Q_UNUSED(previous);
 200     updateSmoothScrollers(current);
 201 }
 202
 203 void KItemListContainer::slotModelChanged(KItemModelBase* current, KItemModelBase* previous)
 204 {
 205     Q_UNUSED(current);
 206     Q_UNUSED(previous);
 207 }
 208
 209 void KItemListContainer::slotViewChanged(KItemListView* current, KItemListView* previous)
 210 {
 211     QGraphicsScene* scene = static_cast<QGraphicsView*>(viewport())->scene();
 212     if (previous) {
 213         scene->removeItem(previous);
 214         disconnect(previous, &KItemListView::scrollOrientationChanged,
 215                    this, &KItemListContainer::slotScrollOrientationChanged);
 216         disconnect(previous, &KItemListView::scrollOffsetChanged,
 217                    this, &KItemListContainer::updateScrollOffsetScrollBar);
 218         disconnect(previous, &KItemListView::maximumScrollOffsetChanged,
 219                    this, &KItemListContainer::updateScrollOffsetScrollBar);
 220         disconnect(previous, &KItemListView::itemOffsetChanged,
 221                    this, &KItemListContainer::updateItemOffsetScrollBar);
 222         disconnect(previous, &KItemListView::maximumItemOffsetChanged,
 223                    this, &KItemListContainer::updateItemOffsetScrollBar);
 224         disconnect(previous, &KItemListView::scrollTo, this, &KItemListContainer::scrollTo);
 225         m_horizontalSmoothScroller->setTargetObject(0);
 226         m_verticalSmoothScroller->setTargetObject(0);
 227     }
 228     if (current) {
 229         scene->addItem(current);
 230         connect(current, &KItemListView::scrollOrientationChanged,
 231                 this, &KItemListContainer::slotScrollOrientationChanged);
 232         connect(current, &KItemListView::scrollOffsetChanged,
 233                 this, &KItemListContainer::updateScrollOffsetScrollBar);
 234         connect(current, &KItemListView::maximumScrollOffsetChanged,
 235                 this, &KItemListContainer::updateScrollOffsetScrollBar);
 236         connect(current, &KItemListView::itemOffsetChanged,
 237                 this, &KItemListContainer::updateItemOffsetScrollBar);
 238         connect(current, &KItemListView::maximumItemOffsetChanged,
 239                 this, &KItemListContainer::updateItemOffsetScrollBar);
 240         connect(current, &KItemListView::scrollTo, this, &KItemListContainer::scrollTo);
 241         m_horizontalSmoothScroller->setTargetObject(current);
 242         m_verticalSmoothScroller->setTargetObject(current);
 243         updateSmoothScrollers(current->scrollOrientation());
 244     }
 245 }
 246
 247 void KItemListContainer::scrollTo(qreal offset)
 248 {
 249     const KItemListView* view = m_controller->view();
 250     if (view) {
 251         if (view->scrollOrientation() == Qt::Vertical) {
 252             m_verticalSmoothScroller->scrollTo(offset);
 253         } else {
 254             m_horizontalSmoothScroller->scrollTo(offset);
 255         }
 256     }
 257 }
 258
 259 void KItemListContainer::updateScrollOffsetScrollBar()
 260 {
 261     const KItemListView* view = m_controller->view();
 262     if (!view) {
 263         return;
 264     }
 265
 266     KItemListSmoothScroller* smoothScroller = 0;
 267     QScrollBar* scrollOffsetScrollBar = 0;
 268     int singleStep = 0;
 269     int pageStep = 0;
 270     int maximum = 0;
 271     if (view->scrollOrientation() == Qt::Vertical) {
 272         smoothScroller = m_verticalSmoothScroller;
 273         scrollOffsetScrollBar = verticalScrollBar();
 274         singleStep = view->itemSize().height();
 275         // We cannot use view->size().height() because this height might
 276         // include the header widget, which is not part of the scrolled area.
 277         pageStep = view->verticalPageStep();
 278
 279         // However, the total height of the view must be considered for the
 280         // maximum value of the scroll bar. Note that the view's scrollOffset()
 281         // refers to the offset of the top part of the view, which might be
 282         // hidden behind the header.
 283         maximum = qMax(0, int(view->maximumScrollOffset() - view->size().height()));
 284     } else {
 285         smoothScroller = m_horizontalSmoothScroller;
 286         scrollOffsetScrollBar = horizontalScrollBar();
 287         singleStep = view->itemSize().width();
 288         pageStep = view->size().width();
 289         maximum = qMax(0, int(view->maximumScrollOffset() - view->size().width()));
 290     }
 291
 292     const int value = view->scrollOffset();
 293     if (smoothScroller->requestScrollBarUpdate(maximum)) {
 294         const bool updatePolicy = (scrollOffsetScrollBar->maximum() > 0 && maximum == 0)
 295                                   || horizontalScrollBarPolicy() == Qt::ScrollBarAlwaysOn;
 296
 297         scrollOffsetScrollBar->setSingleStep(singleStep);
 298         scrollOffsetScrollBar->setPageStep(pageStep);
 299         scrollOffsetScrollBar->setMinimum(0);
 300         scrollOffsetScrollBar->setMaximum(maximum);
 301         scrollOffsetScrollBar->setValue(value);
 302
 303         if (updatePolicy) {
 304             // Prevent a potential endless layout loop (see bug #293318).
 305             updateScrollOffsetScrollBarPolicy();
 306         }
 307     }
 308 }
 309
 310 void KItemListContainer::updateItemOffsetScrollBar()
 311 {
 312     const KItemListView* view = m_controller->view();
 313     if (!view) {
 314         return;
 315     }
 316
 317     KItemListSmoothScroller* smoothScroller = 0;
 318     QScrollBar* itemOffsetScrollBar = 0;
 319     int singleStep = 0;
 320     int pageStep = 0;
 321     if (view->scrollOrientation() == Qt::Vertical) {
 322         smoothScroller = m_horizontalSmoothScroller;
 323         itemOffsetScrollBar = horizontalScrollBar();
 324         singleStep = view->size().width() / 10;
 325         pageStep = view->size().width();
 326     } else {
 327         smoothScroller = m_verticalSmoothScroller;
 328         itemOffsetScrollBar = verticalScrollBar();
 329         singleStep = view->size().height() / 10;
 330         pageStep = view->size().height();
 331     }
 332
 333     const int value = view->itemOffset();
 334     const int maximum = qMax(0, int(view->maximumItemOffset()) - pageStep);
 335     if (smoothScroller->requestScrollBarUpdate(maximum)) {
 336         itemOffsetScrollBar->setSingleStep(singleStep);
 337         itemOffsetScrollBar->setPageStep(pageStep);
 338         itemOffsetScrollBar->setMinimum(0);
 339         itemOffsetScrollBar->setMaximum(maximum);
 340         itemOffsetScrollBar->setValue(value);
 341     }
 342 }
 343
 344 void KItemListContainer::updateGeometries()
 345 {
 346     QRect rect = geometry();
 347
 348     int extra = frameWidth() * 2;
 349     QStyleOption option;
 350     option.initFrom(this);
 351     int scrollbarSpacing = 0;
 352     if (style()->styleHint(QStyle::SH_ScrollView_FrameOnlyAroundContents, &option, this)) {
 353         scrollbarSpacing = style()->pixelMetric(QStyle::PM_ScrollView_ScrollBarSpacing, &option, this);
 354     }
 355
 356     const int widthDec = verticalScrollBar()->isVisible()
 357                          ? extra + scrollbarSpacing + style()->pixelMetric(QStyle::PM_ScrollBarExtent, &option, this)
 358                          : extra;
 359
 360     const int heightDec = horizontalScrollBar()->isVisible()
 361                           ? extra + scrollbarSpacing + style()->pixelMetric(QStyle::PM_ScrollBarExtent, &option, this)
 362                           : extra;
 363
 364     const QRectF newGeometry(0, 0, rect.width() - widthDec,
 365                              rect.height() - heightDec);
 366     if (m_controller->view()->geometry() != newGeometry) {
 367         m_controller->view()->setGeometry(newGeometry);
 368
 369         // Get the real geometry of the view again since the scrollbars
 370         // visibilities and the view geometry may have changed in re-layout.
 371         static_cast<KItemListContainerViewport*>(viewport())->scene()->setSceneRect(m_controller->view()->geometry());
 372         static_cast<KItemListContainerViewport*>(viewport())->viewport()->setGeometry(m_controller->view()->geometry().toRect());
 373
 374         updateScrollOffsetScrollBar();
 375         updateItemOffsetScrollBar();
 376     }
 377 }
 378
 379 void KItemListContainer::updateSmoothScrollers(Qt::Orientation orientation)
 380 {
 381     if (orientation == Qt::Vertical) {
 382         m_verticalSmoothScroller->setPropertyName("scrollOffset");
 383         m_horizontalSmoothScroller->setPropertyName("itemOffset");
 384     } else {
 385         m_horizontalSmoothScroller->setPropertyName("scrollOffset");
 386         m_verticalSmoothScroller->setPropertyName("itemOffset");
 387     }
 388 }
 389
 390 void KItemListContainer::updateScrollOffsetScrollBarPolicy()
 391 {
 392     const KItemListView* view = m_controller->view();
 393     Q_ASSERT(view);
 394     const bool vertical = (view->scrollOrientation() == Qt::Vertical);
 395
 396     QStyleOption option;
 397     option.initFrom(this);
 398     const int scrollBarInc = style()->pixelMetric(QStyle::PM_ScrollBarExtent, &option, this);
 399
 400     QSizeF newViewSize = m_controller->view()->size();
 401     if (vertical) {
 402         newViewSize.rwidth() += scrollBarInc;
 403     } else {
 404         newViewSize.rheight() += scrollBarInc;
 405     }
 406
 407     const Qt::ScrollBarPolicy policy = view->scrollBarRequired(newViewSize)
 408                                        ? Qt::ScrollBarAlwaysOn : Qt::ScrollBarAsNeeded;
 409     if (vertical) {
 410         setVerticalScrollBarPolicy(policy);
 411     } else {
 412         setHorizontalScrollBarPolicy(policy);
 413     }
 414 }
 415
 416 #include "kitemlistcontainer.moc"