]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/kitemviews/kstandarditemlistwidget.h
Merge remote-tracking branch 'origin/master' into kf6
[dolphin.git] / src / kitemviews / kstandarditemlistwidget.h
index cb7364795237daf1245d499161a62f6536a69270..1313179c96703b52fdb13e63ebcacd5153781155 100644 (file)
@@ -1,28 +1,14 @@
-/***************************************************************************
- *   Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com>             *
- *                                                                         *
- *   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: 2012 Peter Penz <peter.penz19@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
 
 #ifndef KSTANDARDITEMLISTWIDGET_H
 #define KSTANDARDITEMLISTWIDGET_H
 
 #include "dolphin_export.h"
-
-#include <kitemviews/kitemlistwidget.h>
+#include "kitemviews/kitemlistwidget.h"
 
 #include <QPixmap>
 #include <QPointF>
@@ -36,13 +22,14 @@ class DOLPHIN_EXPORT KStandardItemListWidgetInformant : public KItemListWidgetIn
 {
 public:
     KStandardItemListWidgetInformant();
-    virtual ~KStandardItemListWidgetInformant();
+    ~KStandardItemListWidgetInformant() override;
+
+    void calculateItemSizeHints(QVector<std::pair<qreal /* height */, bool /* isElided */>> &logicalHeightHints,
+                                qreal &logicalWidthHint,
+                                const KItemListView *view) const override;
 
-    virtual void calculateItemSizeHints(QVector<qreal>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const Q_DECL_OVERRIDE;
+    qreal preferredRoleColumnWidth(const QByteArray &role, int index, const KItemListView *view) const override;
 
-    virtual qreal preferredRoleColumnWidth(const QByteArray& role,
-                                           int index,
-                                           const KItemListView* view) const Q_DECL_OVERRIDE;
 protected:
     /**
      * @return The value of the "text" role. The default implementation returns
@@ -51,70 +38,67 @@ protected:
      *         QHash<QByteArray, QVariant> returned by KItemModelBase::data(int),
      *         it can reimplement this function.
      */
-    virtual QString itemText(int index, const KItemListViewview) const;
+    virtual QString itemText(int index, const KItemListView *view) const;
 
     /**
      * @return The value of the "isLink" role. The default implementation returns false.
      *         The derived class should reimplement this function, when information about
      *         links is available and in usage.
      */
-    virtual bool itemIsLink(int index, const KItemListViewview) const;
+    virtual bool itemIsLink(int index, const KItemListView *view) const;
 
     /**
      * @return String representation of the role \a role. The representation of
      *         a role might depend on other roles, so the values of all roles
      *         are passed as parameter.
      */
-    virtual QString roleText(const QByteArray& role,
-                             const QHash<QByteArray, QVariant>& values) const;
+    virtual QString roleText(const QByteArray &role, const QHash<QByteArray, QVariant> &values) const;
 
     /**
     * @return A font based on baseFont which is customized for symlinks.
     */
-    virtual QFont customizedFontForLinks(const QFontbaseFont) const;
+    virtual QFont customizedFontForLinks(const QFont &baseFont) const;
 
-    void calculateIconsLayoutItemSizeHints(QVector<qreal>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const;
-    void calculateCompactLayoutItemSizeHints(QVector<qreal>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const;
-    void calculateDetailsLayoutItemSizeHints(QVector<qreal>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const;
+    void calculateIconsLayoutItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints, qreal &logicalWidthHint, const KItemListView *view) const;
+    void calculateCompactLayoutItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints, qreal &logicalWidthHint, const KItemListView *view) const;
+    void calculateDetailsLayoutItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints, qreal &logicalWidthHint, const KItemListView *view) const;
 
     friend class KStandardItemListWidget; // Accesses roleText()
 };
 
 /**
- * @brief Itemlist widget implementation for KStandardItemView and KStandardItemModel.
+ * @brief ItemList widget implementation for KStandardItemListView and KStandardItemModel.
  */
 class DOLPHIN_EXPORT KStandardItemListWidget : public KItemListWidget
 {
     Q_OBJECT
 
 public:
-    enum Layout
-    {
-        IconsLayout,
-        CompactLayout,
-        DetailsLayout
-    };
+    enum Layout { IconsLayout, CompactLayout, DetailsLayout };
 
-    KStandardItemListWidget(KItemListWidgetInformant* informant, QGraphicsItem* parent);
-    virtual ~KStandardItemListWidget();
+    KStandardItemListWidget(KItemListWidgetInformant *informant, QGraphicsItem *parent);
+    ~KStandardItemListWidget() override;
 
     void setLayout(Layout layout);
     Layout layout() const;
 
+    void setHighlightEntireRow(bool highlightEntireRow);
+    bool highlightEntireRow() const;
+
     void setSupportsItemExpanding(bool supportsItemExpanding);
     bool supportsItemExpanding() const;
 
-    virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = 0) override;
+    void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr) override;
 
