New selection effects

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

diff --git a/src/kitemviews/kitemlistwidget.h b/src/kitemviews/kitemlistwidget.h
index aad499853ff16ad739155e88ea960a60bc477cf5..b87a3b34e65f98e78c0bbcf6609a55953981c5ee 100644 (file)
--- a/src/kitemviews/kitemlistwidget.h
+++ b/src/kitemviews/kitemlistwidget.h
@@ -15,13 +15,15 @@
 #include <QBitArray>
 #include <QGraphicsWidget>
 #include <QStyle>
 #include <QBitArray>
 #include <QGraphicsWidget>
 #include <QStyle>

+#include <QTimer>

 
 class KItemListSelectionToggle;
 class KItemListView;
 class QPropertyAnimation;
 
 /**
 
 class KItemListSelectionToggle;
 class KItemListView;
 class QPropertyAnimation;
 
 /**

- * @brief Provides information for creating an instance of KItemListWidget.
+ * @brief Provides generic information for all KItemListWidgets
+ * for which the construction of any specific KItemListWidget isn't required.

  *
  * KItemListView only creates KItemListWidget instances for the visible
  * area. For calculating the required size of all items the expected
  *
  * KItemListView only creates KItemListWidget instances for the visible
  * area. For calculating the required size of all items the expected


@@ -34,11 +36,9 @@ public:
     KItemListWidgetInformant();
     virtual ~KItemListWidgetInformant();
 
     KItemListWidgetInformant();
     virtual ~KItemListWidgetInformant();
 

-    virtual void calculateItemSizeHints(QVector<qreal>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const = 0;
+    virtual void calculateItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints, qreal &logicalWidthHint, const KItemListView *view) const = 0;

 
 

-    virtual qreal preferredRoleColumnWidth(const QByteArray& role,
-                                           int index,
-                                           const KItemListView* view) const = 0;
+    virtual qreal preferredRoleColumnWidth(const QByteArray &role, int index, const KItemListView *view) const = 0;

 };
 
 /**
 };
 
 /**


@@ -53,34 +53,39 @@ class DOLPHIN_EXPORT KItemListWidget : public QGraphicsWidget
     Q_OBJECT
 
 public:
     Q_OBJECT
 
 public:

-    KItemListWidget(KItemListWidgetInformant* informant, QGraphicsItem* parent);
+    KItemListWidget(KItemListWidgetInformant *informant, QGraphicsItem *parent);

     ~KItemListWidget() override;
 
     void setIndex(int index);
     int index() const;
 
     ~KItemListWidget() override;
 
     void setIndex(int index);
     int index() const;
 

-    void setData(const QHash<QByteArray, QVariant>& data, const QSet<QByteArray>& roles = QSet<QByteArray>());
+    void setData(const QHash<QByteArray, QVariant> &data, const QSet<QByteArray> &roles = QSet<QByteArray>());

     QHash<QByteArray, QVariant> data() const;
     QHash<QByteArray, QVariant> data() const;

+    QVariant value(const QByteArray &key) const;

 
     /**
      * Draws the hover-rectangle if the item is hovered. Overwrite this method
      * to show the data of the custom model provided by KItemListWidget::data().
      * @reimp
      */
 
     /**
      * Draws the hover-rectangle if the item is hovered. Overwrite this method
      * to show the data of the custom model provided by KItemListWidget::data().
      * @reimp
      */

-    void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = nullptr) override;
+    void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr) override;

 
 

-    void setVisibleRoles(const QList<QByteArray>& roles);
+    void setVisibleRoles(const QList<QByteArray> &roles);

     QList<QByteArray> visibleRoles() const;
 
     /**
      * Sets the width of a role that should be used if the alignment of the content
      * should be done in columns.
      */
     QList<QByteArray> visibleRoles() const;
 
     /**
      * Sets the width of a role that should be used if the alignment of the content
      * should be done in columns.
      */

-    void setColumnWidth(const QByteArray& role, qreal width);
-    qreal columnWidth(const QByteArray& role) const;
+    void setColumnWidth(const QByteArray &role, qreal width);
+    qreal columnWidth(const QByteArray &role) const;

 
 

-    void setStyleOption(const KItemListStyleOption& option);
-    const KItemListStyleOption& styleOption() const;
+    void setSidePadding(qreal leftPaddingWidth, qreal rightPaddingWidth);
+    qreal leftPadding() const;
+    qreal rightPadding() const;
+
+    void setStyleOption(const KItemListStyleOption &option);
+    const KItemListStyleOption &styleOption() const;

 
     // TODO: Hides QGraphicsItem::setSelected()/isSelected(). Replace
     // this by using the default mechanism.
 
     // TODO: Hides QGraphicsItem::setSelected()/isSelected(). Replace
     // this by using the default mechanism.


@@ -93,7 +98,14 @@ public:
     void setHovered(bool hovered);
     bool isHovered() const;
 
     void setHovered(bool hovered);
     bool isHovered() const;
 

