src/kitemviews/kitemlistwidget.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 KITEMLISTWIDGET_H
  10 #define KITEMLISTWIDGET_H
  11
  12 #include "dolphin_export.h"
  13 #include "kitemviews/kitemliststyleoption.h"
  14
  15 #include <QBitArray>
  16 #include <QGraphicsWidget>
  17 #include <QStyle>
  18 #include <QTimer>
  19
  20 class KItemListSelectionToggle;
  21 class KItemListView;
  22 class QPropertyAnimation;
  23
  24 /**
  25  * @brief Provides information for creating an instance of KItemListWidget.
  26  *
  27  * KItemListView only creates KItemListWidget instances for the visible
  28  * area. For calculating the required size of all items the expected
  29  * size for the invisible items must be accessible. KItemListWidgetInformant
  30  * provides this information.
  31  */
  32 class DOLPHIN_EXPORT KItemListWidgetInformant
  33 {
  34 public:
  35     KItemListWidgetInformant();
  36     virtual ~KItemListWidgetInformant();
  37
  38     virtual void calculateItemSizeHints(QVector<std::pair<qreal, bool>>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const = 0;
  39
  40     virtual qreal preferredRoleColumnWidth(const QByteArray& role,
  41                                            int index,
  42                                            const KItemListView* view) const = 0;
  43 };
  44
  45 /**
  46  * @brief Widget that shows a visible item from the model.
  47  *
  48  * For showing an item from a custom model it is required to at least overwrite KItemListWidget::paint().
  49  * All properties are set by KItemListView, for each property there is a corresponding
  50  * virtual protected method that allows to react on property changes.
  51  */
  52 class DOLPHIN_EXPORT KItemListWidget : public QGraphicsWidget
  53 {
  54     Q_OBJECT
  55
  56 public:
  57     KItemListWidget(KItemListWidgetInformant* informant, QGraphicsItem* parent);
  58     ~KItemListWidget() override;
  59
  60     void setIndex(int index);
  61     int index() const;
  62
  63     void setData(const QHash<QByteArray, QVariant>& data, const QSet<QByteArray>& roles = QSet<QByteArray>());
  64     QHash<QByteArray, QVariant> data() const;
  65
  66     /**
  67      * Draws the hover-rectangle if the item is hovered. Overwrite this method
  68      * to show the data of the custom model provided by KItemListWidget::data().
  69      * @reimp
  70      */
  71     void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = nullptr) override;
  72
  73     void setVisibleRoles(const QList<QByteArray>& roles);
  74     QList<QByteArray> visibleRoles() const;
  75
  76     /**
  77      * Sets the width of a role that should be used if the alignment of the content
  78      * should be done in columns.
  79      */
  80     void setColumnWidth(const QByteArray& role, qreal width);
  81     qreal columnWidth(const QByteArray& role) const;
  82
  83     void setLeadingPadding(qreal width);
  84     qreal leadingPadding() const;
  85
  86     void setStyleOption(const KItemListStyleOption& option);
  87     const KItemListStyleOption& styleOption() const;
  88
  89     // TODO: Hides QGraphicsItem::setSelected()/isSelected(). Replace
  90     // this by using the default mechanism.
  91     void setSelected(bool selected);
  92     bool isSelected() const;
  93
  94     void setCurrent(bool current);
  95     bool isCurrent() const;
  96
  97     void setHovered(bool hovered);
  98     bool isHovered() const;
  99
 100     void setExpansionAreaHovered(bool hover);
 101     bool expansionAreaHovered() const;
 102
 103     void setHoverPosition(const QPointF& pos);
 104
 105     void setAlternateBackground(bool enable);
 106     bool alternateBackground() const;
 107
 108     void setEnabledSelectionToggle(bool enabled);
 109     bool enabledSelectionToggle() const;
 110
 111     /**
 112      * Sets the sibling information for the item and all of its parents.
 113      * The sibling information of the upper most parent is represented by
 114      * the first bit, the sibling information of the item by the last bit.
 115      * The sibling information is useful for drawing the branches in
 116      * tree views.
 117      */
 118     void setSiblingsInformation(const QBitArray& siblings);
 119     QBitArray siblingsInformation() const;
 120
 121     /**
 122      * Allows the user to edit the role \a role. The signals
 123      * roleEditingCanceled() or roleEditingFinished() will be
 124      * emitted after editing. An ongoing editing gets canceled if
 125      * the role is empty. Derived classes must implement
 126      * editedRoleChanged().
 127      */
 128     void setEditedRole(const QByteArray& role);
 129     QByteArray editedRole() const;
 130
 131     /**
 132      * @return True if \a point is inside KItemListWidget::hoverRect(),
 133      *         KItemListWidget::textRect(), KItemListWidget::selectionToggleRect()
 134      *         or KItemListWidget::expansionToggleRect().
 135      * @reimp
 136      */
 137     bool contains(const QPointF& point) const override;
 138
 139     /**
 140      * @return Rectangle for the area that shows the icon.
 141      */
 142     virtual QRectF iconRect() const = 0;
 143
 144     /**
 145      * @return Rectangle for the area that contains the text-properties.
 146      */
 147     virtual QRectF textRect() const = 0;
 148
 149     /**
 150      * @return Focus rectangle for indicating the current item. Per default
 151      *         textRect() will be returned. Overwrite this method if textRect()
 152      *         provides a larger rectangle than the actual text (e.g. to
 153      *         be aligned with the iconRect()). The textFocusRect() may not be
 154      *         outside the boundaries of textRect().
 155      */
 156     virtual QRectF textFocusRect() const;
 157
 158     /**
 159      * @return Rectangle around which a selection box should be drawn if the item is selected.
 160      */
 161     virtual QRectF selectionRect() const = 0;
 162
 163     /**
 164      * @return Rectangle for the selection-toggle that is used to select or deselect an item.
 165      *         Per default an empty rectangle is returned which means that no selection-toggle
 166      *         is available.
 167      */
 168     virtual QRectF selectionToggleRect() const;
 169
 170     /**
 171      * @return Rectangle for the expansion-toggle that is used to open a sub-tree of the model.
 172      *         Per default an empty rectangle is returned which means that no opening of sub-trees
 173      *         is supported.
 174      */
 175     virtual QRectF expansionToggleRect() const;
 176
 177     /**
 178      * @return Pixmap that is used when dragging an item. Per default the current state of the
 179      *         widget is returned as pixmap.
 180      */
 181     virtual QPixmap createDragPixmap(const QStyleOptionGraphicsItem* option, QWidget* widget = nullptr);
 182
 183 Q_SIGNALS:
 184     void roleEditingCanceled(int index, const QByteArray& role, const QVariant& value);
 185     void roleEditingFinished(int index, const QByteArray& role, const QVariant& value);
 186
 187 protected:
 188     virtual void dataChanged(const QHash<QByteArray, QVariant>& current, const QSet<QByteArray>& roles = QSet<QByteArray>());
 189     virtual void visibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous);
 190     virtual void columnWidthChanged(const QByteArray& role, qreal current, qreal previous);
 191     virtual void leadingPaddingChanged(qreal width);
 192     virtual void styleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous);
 193     virtual void currentChanged(bool current);
 194     virtual void selectedChanged(bool selected);
 195     virtual void hoveredChanged(bool hovered);
 196     virtual void alternateBackgroundChanged(bool enabled);
 197     virtual void siblingsInformationChanged(const QBitArray& current, const QBitArray& previous);
 198     virtual void editedRoleChanged(const QByteArray& current, const QByteArray& previous);
 199     void resizeEvent(QGraphicsSceneResizeEvent* event) override;
 200     void clearHoverCache();
 201
 202     /**
 203      * Called when the user starts hovering this item.
 204      */
 205     virtual void hoverSequenceStarted();
 206
 207     /**
 208      * Called in regular intervals while the user is hovering this item.
 209      *
 210      * @param sequenceIndex An index that increases over time while the user hovers.
 211      */
 212     virtual void hoverSequenceIndexChanged(int sequenceIndex);
 213
 214     /**
 215      * Called when the user stops hovering this item.
 216      */
 217     virtual void hoverSequenceEnded();
 218
 219     /**
 220      * @return The current opacity of the hover-animation. When implementing a custom painting-code for a hover-state
 221      *         this opacity value should be respected.
 222      */
 223     qreal hoverOpacity() const;
 224
 225     int hoverSequenceIndex() const;
 226
 227     const KItemListWidgetInformant* informant() const;
 228
 229 private Q_SLOTS:
 230     void slotHoverAnimationFinished();
 231     void slotHoverSequenceTimerTimeout();
 232
 233 private:
 234     void initializeSelectionToggle();
 235     void setHoverOpacity(qreal opacity);
 236     void drawItemStyleOption(QPainter* painter, QWidget* widget, QStyle::State styleState);
 237
 238 private:
 239     Q_PROPERTY(qreal hoverOpacity READ hoverOpacity WRITE setHoverOpacity)
 240
 241     KItemListWidgetInformant* m_informant;
 242     int m_index;
 243     bool m_selected;
 244     bool m_current;
 245     bool m_hovered;
 246     bool m_expansionAreaHovered;
 247     bool m_alternateBackground;
 248     bool m_enabledSelectionToggle;
 249     QHash<QByteArray, QVariant> m_data;
 250     QList<QByteArray> m_visibleRoles;
 251     QHash<QByteArray, qreal> m_columnWidths;
 252     qreal m_leadingPadding;
 253     KItemListStyleOption m_styleOption;
 254     QBitArray m_siblingsInfo;
 255
 256     qreal m_hoverOpacity;
 257     mutable QPixmap* m_hoverCache;
 258     QPropertyAnimation* m_hoverAnimation;
 259
 260     int m_hoverSequenceIndex;
 261     QTimer m_hoverSequenceTimer;
 262
 263     KItemListSelectionToggle* m_selectionToggle;
 264
 265     QByteArray m_editedRole;
 266 };
 267
 268 inline const KItemListWidgetInformant* KItemListWidget::informant() const
 269 {
 270     return m_informant;
 271 }
 272
 273 #endif
 274
 275