-    virtual QRectF iconRect() const Q_DECL_OVERRIDE;
-    virtual QRectF textRect() const Q_DECL_OVERRIDE;
-    virtual QRectF textFocusRect() const Q_DECL_OVERRIDE;
-    virtual QRectF selectionRect() const Q_DECL_OVERRIDE;
-    virtual QRectF expansionToggleRect() const Q_DECL_OVERRIDE;
-    virtual QRectF selectionToggleRect() const Q_DECL_OVERRIDE;
-    virtual QPixmap createDragPixmap(const QStyleOptionGraphicsItem* option, QWidget* widget = 0) Q_DECL_OVERRIDE;
+    QRectF iconRect() const override;
+    QRectF textRect() const override;
+    QRectF textFocusRect() const override;
+    QRectF selectionRect() const override;
+    QRectF expansionToggleRect() const override;
+    QRectF selectionToggleRect() const override;
+    QPixmap createDragPixmap(const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr) override;
 
-    static KItemListWidgetInformantcreateInformant();
+    static KItemListWidgetInformant *createInformant();
 
 protected:
     /**
@@ -123,6 +107,12 @@ protected:
      */
     void invalidateCache();
 
+    /**
+     * Invalidates the icon cache which results in calling KStandardItemListWidget::refreshCache() as
+     * soon as the item needs to get repainted.
+     */
+    void invalidateIconCache();
+
     /**
      * Is called if the cache got invalidated by KStandardItemListWidget::invalidateCache().
      * The default implementation is empty.
@@ -133,7 +123,7 @@ protected:
      * @return True if the give role should be right aligned when showing it inside a column.
      *         Per default false is returned.
      */
-    virtual bool isRoleRightAligned(const QByteArrayrole) const;
+    virtual bool isRoleRightAligned(const QByteArray &role) const;
 
     /**
      * @return True if the item should be visually marked as hidden item. Per default
@@ -144,20 +134,20 @@ protected:
     /**
      * @return A font based on baseFont which is customized according to the data shown in the widget.
      */
-    virtual QFont customizedFont(const QFontbaseFont) const;
+    virtual QFont customizedFont(const QFont &baseFont) const;
 
     virtual QPalette::ColorRole normalTextColorRole() const;
 
-    void setTextColor(const QColorcolor);
-    QColor textColor() const;
+    void setTextColor(const QColor &color);
+    QColor textColor(const QWidget &widget) const;
 
-    void setOverlay(const QPixmapoverlay);
+    void setOverlay(const QPixmap &overlay);
     QPixmap overlay() const;
 
     /**
      * @see KStandardItemListWidgetInformant::roleText().
      */
-    QString roleText(const QByteArray& role, const QHash<QByteArray, QVariant>& values) const;
+    QString roleText(const QByteArray &role, const QHash<QByteArray, QVariant> &values) const;
 
     /**
      * Fixes:
@@ -170,28 +160,36 @@ protected:
      *
      * @return Selection length (with or without MIME-type extension)
      */
-    virtual int selectionLength(const QString& text) const;
-
-    virtual void dataChanged(const QHash<QByteArray, QVariant>& current, const QSet<QByteArray>& roles = QSet<QByteArray>()) Q_DECL_OVERRIDE;
-    virtual void visibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous) Q_DECL_OVERRIDE;
-    virtual void columnWidthChanged(const QByteArray& role, qreal current, qreal previous) Q_DECL_OVERRIDE;
-    virtual void styleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous) Q_DECL_OVERRIDE;
-    virtual void hoveredChanged(bool hovered) Q_DECL_OVERRIDE;
-    virtual void selectedChanged(bool selected) Q_DECL_OVERRIDE;
-    virtual void siblingsInformationChanged(const QBitArray& current, const QBitArray& previous) Q_DECL_OVERRIDE;
-    virtual void editedRoleChanged(const QByteArray& current, const QByteArray& previous) Q_DECL_OVERRIDE;
-    virtual void resizeEvent(QGraphicsSceneResizeEvent* event) Q_DECL_OVERRIDE;
-    virtual void showEvent(QShowEvent* event) Q_DECL_OVERRIDE;
-    virtual void hideEvent(QHideEvent* event) Q_DECL_OVERRIDE;
-    bool event(QEvent *event) Q_DECL_OVERRIDE;
-
-public slots:
+    virtual int selectionLength(const QString &text) const;
+
+    void dataChanged(const QHash<QByteArray, QVariant> &current, const QSet<QByteArray> &roles = QSet<QByteArray>()) override;
+    void visibleRolesChanged(const QList<QByteArray> &current, const QList<QByteArray> &previous) override;
+    void columnWidthChanged(const QByteArray &role, qreal current, qreal previous) override;
+    void sidePaddingChanged(qreal width) override;
+    void styleOptionChanged(const KItemListStyleOption &current, const KItemListStyleOption &previous) override;
+    void hoveredChanged(bool hovered) override;
+    void selectedChanged(bool selected) override;
+    void siblingsInformationChanged(const QBitArray &current, const QBitArray &previous) override;
+    void editedRoleChanged(const QByteArray &current, const QByteArray &previous) override;
+    void iconSizeChanged(int current, int previous) override;
+    void resizeEvent(QGraphicsSceneResizeEvent *event) override;
+    void showEvent(QShowEvent *event) override;
+    void hideEvent(QHideEvent *event) override;
+    bool event(QEvent *event) override;
+
+    struct TextInfo {
+        QPointF pos;
+        QStaticText staticText;
+    };
+    void updateAdditionalInfoTextColor();
+
+public Q_SLOTS:
     void finishRoleEditing();
 
