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