src/kitemviews/private/kitemlistviewanimation.h

   1 /*
   2  * SPDX-FileCopyrightText: 2011 Peter Penz <peter.penz19@gmail.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-or-later
   5  */
   6
   7 #ifndef KITEMLISTVIEWANIMATION_H
   8 #define KITEMLISTVIEWANIMATION_H
   9
  10 #include "dolphin_export.h"
  11
  12 #include <QHash>
  13 #include <QObject>
  14 #include <QVariant>
  15
  16 class KItemListView;
  17 class QGraphicsWidget;
  18 class QPropertyAnimation;
  19
  20 /**
  21  * @brief Internal helper class for KItemListView to animate the items.
  22  *
  23  * Supports item animations for moving, creating, deleting and resizing
  24  * an item. Several applications can be applied to one item in parallel.
  25  */
  26 class DOLPHIN_EXPORT KItemListViewAnimation : public QObject
  27 {
  28     Q_OBJECT
  29
  30 public:
  31     enum AnimationType { MovingAnimation, CreateAnimation, DeleteAnimation, ResizeAnimation, IconResizeAnimation, AnimationTypeCount };
  32
  33     explicit KItemListViewAnimation(QObject *parent = nullptr);
  34     ~KItemListViewAnimation() override;
  35
  36     void setScrollOrientation(Qt::Orientation orientation);
  37     Qt::Orientation scrollOrientation() const;
  38
  39     void setScrollOffset(qreal scrollOffset);
  40     qreal scrollOffset() const;
  41
  42     /**
  43      * Starts the animation of the type \a type for the widget \a widget. If an animation
  44      * of the type is already running, this animation will be stopped before starting
  45      * the new animation.
  46      */
  47     void start(QGraphicsWidget *widget, AnimationType type, const QVariant &endValue = QVariant());
  48
  49     /**
  50      * Stops the animation of the type \a type for the widget \a widget.
  51      */
  52     void stop(QGraphicsWidget *widget, AnimationType type);
  53
  54     /**
  55      * Stops all animations that have been applied to the widget \a widget.
  56      */
  57     void stop(QGraphicsWidget *widget);
  58
  59     /**
  60      * @return True if the animation of the type \a type has been started
  61      *         for the widget \a widget..
  62      */
  63     bool isStarted(QGraphicsWidget *widget, AnimationType type) const;
  64
  65     /**
  66      * @return True if any animation has been started for the widget.
  67      */
  68     bool isStarted(QGraphicsWidget *widget) const;
  69
  70 Q_SIGNALS:
  71     void finished(QGraphicsWidget *widget, KItemListViewAnimation::AnimationType type);
  72
  73 private Q_SLOTS:
  74     void slotFinished();
  75
  76 private:
  77     Qt::Orientation m_scrollOrientation;
  78     qreal m_scrollOffset;
  79     QHash<QGraphicsWidget *, QPropertyAnimation *> m_animation[AnimationTypeCount];
  80 };
  81
  82 #endif