X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/6bcdb624291f98dbbdb0a30477689bdb89dd70e8..0464ea82a6850f58805bc4d6fc1df5369d83c3df:/src/kitemviews/kitemlistwidget.h diff --git a/src/kitemviews/kitemlistwidget.h b/src/kitemviews/kitemlistwidget.h index 66b2da069..0e07d7ab5 100644 --- a/src/kitemviews/kitemlistwidget.h +++ b/src/kitemviews/kitemlistwidget.h @@ -1,23 +1,10 @@ -/*************************************************************************** - * Copyright (C) 2011 by Peter Penz * - * * - * Based on the Itemviews NG project from Trolltech Labs * - * * - * 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 + * + * Based on the Itemviews NG project from Trolltech Labs + * + * SPDX-License-Identifier: GPL-2.0-or-later + */ #ifndef KITEMLISTWIDGET_H #define KITEMLISTWIDGET_H @@ -28,13 +15,15 @@ #include #include #include +#include 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 @@ -47,11 +36,9 @@ public: KItemListWidgetInformant(); virtual ~KItemListWidgetInformant(); - virtual void calculateItemSizeHints(QVector& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const = 0; + virtual void calculateItemSizeHints(QVector> &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; }; /** @@ -66,34 +53,39 @@ class DOLPHIN_EXPORT KItemListWidget : public QGraphicsWidget Q_OBJECT public: - KItemListWidget(KItemListWidgetInformant* informant, QGraphicsItem* parent); + KItemListWidget(KItemListWidgetInformant *informant, QGraphicsItem *parent); ~KItemListWidget() override; void setIndex(int index); int index() const; - void setData(const QHash& data, const QSet& roles = QSet()); + void setData(const QHash &data, const QSet &roles = QSet()); QHash 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 */ - 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& roles); + void setVisibleRoles(const QList &roles); QList 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 setSidePadding(qreal leftPaddingWidth, qreal rightPaddingWidth); + qreal leftPadding() const; + qreal rightPadding() const; - void setStyleOption(const KItemListStyleOption& option); - const KItemListStyleOption& styleOption() const; + void setStyleOption(const KItemListStyleOption &option); + const KItemListStyleOption &styleOption() const; // TODO: Hides QGraphicsItem::setSelected()/isSelected(). Replace // this by using the default mechanism. @@ -106,7 +98,10 @@ public: void setHovered(bool hovered); bool isHovered() const; - void setHoverPosition(const QPointF& pos); + void setExpansionAreaHovered(bool hover); + bool expansionAreaHovered() const; + + void setHoverPosition(const QPointF &pos); void setAlternateBackground(bool enable); bool alternateBackground() const; @@ -121,7 +116,7 @@ public: * 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; /** @@ -131,16 +126,23 @@ public: * the role is empty. Derived classes must implement * editedRoleChanged(). */ - void setEditedRole(const QByteArray& role); + void setEditedRole(const QByteArray &role); QByteArray editedRole() const; + /** + * Contains the actual icon size used to draw the icon. + * Also used during icon resizing animation. + */ + void setIconSize(int iconSize); + int iconSize() const; + /** * @return True if \a point is inside KItemListWidget::hoverRect(), * KItemListWidget::textRect(), KItemListWidget::selectionToggleRect() * or KItemListWidget::expansionToggleRect(). * @reimp */ - bool contains(const QPointF& point) const override; + bool contains(const QPointF &point) const override; /** * @return Rectangle for the area that shows the icon. @@ -184,24 +186,50 @@ public: * @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); + + /** + * 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); -signals: - void roleEditingCanceled(int index, const QByteArray& role, const QVariant& value); - void roleEditingFinished(int index, const QByteArray& role, const QVariant& value); +Q_SIGNALS: + void roleEditingCanceled(int index, const QByteArray &role, const QVariant &value); + void roleEditingFinished(int index, const QByteArray &role, const QVariant &value); protected: - virtual void dataChanged(const QHash& current, const QSet& roles = QSet()); - virtual void visibleRolesChanged(const QList& current, const QList& 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 ¤t, const QSet &roles = QSet()); + virtual void visibleRolesChanged(const QList ¤t, const QList &previous); + virtual void columnWidthChanged(const QByteArray &role, qreal current, qreal previous); + virtual void sidePaddingChanged(qreal leftPaddingWidth, qreal rightPaddingWidth); + virtual void styleOptionChanged(const KItemListStyleOption ¤t, 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 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 ¤t, const QBitArray &previous); + virtual void editedRoleChanged(const QByteArray ¤t, 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 @@ -209,47 +237,50 @@ protected: */ qreal hoverOpacity() const; - const KItemListWidgetInformant* informant() const; + int hoverSequenceIndex() const; -private slots: - void slotHoverAnimationFinished(); + const KItemListWidgetInformant *informant() const; + +private Q_SLOTS: + void slotHoverSequenceTimerTimeout(); 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: - 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; + bool m_expansionAreaHovered; bool m_alternateBackground; bool m_enabledSelectionToggle; QHash m_data; QList m_visibleRoles; QHash m_columnWidths; + qreal m_leftPadding; + qreal m_rightPadding; 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; + int m_iconSize; }; -inline const KItemListWidgetInformant* KItemListWidget::informant() const +inline const KItemListWidgetInformant *KItemListWidget::informant() const { return m_informant; } #endif - -