src/kitemviews/kitemlistcontainer.h

   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 #ifndef KITEMLISTCONTAINER_H
  24 #define KITEMLISTCONTAINER_H
  25
  26 #include "dolphin_export.h"
  27
  28 #include <QAbstractScrollArea>
  29
  30 class KItemListController;
  31 class KItemListSmoothScroller;
  32 class KItemListView;
  33 class KItemModelBase;
  34
  35 /**
  36  * @brief Provides a QWidget based scrolling view for a KItemListController.
  37  *
  38  * The model and view are maintained by the KItemListController.
  39  *
  40  * @see KItemListController
  41  */
  42 class DOLPHIN_EXPORT KItemListContainer : public QAbstractScrollArea
  43 {
  44     Q_OBJECT
  45
  46 public:
  47     /**
  48      * @param controller Controller that maintains the model and the view.
  49      *                   The KItemListContainer takes ownership of the controller
  50      *                   (the parent will be set to the KItemListContainer).
  51      * @param parent     Optional parent widget.
  52      */
  53     explicit KItemListContainer(KItemListController* controller, QWidget* parent = 0);
  54     virtual ~KItemListContainer();
  55     KItemListController* controller() const;
  56
  57     void setEnabledFrame(bool enable);
  58     bool enabledFrame() const;
  59
  60 protected:
  61     virtual void keyPressEvent(QKeyEvent* event) Q_DECL_OVERRIDE;
  62     virtual void showEvent(QShowEvent* event) Q_DECL_OVERRIDE;
  63     virtual void resizeEvent(QResizeEvent* event) Q_DECL_OVERRIDE;
  64     virtual void scrollContentsBy(int dx, int dy) Q_DECL_OVERRIDE;
  65     virtual void wheelEvent(QWheelEvent* event) Q_DECL_OVERRIDE;
  66
  67 private slots:
  68     void slotScrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous);
  69     void slotModelChanged(KItemModelBase* current, KItemModelBase* previous);
  70     void slotViewChanged(KItemListView* current, KItemListView* previous);
  71     void scrollTo(qreal offset);
  72     void updateScrollOffsetScrollBar();
  73     void updateItemOffsetScrollBar();
  74
  75 private:
  76     void updateGeometries();
  77     void updateSmoothScrollers(Qt::Orientation orientation);
  78
  79     /**
  80      * Helper method for updateScrollOffsetScrollBar(). Updates the scrollbar-policy
  81      * to Qt::ScrollBarAlwaysOn for cases where turning off the scrollbar might lead
  82      * to an endless layout loop (see bug #293318).
  83      */
  84     void updateScrollOffsetScrollBarPolicy();
  85
  86 private:
  87     KItemListController* m_controller;
  88
  89     KItemListSmoothScroller* m_horizontalSmoothScroller;
  90     KItemListSmoothScroller* m_verticalSmoothScroller;
  91 };
  92
  93 #endif
  94
  95