src/kitemviews/kitemlistcontainer.h

   1 /*
   2  * SPDX-FileCopyrightText: 2011 Peter Penz <peter.penz19@gmail.com>
   3  *
   4  * Based on the Itemviews NG project from Trolltech Labs
   5  *
   6  * SPDX-License-Identifier: GPL-2.0-or-later
   7  */
   8
   9 #ifndef KITEMLISTCONTAINER_H
  10 #define KITEMLISTCONTAINER_H
  11
  12 #include "dolphin_export.h"
  13
  14 #include <QAbstractScrollArea>
  15
  16 class KItemListController;
  17 class KItemListSmoothScroller;
  18 class KItemListView;
  19 class KItemModelBase;
  20 class QScroller;
  21
  22 /**
  23  * @brief Provides a QWidget based scrolling view for a KItemListController.
  24  *
  25  * The model and view are maintained by the KItemListController.
  26  *
  27  * @see KItemListController
  28  */
  29 class DOLPHIN_EXPORT KItemListContainer : public QAbstractScrollArea
  30 {
  31     Q_OBJECT
  32
  33 public:
  34     /**
  35      * @param controller Controller that maintains the model and the view.
  36      *                   The KItemListContainer takes ownership of the controller
  37      *                   (the parent will be set to the KItemListContainer).
  38      * @param parent     Optional parent widget.
  39      */
  40     explicit KItemListContainer(KItemListController* controller, QWidget* parent = nullptr);
  41     ~KItemListContainer() override;
  42     KItemListController* controller() const;
  43
  44     void setEnabledFrame(bool enable);
  45     bool enabledFrame() const;
  46
  47 protected:
  48     void keyPressEvent(QKeyEvent* event) override;
  49     void showEvent(QShowEvent* event) override;
  50     void resizeEvent(QResizeEvent* event) override;
  51     void scrollContentsBy(int dx, int dy) override;
  52     void wheelEvent(QWheelEvent* event) override;
  53
  54 private Q_SLOTS:
  55     void slotScrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous);
  56     void slotModelChanged(KItemModelBase* current, KItemModelBase* previous);
  57     void slotViewChanged(KItemListView* current, KItemListView* previous);
  58     void scrollTo(qreal offset);
  59     void updateScrollOffsetScrollBar();
  60     void updateItemOffsetScrollBar();
  61     void stopScroller();
  62
  63 private:
  64     void updateGeometries();
  65     void updateSmoothScrollers(Qt::Orientation orientation);
  66
  67     /**
  68      * Helper method for updateScrollOffsetScrollBar(). Updates the scrollbar-policy
  69      * to Qt::ScrollBarAlwaysOn for cases where turning off the scrollbar might lead
  70      * to an endless layout loop (see bug #293318).
  71      */
  72     void updateScrollOffsetScrollBarPolicy();
  73
  74 private:
  75     KItemListController* m_controller;
  76
  77     KItemListSmoothScroller* m_horizontalSmoothScroller;
  78     KItemListSmoothScroller* m_verticalSmoothScroller;
  79     QScroller* m_scroller;
  80 };
  81
  82 #endif
  83
  84