src/kitemviews/kstandarditemlistwidget.h

   1 /*
   2  * SPDX-FileCopyrightText: 2012 Peter Penz <peter.penz19@gmail.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-or-later
   5  */
   6
   7 #ifndef KSTANDARDITEMLISTWIDGET_H
   8 #define KSTANDARDITEMLISTWIDGET_H
   9
  10 #include "dolphin_export.h"
  11 #include "kitemviews/kitemlistwidget.h"
  12
  13 #include <QPixmap>
  14 #include <QPointF>
  15 #include <QStaticText>
  16
  17 class KItemListRoleEditor;
  18 class KItemListStyleOption;
  19 class KItemListView;
  20
  21 class DOLPHIN_EXPORT KStandardItemListWidgetInformant : public KItemListWidgetInformant
  22 {
  23 public:
  24     KStandardItemListWidgetInformant();
  25     ~KStandardItemListWidgetInformant() override;
  26
  27     void calculateItemSizeHints(QVector<std::pair<qreal /* height */, bool /* isElided */>> &logicalHeightHints,
  28                                 qreal &logicalWidthHint,
  29                                 const KItemListView *view) const override;
  30
  31     qreal preferredRoleColumnWidth(const QByteArray &role, int index, const KItemListView *view) const override;
  32
  33 protected:
  34     /**
  35      * @return The value of the "text" role. The default implementation returns
  36      *         view->model()->data(index)["text"]. If a derived class can
  37      *         prevent the (possibly expensive) construction of the
  38      *         QHash<QByteArray, QVariant> returned by KItemModelBase::data(int),
  39      *         it can reimplement this function.
  40      */
  41     virtual QString itemText(int index, const KItemListView *view) const;
  42
  43     /**
  44      * @return The value of the "isLink" role. The default implementation returns false.
  45      *         The derived class should reimplement this function, when information about
  46      *         links is available and in usage.
  47      */
  48     virtual bool itemIsLink(int index, const KItemListView *view) const;
  49
  50     /**
  51      * @return String representation of the role \a role. The representation of
  52      *         a role might depend on other roles, so the values of all roles
  53      *         are passed as parameter.
  54      */
  55     virtual QString roleText(const QByteArray &role, const QHash<QByteArray, QVariant> &values) const;
  56
  57     /**
  58     * @return A font based on baseFont which is customized for symlinks.
  59     */
  60     virtual QFont customizedFontForLinks(const QFont &baseFont) const;
  61
  62     void calculateIconsLayoutItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints, qreal &logicalWidthHint, const KItemListView *view) const;
  63     void calculateCompactLayoutItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints, qreal &logicalWidthHint, const KItemListView *view) const;
  64     void calculateDetailsLayoutItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints, qreal &logicalWidthHint, const KItemListView *view) const;
  65
  66     friend class KStandardItemListWidget; // Accesses roleText()
  67 };
  68
  69 /**
  70  * @brief ItemList widget implementation for KStandardItemListView and KStandardItemModel.
  71  */
  72 class DOLPHIN_EXPORT KStandardItemListWidget : public KItemListWidget
  73 {
  74     Q_OBJECT
  75
  76 public:
  77     enum Layout { IconsLayout, CompactLayout, DetailsLayout };
  78
  79     KStandardItemListWidget(KItemListWidgetInformant *informant, QGraphicsItem *parent);
  80     ~KStandardItemListWidget() override;
  81
  82     void setLayout(Layout layout);
  83     Layout layout() const;
  84
  85     void setHighlightEntireRow(bool highlightEntireRow);
  86     bool highlightEntireRow() const;
  87
  88     void setSupportsItemExpanding(bool supportsItemExpanding);
  89     bool supportsItemExpanding() const;
  90
  91     void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr) override;
  92
  93     QRectF iconRect() const override;
  94     QRectF textRect() const override;
  95     QRectF textFocusRect() const override;
  96     QRectF selectionRect() const override;
  97     QRectF expansionToggleRect() const override;
  98     QRectF selectionToggleRect() const override;
  99     QPixmap createDragPixmap(const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr) override;
 100
 101     static KItemListWidgetInformant *createInformant();
 102
 103 protected:
 104     /**
 105      * Invalidates the cache which results in calling KStandardItemListWidget::refreshCache() as
 106      * soon as the item need to gets repainted.
 107      */
 108     void invalidateCache();
 109
 110     /**
 111      * Invalidates the icon cache which results in calling KStandardItemListWidget::refreshCache() as
 112      * soon as the item needs to get repainted.
 113      */
 114     void invalidateIconCache();
 115
 116     /**
 117      * Is called if the cache got invalidated by KStandardItemListWidget::invalidateCache().
 118      * The default implementation is empty.
 119      */
 120     virtual void refreshCache();
 121
 122     /**
 123      * @return True if the give role should be right aligned when showing it inside a column.
 124      *         Per default false is returned.
 125      */
 126     virtual bool isRoleRightAligned(const QByteArray &role) const;
 127
 128     /**
 129      * @return True if the item should be visually marked as hidden item. Per default
 130      *         false is returned.
 131      */
 132     virtual bool isHidden() const;
 133
 134     /**
 135      * @return A font based on baseFont which is customized according to the data shown in the widget.
 136      */
 137     virtual QFont customizedFont(const QFont &baseFont) const;
 138
 139     virtual QPalette::ColorRole normalTextColorRole() const;
 140
 141     void setTextColor(const QColor &color);
 142     QColor textColor(const QWidget &widget) const;
 143
 144     void setOverlay(const QPixmap &overlay);
 145     QPixmap overlay() const;
 146
 147     /**
 148      * @see KStandardItemListWidgetInformant::roleText().
 149      */
 150     QString roleText(const QByteArray &role, const QHash<QByteArray, QVariant> &values) const;
 151
 152     /**
 153      * Fixes:
 154      * Select the text without MIME-type extension
 155      * This is file-item-specific and should be moved
 156      * into KFileItemListWidget.
 157      *
 158      * Inherited classes can define, if the MIME-type extension
 159      * should be selected or not.
 160      *
 161      * @return Selection length (with or without MIME-type extension)
 162      */
 163     virtual int selectionLength(const QString &text) const;
 164
 165     void dataChanged(const QHash<QByteArray, QVariant> &current, const QSet<QByteArray> &roles = QSet<QByteArray>()) override;
 166     void visibleRolesChanged(const QList<QByteArray> &current, const QList<QByteArray> &previous) override;
 167     void columnWidthChanged(const QByteArray &role, qreal current, qreal previous) override;
 168     void sidePaddingChanged(qreal width) override;
 169     void styleOptionChanged(const KItemListStyleOption &current, const KItemListStyleOption &previous) override;
 170     void hoveredChanged(bool hovered) override;
 171     void selectedChanged(bool selected) override;
 172     void siblingsInformationChanged(const QBitArray &current, const QBitArray &previous) override;
 173     void editedRoleChanged(const QByteArray &current, const QByteArray &previous) override;
 174     void iconSizeChanged(int current, int previous) override;
 175     void resizeEvent(QGraphicsSceneResizeEvent *event) override;
 176     void showEvent(QShowEvent *event) override;
 177     void hideEvent(QHideEvent *event) override;
 178     bool event(QEvent *event) override;
 179
 180     struct TextInfo {
 181         QPointF pos;
 182         QStaticText staticText;
 183     };
 184     void updateAdditionalInfoTextColor();
 185
 186 public Q_SLOTS:
 187     void finishRoleEditing();
 188
 189 private Q_SLOTS:
 190     void slotCutItemsChanged();
 191     void slotRoleEditingCanceled(const QByteArray &role, const QVariant &value);
 192     void slotRoleEditingFinished(const QByteArray &role, const QVariant &value);
 193
 194 private:
 195     void triggerCacheRefreshing();
 196     void updateExpansionArea();
 197     void updatePixmapCache();
 198
 199     void updateTextsCache();
 200     void updateIconsLayoutTextCache();
 201     void updateCompactLayoutTextCache();
 202     void updateDetailsLayoutTextCache();
 203
 204     void drawPixmap(QPainter *painter, const QPixmap &pixmap);
 205     void drawSiblingsInformation(QPainter *painter);
 206
 207     QRectF roleEditingRect(const QByteArray &role) const;
 208
 209     QString elideRightKeepExtension(const QString &text, int elidingWidth) const;
 210
 211     /**
 212      * Closes the role editor and returns the focus back
 213      * to the KItemListContainer.
 214      */
 215     void closeRoleEditor();
 216
 217     QPixmap pixmapForIcon(const QString &name, const QStringList &overlays, int size, QIcon::Mode mode) const;
 218
 219     /**
 220      * @return Preferred size of the rating-image based on the given
 221      *         style-option. The height of the font is taken as
 222      *         reference.
 223      */
 224     static QSizeF preferredRatingSize(const KItemListStyleOption &option);
 225
 226     /**
 227      * @return Horizontal padding in pixels that is added to the required width of
 228      *         a column to display the content.
 229      */
 230     static qreal columnPadding(const KItemListStyleOption &option);
 231
 232 protected:
 233     QHash<QByteArray, TextInfo *> m_textInfo; // PlacesItemListWidget needs to access this
 234
 235 private:
 236     bool m_isCut;
 237     bool m_isHidden;
 238     QFont m_customizedFont;
 239     QFontMetrics m_customizedFontMetrics;
 240     bool m_isExpandable;
 241     bool m_highlightEntireRow;
 242     bool m_supportsItemExpanding;
 243
 244     bool m_dirtyLayout;
 245     bool m_dirtyContent;
 246     QSet<QByteArray> m_dirtyContentRoles;
 247
 248     Layout m_layout;
 249     QPointF m_pixmapPos;
 250     QPixmap m_pixmap;
 251     QSize m_scaledPixmapSize; //Size of the pixmap in device independent pixels
 252
 253     qreal m_columnWidthSum;
 254     QRectF m_iconRect; // Cache for KItemListWidget::iconRect()
 255     QPixmap m_hoverPixmap; // Cache for modified m_pixmap when hovering the item
 256
 257     QRectF m_textRect;
 258
 259     QList<QByteArray> m_sortedVisibleRoles;
 260
 261     QRectF m_expansionArea;
 262
 263     QColor m_customTextColor;
 264     QColor m_additionalInfoTextColor;
 265
 266     QPixmap m_overlay;
 267     QPixmap m_rating;
 268
 269     KItemListRoleEditor *m_roleEditor;
 270     KItemListRoleEditor *m_oldRoleEditor;
 271
 272     friend class KStandardItemListWidgetInformant; // Accesses private static methods to be able to
 273                                                    // share a common layout calculation
 274 };
 275
 276 #endif