-private slots:
+private Q_SLOTS:
     void slotCutItemsChanged();
-    void slotRoleEditingCanceled(const QByteArray& role, const QVariant& value);
-    void slotRoleEditingFinished(const QByteArray& role, const QVariant& value);
+    void slotRoleEditingCanceled(const QByteArray &role, const QVariant &value);
+    void slotRoleEditingFinished(const QByteArray &role, const QVariant &value);
 
 private:
     void triggerCacheRefreshing();
@@ -203,33 +201,36 @@ private:
     void updateCompactLayoutTextCache();
     void updateDetailsLayoutTextCache();
 
-    void updateAdditionalInfoTextColor();
-
-    void drawPixmap(QPainter* painter, const QPixmap& pixmap);
-    void drawSiblingsInformation(QPainter* painter);
+    void drawPixmap(QPainter *painter, const QPixmap &pixmap);
+    void drawSiblingsInformation(QPainter *painter);
 
     QRectF roleEditingRect(const QByteArray &role) const;
 
+    QString elideRightKeepExtension(const QString &text, int elidingWidth) const;
+
     /**
      * Closes the role editor and returns the focus back
      * to the KItemListContainer.
      */
     void closeRoleEditor();
 
-    static QPixmap pixmapForIcon(const QString& name, const QStringList& overlays, int size, QIcon::Mode mode);
+    QPixmap pixmapForIcon(const QString &name, const QStringList &overlays, int size, QIcon::Mode mode) const;
 
     /**
      * @return Preferred size of the rating-image based on the given
      *         style-option. The height of the font is taken as
      *         reference.
      */
-    static QSizeF preferredRatingSize(const KItemListStyleOptionoption);
+    static QSizeF preferredRatingSize(const KItemListStyleOption &option);
 
     /**
      * @return Horizontal padding in pixels that is added to the required width of
      *         a column to display the content.
      */
-    static qreal columnPadding(const KItemListStyleOption& option);
+    static qreal columnPadding(const KItemListStyleOption &option);
+
+protected:
+    QHash<QByteArray, TextInfo *> m_textInfo; // PlacesItemListWidget needs to access this
 
 private:
     bool m_isCut;
@@ -237,6 +238,7 @@ private:
     QFont m_customizedFont;
     QFontMetrics m_customizedFontMetrics;
     bool m_isExpandable;
+    bool m_highlightEntireRow;
     bool m_supportsItemExpanding;
 
     bool m_dirtyLayout;
@@ -248,15 +250,9 @@ private:
     QPixmap m_pixmap;
     QSize m_scaledPixmapSize; //Size of the pixmap in device independent pixels
 
-    QRectF m_iconRect;          // Cache for KItemListWidget::iconRect()
-    QPixmap m_hoverPixmap;      // Cache for modified m_pixmap when hovering the item
-
-    struct TextInfo
-    {
-        QPointF pos;
-        QStaticText staticText;
-    };
-    QHash<QByteArray, TextInfo*> m_textInfo;
+    qreal m_columnWidthSum;
+    QRectF m_iconRect; // Cache for KItemListWidget::iconRect()
+    QPixmap m_hoverPixmap; // Cache for modified m_pixmap when hovering the item
 
     QRectF m_textRect;
 
@@ -270,8 +266,8 @@ private:
     QPixmap m_overlay;
     QPixmap m_rating;
 
-    KItemListRoleEditorm_roleEditor;
-    KItemListRoleEditorm_oldRoleEditor;
+    KItemListRoleEditor *m_roleEditor;
+    KItemListRoleEditor *m_oldRoleEditor;
 
     friend class KStandardItemListWidgetInformant; // Accesses private static methods to be able to
                                                    // share a common layout calculation