Build with QT_NO_KEYWORDS

[dolphin.git] / src / kitemviews / kitemlistcontainer.h

diff --git a/src/kitemviews/kitemlistcontainer.h b/src/kitemviews/kitemlistcontainer.h
index 5f846a9bfa5230e98e3b25fe332a7099b9fc8102..9d96d2ce0cf5e0da36fb51ee755022907d504d26 100644 (file)
--- a/src/kitemviews/kitemlistcontainer.h
+++ b/src/kitemviews/kitemlistcontainer.h
@@ -1,78 +1,82 @@
-/***************************************************************************
- *   Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com>             *
- *                                                                         *
- *   Based on the Itemviews NG project from Trolltech Labs:                *
- *   http://qt.gitorious.org/qt-labs/itemviews-ng                          *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2011 Peter Penz <peter.penz19@gmail.com>
+ *
+ * Based on the Itemviews NG project from Trolltech Labs
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
 
 #ifndef KITEMLISTCONTAINER_H
 #define KITEMLISTCONTAINER_H
 
-#include <libdolphin_export.h>
+#include "dolphin_export.h"
 
-#include <QAbstractAnimation>
 #include <QAbstractScrollArea>
 
 class KItemListController;
+class KItemListSmoothScroller;
 class KItemListView;
 class KItemModelBase;
-class QPropertyAnimation;
+class QScroller;
 
 /**
  * @brief Provides a QWidget based scrolling view for a KItemListController.
  *
+ * The model and view are maintained by the KItemListController.
+ *
  * @see KItemListController
  */
-class LIBDOLPHINPRIVATE_EXPORT KItemListContainer : public QAbstractScrollArea
+class DOLPHIN_EXPORT KItemListContainer : public QAbstractScrollArea
 {
     Q_OBJECT
 
 public:
-    explicit KItemListContainer(KItemListController* controller, QWidget* parent = 0);
-    KItemListContainer(QWidget* parent = 0);
-    virtual ~KItemListContainer();
-
+    /**
+     * @param controller Controller that maintains the model and the view.
+     *                   The KItemListContainer takes ownership of the controller
+     *                   (the parent will be set to the KItemListContainer).
+     * @param parent     Optional parent widget.
+     */
+    explicit KItemListContainer(KItemListController* controller, QWidget* parent = nullptr);
+    ~KItemListContainer() override;
     KItemListController* controller() const;
 
+    void setEnabledFrame(bool enable);
+    bool enabledFrame() const;
+
 protected:
-    virtual void keyPressEvent(QKeyEvent* event);
-    virtual void showEvent(QShowEvent* event);
-    virtual void resizeEvent(QResizeEvent* event);
-    virtual void scrollContentsBy(int dx, int dy);
-    virtual bool eventFilter(QObject* obj, QEvent* event);
-    virtual void wheelEvent(QWheelEvent* event);
-
-private slots:
+    void keyPressEvent(QKeyEvent* event) override;
+    void showEvent(QShowEvent* event) override;
+    void resizeEvent(QResizeEvent* event) override;
+    void scrollContentsBy(int dx, int dy) override;
+    void wheelEvent(QWheelEvent* event) override;
+
+private Q_SLOTS:
+    void slotScrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous);
     void slotModelChanged(KItemModelBase* current, KItemModelBase* previous);
     void slotViewChanged(KItemListView* current, KItemListView* previous);
-    void slotAnimationStateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState);
     void scrollTo(qreal offset);
-    void updateScrollBars();
+    void updateScrollOffsetScrollBar();
+    void updateItemOffsetScrollBar();
+    void stopScroller();
 
 private:
-    void initialize();
     void updateGeometries();
+    void updateSmoothScrollers(Qt::Orientation orientation);
+
+    /**
+     * Helper method for updateScrollOffsetScrollBar(). Updates the scrollbar-policy
+     * to Qt::ScrollBarAlwaysOn for cases where turning off the scrollbar might lead
+     * to an endless layout loop (see bug #293318).
+     */
+    void updateScrollOffsetScrollBarPolicy();
 
 private:
     KItemListController* m_controller;
 
-    bool m_smoothScrolling;
-    QPropertyAnimation* m_smoothScrollingAnimation;
+    KItemListSmoothScroller* m_horizontalSmoothScroller;
+    KItemListSmoothScroller* m_verticalSmoothScroller;
+    QScroller* m_scroller;
 };
 
 #endif