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