-    void setHoverPosition(const QPointF& pos);
+    /** Sets a purely visual pressed highlight effect. */
+    void setPressed(bool enabled);
+    bool isPressed() const;
+
+    void setExpansionAreaHovered(bool hover);
+    bool expansionAreaHovered() const;
+
+    void setHoverPosition(const QPointF &pos);

 
     void setAlternateBackground(bool enable);
     bool alternateBackground() const;
 
     void setAlternateBackground(bool enable);
     bool alternateBackground() const;


@@ -108,7 +120,7 @@ public:
      * The sibling information is useful for drawing the branches in
      * tree views.
      */
      * The sibling information is useful for drawing the branches in
      * tree views.
      */

-    void setSiblingsInformation(const QBitArray& siblings);
+    void setSiblingsInformation(const QBitArray &siblings);

     QBitArray siblingsInformation() const;
 
     /**
     QBitArray siblingsInformation() const;
 
     /**


@@ -118,21 +130,23 @@ public:
      * the role is empty. Derived classes must implement
      * editedRoleChanged().
      */
      * the role is empty. Derived classes must implement
      * editedRoleChanged().
      */

-    void setEditedRole(const QByteArray& role);
+    void setEditedRole(const QByteArray &role);

     QByteArray editedRole() const;
 
     /**
     QByteArray editedRole() const;
 
     /**

-     * @return True if \a point is inside KItemListWidget::hoverRect(),
-     *         KItemListWidget::textRect(), KItemListWidget::selectionToggleRect()
-     *         or KItemListWidget::expansionToggleRect().
-     * @reimp
+     * Contains the actual icon size used to draw the icon.
+     * Also used during icon resizing animation.

      */
      */

-    bool contains(const QPointF& point) const override;
+    void setIconSize(int iconSize);
+    int iconSize() const;

 
     /**
 
     /**

-     * @return Rectangle for the area that shows the icon.
+     * @return True if \a point is inside KItemListWidget::selectionRectFull(),
+     *         KItemListWidget::selectionToggleRect()
+     *         or KItemListWidget::expansionToggleRect().
+     * @reimp

      */
      */

-    virtual QRectF iconRect() const = 0;
+    bool contains(const QPointF &point) const override;

 
     /**
      * @return Rectangle for the area that contains the text-properties.
 
     /**
      * @return Rectangle for the area that contains the text-properties.


@@ -149,9 +163,17 @@ public:
     virtual QRectF textFocusRect() const;
 
     /**
     virtual QRectF textFocusRect() const;
 
     /**

-     * @return Rectangle around which a selection box should be drawn if the item is selected.
+     * Used for drawing the visuals, and situations where we want the behavior of the
+     * selection to match the visuals.
+     *
+     * @return The rectangle around selection.

      */
      */

-    virtual QRectF selectionRect() const = 0;
+    virtual QRectF selectionRectFull() const = 0;
+
+    /**
+     * @return The core area of the item. All of it reacts exactly the same way to mouse clicks.
+     */
+    virtual QRectF selectionRectCore() const = 0;

 
     /**
      * @return Rectangle for the selection-toggle that is used to select or deselect an item.
 
     /**
      * @return Rectangle for the selection-toggle that is used to select or deselect an item.


@@ -171,24 +193,50 @@ public:
      * @return Pixmap that is used when dragging an item. Per default the current state of the
      *         widget is returned as pixmap.
      */
      * @return Pixmap that is used when dragging an item. Per default the current state of the
      *         widget is returned as pixmap.
      */

-    virtual QPixmap createDragPixmap(const QStyleOptionGraphicsItem* option, QWidget* widget = nullptr);
+    virtual QPixmap createDragPixmap(const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr);

 
 

-signals:
-    void roleEditingCanceled(int index, const QByteArray& role, const QVariant& value);
-    void roleEditingFinished(int index, const QByteArray& role, const QVariant& value);
+    /**
+     * Starts an animation that makes clear that the item will be activated soon.
+     * @param timeUntilActivation time in milliseconds until the item will activate
+     */
+    virtual void startActivateSoonAnimation(int timeUntilActivation);
+
+Q_SIGNALS:
+    void roleEditingCanceled(int index, const QByteArray &role, const QVariant &value);
+    void roleEditingFinished(int index, const QByteArray &role, const QVariant &value);

 
 protected:
 
 protected:

-    virtual void dataChanged(const QHash<QByteArray, QVariant>& current, const QSet<QByteArray>& roles = QSet<QByteArray>());
-    virtual void visibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous);
-    virtual void columnWidthChanged(const QByteArray& role, qreal current, qreal previous);
-    virtual void styleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous);
+    virtual void dataChanged(const QHash<QByteArray, QVariant> &current, const QSet<QByteArray> &roles = QSet<QByteArray>());
+    virtual void visibleRolesChanged(const QList<QByteArray> &current, const QList<QByteArray> &previous);
+    virtual void columnWidthChanged(const QByteArray &role, qreal current, qreal previous);
+    virtual void sidePaddingChanged(qreal leftPaddingWidth, qreal rightPaddingWidth);
+    virtual void styleOptionChanged(const KItemListStyleOption &current, const KItemListStyleOption &previous);

     virtual void currentChanged(bool current);
     virtual void selectedChanged(bool selected);
     virtual void hoveredChanged(bool hovered);
     virtual void alternateBackgroundChanged(bool enabled);
     virtual void currentChanged(bool current);
     virtual void selectedChanged(bool selected);
     virtual void hoveredChanged(bool hovered);
     virtual void alternateBackgroundChanged(bool enabled);

-    virtual void siblingsInformationChanged(const QBitArray& current, const QBitArray& previous);
-    virtual void editedRoleChanged(const QByteArray& current, const QByteArray& previous);
-    void resizeEvent(QGraphicsSceneResizeEvent* event) override;
+    virtual void siblingsInformationChanged(const QBitArray &current, const QBitArray &previous);
+    virtual void editedRoleChanged(const QByteArray &current, const QByteArray &previous);
+    virtual void iconSizeChanged(int current, int previous);
+    void resizeEvent(QGraphicsSceneResizeEvent *event) override;
+    void clearHoverCache();
+
+    /**
+     * Called when the user starts hovering this item.
+     */
+    virtual void hoverSequenceStarted();
+
+    /**
+     * Called in regular intervals while the user is hovering this item.
+     *
+     * @param sequenceIndex An index that increases over time while the user hovers.
+     */
+    virtual void hoverSequenceIndexChanged(int sequenceIndex);
+
+    /**
+     * Called when the user stops hovering this item.
+     */
+    virtual void hoverSequenceEnded();

 
     /**
      * @return The current opacity of the hover-animation. When implementing a custom painting-code for a hover-state
 
     /**
      * @return The current opacity of the hover-animation. When implementing a custom painting-code for a hover-state


@@ -196,47 +244,51 @@ protected:
      */
     qreal hoverOpacity() const;
 
      */
     qreal hoverOpacity() const;
 

-    const KItemListWidgetInformant* informant() const;
+    int hoverSequenceIndex() const;
+
+    const KItemListWidgetInformant *informant() const;

 
 

-private slots:
-    void slotHoverAnimationFinished();
+private Q_SLOTS:
+    void slotHoverSequenceTimerTimeout();

 
 private:
     void initializeSelectionToggle();
     void setHoverOpacity(qreal opacity);
 
 private:
     void initializeSelectionToggle();
     void setHoverOpacity(qreal opacity);

-    void clearHoverCache();
-    void drawItemStyleOption(QPainter* painter, QWidget* widget, QStyle::State styleState);
+    void drawItemStyleOption(QPainter *painter, QWidget *widget, QStyle::State styleState);

 
 private:
 
 private:

-    Q_PROPERTY(qreal hoverOpacity READ hoverOpacity WRITE setHoverOpacity)
-
-    KItemListWidgetInformant* m_informant;
+    KItemListWidgetInformant *m_informant;

     int m_index;
     bool m_selected;
     bool m_current;
     bool m_hovered;
     int m_index;
     bool m_selected;
     bool m_current;
     bool m_hovered;

+    bool m_expansionAreaHovered;

     bool m_alternateBackground;
     bool m_enabledSelectionToggle;
     bool m_alternateBackground;
     bool m_enabledSelectionToggle;

+    bool m_clickHighlighted;

     QHash<QByteArray, QVariant> m_data;
     QList<QByteArray> m_visibleRoles;
     QHash<QByteArray, qreal> m_columnWidths;
     QHash<QByteArray, QVariant> m_data;
     QList<QByteArray> m_visibleRoles;
     QHash<QByteArray, qreal> m_columnWidths;

+    qreal m_leftPadding;
+    qreal m_rightPadding;

     KItemListStyleOption m_styleOption;
     QBitArray m_siblingsInfo;
 
     qreal m_hoverOpacity;
     KItemListStyleOption m_styleOption;
     QBitArray m_siblingsInfo;
 
     qreal m_hoverOpacity;

-    mutable QPixmap* m_hoverCache;
-    QPropertyAnimation* m_hoverAnimation;
+    mutable QPixmap *m_hoverCache;

 
 

-    KItemListSelectionToggle* m_selectionToggle;
+    int m_hoverSequenceIndex;
+    QTimer m_hoverSequenceTimer;
+
+    KItemListSelectionToggle *m_selectionToggle;

 
     QByteArray m_editedRole;
 
     QByteArray m_editedRole;

+    int m_iconSize;

 };
 
 };
 

-inline const KItemListWidgetInformant* KItemListWidget::informant() const
+inline const KItemListWidgetInformant *KItemListWidget::informant() const

 {
     return m_informant;
 }
 
 #endif
 {
     return m_informant;
 }
 
 #endif

-
-