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 <QScrollBar>
  35 #include <QStyle>
  36 #include <QStyleOption>
  37
  38
  39 /**
  40  * Replaces the default viewport of KItemListContainer by a
  41  * non-scrollable viewport. The scrolling is done in an optimized
  42  * way by KItemListView internally.
  43  */
  44 class KItemListContainerViewport : public QGraphicsView
  45 {
  46     Q_OBJECT
  47
  48 public:
  49     KItemListContainerViewport(QGraphicsScene* scene, QWidget* parent);
  50 protected:
  51     void wheelEvent(QWheelEvent* event) override;
  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     smoothScroller->handleWheelEvent(event);
 189 }
 190
 191 void KItemListContainer::slotScrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous)
 192 {
 193     Q_UNUSED(previous);
 194     updateSmoothScrollers(current);
 195 }
 196
 197 void KItemListContainer::slotModelChanged(KItemModelBase* current, KItemModelBase* previous)
 198 {
 199     Q_UNUSED(current);
 200     Q_UNUSED(previous);
 201 }
 202
 203 void KItemListContainer::slotViewChanged(KItemListView* current, KItemListView* previous)
 204 {
 205     QGraphicsScene* scene = static_cast<QGraphicsView*>(viewport())->scene();
 206     if (previous) {
 207         scene->removeItem(previous);
 208         disconnect(previous, &KItemListView::scrollOrientationChanged,
 209                    this, &KItemListContainer::slotScrollOrientationChanged);
 210         disconnect(previous, &KItemListView::scrollOffsetChanged,
 211                    this, &KItemListContainer::updateScrollOffsetScrollBar);
 212         disconnect(previous, &KItemListView::maximumScrollOffsetChanged,
 213                    this, &KItemListContainer::updateScrollOffsetScrollBar);
 214         disconnect(previous, &KItemListView::itemOffsetChanged,
 215                    this, &KItemListContainer::updateItemOffsetScrollBar);
 216         disconnect(previous, &KItemListView::maximumItemOffsetChanged,
 217                    this, &KItemListContainer::updateItemOffsetScrollBar);
 218         disconnect(previous, &KItemListView::scrollTo, this, &KItemListContainer::scrollTo);
 219         m_horizontalSmoothScroller->setTargetObject(0);
 220         m_verticalSmoothScroller->setTargetObject(0);
 221     }
 222     if (current) {
 223         scene->addItem(current);
 224         connect(current, &KItemListView::scrollOrientationChanged,
 225                 this, &KItemListContainer::slotScrollOrientationChanged);
 226         connect(current, &KItemListView::scrollOffsetChanged,
 227                 this, &KItemListContainer::updateScrollOffsetScrollBar);
 228         connect(current, &KItemListView::maximumScrollOffsetChanged,
 229                 this, &KItemListContainer::updateScrollOffsetScrollBar);
 230         connect(current, &KItemListView::itemOffsetChanged,
 231                 this, &KItemListContainer::updateItemOffsetScrollBar);
 232         connect(current, &KItemListView::maximumItemOffsetChanged,
 233                 this, &KItemListContainer::updateItemOffsetScrollBar);
 234         connect(current, &KItemListView::scrollTo, this, &KItemListContainer::scrollTo);
 235         m_horizontalSmoothScroller->setTargetObject(current);
 236         m_verticalSmoothScroller->setTargetObject(current);
 237         updateSmoothScrollers(current->scrollOrientation());
 238     }
 239 }
 240
 241 void KItemListContainer::scrollTo(qreal offset)
 242 {
 243     const KItemListView* view = m_controller->view();
 244     if (view) {
 245         if (view->scrollOrientation() == Qt::Vertical) {
 246             m_verticalSmoothScroller->scrollTo(offset);
 247         } else {
 248             m_horizontalSmoothScroller->scrollTo(offset);
 249         }
 250     }
 251 }
 252
 253 void KItemListContainer::updateScrollOffsetScrollBar()
 254 {
 255     const KItemListView* view = m_controller->view();
 256     if (!view) {
 257         return;
 258     }
 259
 260     KItemListSmoothScroller* smoothScroller = 0;
 261     QScrollBar* scrollOffsetScrollBar = 0;
 262     int singleStep = 0;
 263     int pageStep = 0;
 264     int maximum = 0;
 265     if (view->scrollOrientation() == Qt::Vertical) {
 266         smoothScroller = m_verticalSmoothScroller;
 267         scrollOffsetScrollBar = verticalScrollBar();
 268         singleStep = view->itemSizeHint().height();
 269         // We cannot use view->size().height() because this height might
 270         // include the header widget, which is not part of the scrolled area.
 271         pageStep = view->verticalPageStep();
 272
 273         // However, the total height of the view must be considered for the
 274         // maximum value of the scroll bar. Note that the view's scrollOffset()
 275         // refers to the offset of the top part of the view, which might be
 276         // hidden behind the header.
 277         maximum = qMax(0, int(view->maximumScrollOffset() - view->size().height()));
 278     } else {
 279         smoothScroller = m_horizontalSmoothScroller;
 280         scrollOffsetScrollBar = horizontalScrollBar();
 281         singleStep = view->itemSize().width();
 282         pageStep = view->size().width();
 283         maximum = qMax(0, int(view->maximumScrollOffset() - view->size().width()));
 284     }
 285
 286     const int value = view->scrollOffset();
 287     if (smoothScroller->requestScrollBarUpdate(maximum)) {
 288         const bool updatePolicy = (scrollOffsetScrollBar->maximum() > 0 && maximum == 0)
 289                                   || horizontalScrollBarPolicy() == Qt::ScrollBarAlwaysOn;
 290
 291         scrollOffsetScrollBar->setSingleStep(singleStep);
 292         scrollOffsetScrollBar->setPageStep(pageStep);
 293         scrollOffsetScrollBar->setMinimum(0);
 294         scrollOffsetScrollBar->setMaximum(maximum);
 295         scrollOffsetScrollBar->setValue(value);
 296
 297         if (updatePolicy) {
 298             // Prevent a potential endless layout loop (see bug #293318).
 299             updateScrollOffsetScrollBarPolicy();
 300         }
 301     }
 302 }
 303
 304 void KItemListContainer::updateItemOffsetScrollBar()
 305 {
 306     const KItemListView* view = m_controller->view();
 307     if (!view) {
 308         return;
 309     }
 310
 311     KItemListSmoothScroller* smoothScroller = 0;
 312     QScrollBar* itemOffsetScrollBar = 0;
 313     int singleStep = 0;
 314     int pageStep = 0;
 315     if (view->scrollOrientation() == Qt::Vertical) {
 316         smoothScroller = m_horizontalSmoothScroller;
 317         itemOffsetScrollBar = horizontalScrollBar();
 318         singleStep = view->size().width() / 10;
 319         pageStep = view->size().width();
 320     } else {
 321         smoothScroller = m_verticalSmoothScroller;
 322         itemOffsetScrollBar = verticalScrollBar();
 323         singleStep = view->size().height() / 10;
 324         pageStep = view->size().height();
 325     }
 326
 327     const int value = view->itemOffset();
 328     const int maximum = qMax(0, int(view->maximumItemOffset()) - pageStep);
 329     if (smoothScroller->requestScrollBarUpdate(maximum)) {
 330         itemOffsetScrollBar->setSingleStep(singleStep);
 331         itemOffsetScrollBar->setPageStep(pageStep);
 332         itemOffsetScrollBar->setMinimum(0);
 333         itemOffsetScrollBar->setMaximum(maximum);
 334         itemOffsetScrollBar->setValue(value);
 335     }
 336 }
 337
 338 void KItemListContainer::updateGeometries()
 339 {
 340     QRect rect = geometry();
 341
 342     int extra = frameWidth() * 2;
 343     QStyleOption option;
 344     option.initFrom(this);
 345     int scrollbarSpacing = 0;
 346     if (style()->styleHint(QStyle::SH_ScrollView_FrameOnlyAroundContents, &option, this)) {
 347         scrollbarSpacing = style()->pixelMetric(QStyle::PM_ScrollView_ScrollBarSpacing, &option, this);
 348     }
 349
 350     const int widthDec = verticalScrollBar()->isVisible()
 351                          ? extra + scrollbarSpacing + style()->pixelMetric(QStyle::PM_ScrollBarExtent, &option, this)
 352                          : extra;
 353
 354     const int heightDec = horizontalScrollBar()->isVisible()
 355                           ? extra + scrollbarSpacing + style()->pixelMetric(QStyle::PM_ScrollBarExtent, &option, this)
 356                           : extra;
 357
 358     const QRectF newGeometry(0, 0, rect.width() - widthDec,
 359                              rect.height() - heightDec);
 360     if (m_controller->view()->geometry() != newGeometry) {
 361         m_controller->view()->setGeometry(newGeometry);
 362
 363         // Get the real geometry of the view again since the scrollbars
 364         // visibilities and the view geometry may have changed in re-layout.
 365         static_cast<KItemListContainerViewport*>(viewport())->scene()->setSceneRect(m_controller->view()->geometry());
 366         static_cast<KItemListContainerViewport*>(viewport())->viewport()->setGeometry(m_controller->view()->geometry().toRect());
 367
 368         updateScrollOffsetScrollBar();
 369         updateItemOffsetScrollBar();
 370     }
 371 }
 372
 373 void KItemListContainer::updateSmoothScrollers(Qt::Orientation orientation)
 374 {
 375     if (orientation == Qt::Vertical) {
 376         m_verticalSmoothScroller->setPropertyName("scrollOffset");
 377         m_horizontalSmoothScroller->setPropertyName("itemOffset");
 378     } else {
 379         m_horizontalSmoothScroller->setPropertyName("scrollOffset");
 380         m_verticalSmoothScroller->setPropertyName("itemOffset");
 381     }
 382 }
 383
 384 void KItemListContainer::updateScrollOffsetScrollBarPolicy()
 385 {
 386     const KItemListView* view = m_controller->view();
 387     Q_ASSERT(view);
 388     const bool vertical = (view->scrollOrientation() == Qt::Vertical);
 389
 390     QStyleOption option;
 391     option.initFrom(this);
 392     const int scrollBarInc = style()->pixelMetric(QStyle::PM_ScrollBarExtent, &option, this);
 393
 394     QSizeF newViewSize = m_controller->view()->size();
 395     if (vertical) {
 396         newViewSize.rwidth() += scrollBarInc;
 397     } else {
 398         newViewSize.rheight() += scrollBarInc;
 399     }
 400
 401     const Qt::ScrollBarPolicy policy = view->scrollBarRequired(newViewSize)
 402                                        ? Qt::ScrollBarAlwaysOn : Qt::ScrollBarAsNeeded;
 403     if (vertical) {
 404         setVerticalScrollBarPolicy(policy);
 405     } else {
 406         setHorizontalScrollBarPolicy(policy);
 407     }
 408 }
 409
 410 #include "kitemlistcontainer.moc"