]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/kitemviews/kstandarditemlistwidget.cpp
Full row highlight implementation
[dolphin.git] / src / kitemviews / kstandarditemlistwidget.cpp
index 3faf786c9e809c12a81d8cfea4981325cca8d1a7..b17fac6d55568fef1a6aa508c3658ccadce446a2 100644 (file)
@@ -1,21 +1,8 @@
-/***************************************************************************
- *   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
+ */
 
 #include "kstandarditemlistwidget.h"
 
@@ -30,6 +17,7 @@
 #include <KRatingPainter>
 #include <KStringHandler>
 
+#include <QApplication>
 #include <QGraphicsScene>
 #include <QGraphicsSceneResizeEvent>
 #include <QGraphicsView>
@@ -48,7 +36,7 @@ KStandardItemListWidgetInformant::~KStandardItemListWidgetInformant()
 {
 }
 
-void KStandardItemListWidgetInformant::calculateItemSizeHints(QVector<qreal>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const
+void KStandardItemListWidgetInformant::calculateItemSizeHints(QVector<std::pair<qreal, bool>>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const
 {
     switch (static_cast<const KStandardItemListView*>(view)->itemLayout()) {
     case KStandardItemListView::IconsLayout:
@@ -133,7 +121,7 @@ QFont KStandardItemListWidgetInformant::customizedFontForLinks(const QFont& base
     return baseFont;
 }
 
-void KStandardItemListWidgetInformant::calculateIconsLayoutItemSizeHints(QVector<qreal>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const
+void KStandardItemListWidgetInformant::calculateIconsLayoutItemSizeHints(QVector<std::pair<qreal, bool>>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const
 {
     const KItemListStyleOption& option = view->styleOption();
     const QFont& normalFont = option.font;
@@ -150,7 +138,7 @@ void KStandardItemListWidgetInformant::calculateIconsLayoutItemSizeHints(QVector
     textOption.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere);
 
     for (int index = 0; index < logicalHeightHints.count(); ++index) {
-        if (logicalHeightHints.at(index) > 0.0) {
+        if (logicalHeightHints.at(index).first > 0.0) {
             continue;
         }
 
@@ -158,7 +146,7 @@ void KStandardItemListWidgetInformant::calculateIconsLayoutItemSizeHints(QVector
         const QFont& font = itemIsLink(index, view) ? linkFont : normalFont;
 
         const QString& text = KStringHandler::preProcessWrap(itemText(index, view));
-
+        
         // Calculate the number of lines required for wrapping the name
         qreal textHeight = 0;
         QTextLayout layout(text, font);
@@ -166,6 +154,7 @@ void KStandardItemListWidgetInformant::calculateIconsLayoutItemSizeHints(QVector
         layout.beginLayout();
         QTextLine line;
         int lineCount = 0;
+        bool isElided = false;
         while ((line = layout.createLine()).isValid()) {
             line.setLineWidth(maxWidth);
             line.naturalTextWidth();
@@ -173,6 +162,7 @@ void KStandardItemListWidgetInformant::calculateIconsLayoutItemSizeHints(QVector
 
             ++lineCount;
             if (lineCount == option.maxTextLines) {
+                isElided = layout.createLine().isValid();
                 break;
             }
         }
@@ -181,13 +171,14 @@ void KStandardItemListWidgetInformant::calculateIconsLayoutItemSizeHints(QVector
         // Add one line for each additional information
         textHeight += additionalRolesSpacing;
 
-        logicalHeightHints[index] = textHeight + spacingAndIconHeight;
+        logicalHeightHints[index].first = textHeight + spacingAndIconHeight;
+        logicalHeightHints[index].second = isElided;
     }
 
     logicalWidthHint = itemWidth;
 }
 
-void KStandardItemListWidgetInformant::calculateCompactLayoutItemSizeHints(QVector<qreal>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const
+void KStandardItemListWidgetInformant::calculateCompactLayoutItemSizeHints(QVector<std::pair<qreal, bool>>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const
 {
     const KItemListStyleOption& option = view->styleOption();
     const QFontMetrics& normalFontMetrics = option.fontMetrics;
@@ -202,7 +193,7 @@ void KStandardItemListWidgetInformant::calculateCompactLayoutItemSizeHints(QVect
     const QFontMetrics linkFontMetrics(customizedFontForLinks(option.font));
 
     for (int index = 0; index < logicalHeightHints.count(); ++index) {
-        if (logicalHeightHints.at(index) > 0.0) {
+        if (logicalHeightHints.at(index).first > 0.0) {
             continue;
         }
 
@@ -217,7 +208,7 @@ void KStandardItemListWidgetInformant::calculateCompactLayoutItemSizeHints(QVect
             maximumRequiredWidth = fontMetrics.horizontalAdvance(itemText(index, view));
         } else {
             const QHash<QByteArray, QVariant>& values = view->model()->data(index);
-            foreach (const QByteArray& role, visibleRoles) {
+            for (const QByteArray& role : visibleRoles) {
                 const QString& text = roleText(role, values);
                 const qreal requiredWidth = fontMetrics.horizontalAdvance(text);
                 maximumRequiredWidth = qMax(maximumRequiredWidth, requiredWidth);
@@ -229,22 +220,37 @@ void KStandardItemListWidgetInformant::calculateCompactLayoutItemSizeHints(QVect
             width = maxWidth;
         }
 
-        logicalHeightHints[index] = width;
+        logicalHeightHints[index].first = width;
     }
 
     logicalWidthHint = height;
 }
 
-void KStandardItemListWidgetInformant::calculateDetailsLayoutItemSizeHints(QVector<qreal>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const
+void KStandardItemListWidgetInformant::calculateDetailsLayoutItemSizeHints(QVector<std::pair<qreal, bool>>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const
 {
     const KItemListStyleOption& option = view->styleOption();
-    const qreal height = option.padding * 2 + qMax(option.iconSize, option.fontMetrics.height());
-    logicalHeightHints.fill(height);
+
+    float zoomLevel = 1;
+    if (option.iconSize >= KIconLoader::SizeEnormous) {
+        zoomLevel = 2;
+    } else if (option.iconSize >= KIconLoader::SizeHuge) {
+        zoomLevel = 1.8;
+    } else if (option.iconSize >= KIconLoader::SizeLarge) {
+        zoomLevel = 1.6;
+    } else if (option.iconSize >= KIconLoader::SizeMedium) {
+        zoomLevel = 1.4;
+    } else if (option.iconSize >= KIconLoader::SizeSmallMedium) {
+        zoomLevel = 1.2;
+    }
+
+    const qreal contentHeight = qMax<qreal>(option.iconSize, zoomLevel * option.fontMetrics.height());
+    logicalHeightHints.fill(std::make_pair(contentHeight + 2 * option.padding, false));
     logicalWidthHint = -1.0;
 }
 
 KStandardItemListWidget::KStandardItemListWidget(KItemListWidgetInformant* informant, QGraphicsItem* parent) :
     KItemListWidget(informant, parent),
+    m_textInfo(),
     m_isCut(false),
     m_isHidden(false),
     m_customizedFont(),
@@ -258,9 +264,9 @@ KStandardItemListWidget::KStandardItemListWidget(KItemListWidgetInformant* infor
     m_pixmapPos(),
     m_pixmap(),
     m_scaledPixmapSize(),
+    m_columnWidthSum(),
     m_iconRect(),
     m_hoverPixmap(),
-    m_textInfo(),
     m_textRect(),
     m_sortedVisibleRoles(),
     m_expansionArea(),
@@ -302,6 +308,18 @@ KStandardItemListWidget::Layout KStandardItemListWidget::layout() const
     return m_layout;
 }
 
+void KStandardItemListWidget::setHighlightEntireRow(bool highlightEntireRow) {
+    if (m_highlightEntireRow != highlightEntireRow) {
+        m_highlightEntireRow = highlightEntireRow;
+        m_dirtyLayout = true;
+        update();
+    }
+}
+
+bool KStandardItemListWidget::highlightEntireRow() const {
+    return m_highlightEntireRow;
+}
+
 void KStandardItemListWidget::setSupportsItemExpanding(bool supportsItemExpanding)
 {
     if (m_supportsItemExpanding != supportsItemExpanding) {
@@ -327,7 +345,7 @@ void KStandardItemListWidget::paint(QPainter* painter, const QStyleOptionGraphic
     }
 
     const KItemListStyleOption& itemListStyleOption = styleOption();
-    if (isHovered()) {
+    if (isHovered() && !m_pixmap.isNull()) {
         if (hoverOpacity() < 1.0) {
             /*
              * Linear interpolation between m_pixmap and m_hoverPixmap.
@@ -370,7 +388,7 @@ void KStandardItemListWidget::paint(QPainter* painter, const QStyleOptionGraphic
         } else {
             drawPixmap(painter, m_hoverPixmap);
         }
-    } else {
+    } else if (!m_pixmap.isNull()) {
         drawPixmap(painter, m_pixmap);
     }
 
@@ -503,7 +521,11 @@ QRectF KStandardItemListWidget::selectionRect() const
     case DetailsLayout: {
         const int padding = styleOption().padding;
         QRectF adjustedIconRect = iconRect().adjusted(-padding, -padding, padding, padding);
-        return adjustedIconRect | m_textRect;
+        QRectF result = adjustedIconRect | m_textRect;
+        if (m_highlightEntireRow) {
+            result.setRight(m_columnWidthSum + leadingPadding());
+        }
+        return result;
     }
 
     default:
@@ -594,6 +616,13 @@ void KStandardItemListWidget::invalidateCache()
     m_dirtyContent = true;
 }
 
+void KStandardItemListWidget::invalidateIconCache()
+{
+    m_dirtyContent = true;
+    m_dirtyContentRoles.insert("iconPixmap");
+    m_dirtyContentRoles.insert("iconOverlays");
+}
+
 void KStandardItemListWidget::refreshCache()
 {
 }
@@ -671,7 +700,8 @@ void KStandardItemListWidget::dataChanged(const QHash<QByteArray, QVariant>& cur
 
     QSet<QByteArray> dirtyRoles;
     if (roles.isEmpty()) {
-        dirtyRoles = visibleRoles().toSet();
+        const auto visibleRoles = this->visibleRoles();
+        dirtyRoles = QSet<QByteArray>(visibleRoles.constBegin(), visibleRoles.constEnd());
     } else {
         dirtyRoles = roles;
     }
@@ -712,6 +742,11 @@ void KStandardItemListWidget::columnWidthChanged(const QByteArray& role,
     m_dirtyLayout = true;
 }
 
+void KStandardItemListWidget::leadingPaddingChanged(qreal padding) {
+    Q_UNUSED(padding)
+    m_dirtyLayout = true;
+}
+
 void KStandardItemListWidget::styleOptionChanged(const KItemListStyleOption& current,
                                              const KItemListStyleOption& previous)
 {
@@ -753,7 +788,7 @@ void KStandardItemListWidget::editedRoleChanged(const QByteArray& current, const
     QGraphicsView* parent = scene()->views()[0];
     if (current.isEmpty() || !parent || current != "text") {
         if (m_roleEditor) {
-            emit roleEditingCanceled(index(), current, data().value(current));
+            Q_EMIT roleEditingCanceled(index(), current, data().value(current));
 
             disconnect(m_roleEditor, &KItemListRoleEditor::roleEditingCanceled,
                        this, &KStandardItemListWidget::slotRoleEditingCanceled);
@@ -776,6 +811,7 @@ void KStandardItemListWidget::editedRoleChanged(const QByteArray& current, const
 
     m_roleEditor = new KItemListRoleEditor(parent);
     m_roleEditor->setRole(current);
+    m_roleEditor->setAllowUpDownKeyChainEdit(m_layout != IconsLayout);
     m_roleEditor->setFont(styleOption().font);
 
     const QString text = data().value(current).toString();
@@ -878,7 +914,7 @@ void KStandardItemListWidget::slotRoleEditingCanceled(const QByteArray& role,
                                                       const QVariant& value)
 {
     closeRoleEditor();
-    emit roleEditingCanceled(index(), role, value);
+    Q_EMIT roleEditingCanceled(index(), role, value);
     setEditedRole(QByteArray());
 }
 
@@ -886,7 +922,7 @@ void KStandardItemListWidget::slotRoleEditingFinished(const QByteArray& role,
                                                       const QVariant& value)
 {
     closeRoleEditor();
-    emit roleEditingFinished(index(), role, value);
+    Q_EMIT roleEditingFinished(index(), role, value);
     setEditedRole(QByteArray());
 }
 
@@ -903,10 +939,13 @@ void KStandardItemListWidget::triggerCacheRefreshing()
     m_isHidden = isHidden();
     m_customizedFont = customizedFont(styleOption().font);
     m_customizedFontMetrics = QFontMetrics(m_customizedFont);
+    m_columnWidthSum = std::accumulate(m_sortedVisibleRoles.begin(), m_sortedVisibleRoles.end(),
+                                       qreal(), [this](qreal sum, const auto &role){ return sum + columnWidth(role); });
 
     updateExpansionArea();
     updateTextsCache();
     updatePixmapCache();
+    clearHoverCache();
 
     m_dirtyLayout = false;
     m_dirtyContent = false;
@@ -924,7 +963,8 @@ void KStandardItemListWidget::updateExpansionArea()
             const qreal inc = (widgetHeight - option.iconSize) / 2;
             const qreal x = expandedParentsCount * widgetHeight + inc;
             const qreal y = inc;
-            m_expansionArea = QRectF(x, y, option.iconSize, option.iconSize);
+            const qreal xPadding = m_highlightEntireRow ? leadingPadding() : 0;
+            m_expansionArea = QRectF(xPadding + x, y, option.iconSize, option.iconSize);
             return;
         }
     }
@@ -956,7 +996,34 @@ void KStandardItemListWidget::updatePixmapCache()
     }
 
     if (updatePixmap) {
-        m_pixmap = values["iconPixmap"].value<QPixmap>();
+        m_pixmap = QPixmap();
+
+        int sequenceIndex = hoverSequenceIndex();
+
+        if (values.contains("hoverSequencePixmaps")) {
+            // Use one of the hover sequence pixmaps instead of the default
+            // icon pixmap.
+
+            const QVector<QPixmap> pixmaps = values["hoverSequencePixmaps"].value<QVector<QPixmap>>();
+
+            if (values.contains("hoverSequenceWraparoundPoint")) {
+                const float wap = values["hoverSequenceWraparoundPoint"].toFloat();
+                if (wap >= 1.0f) {
+                    sequenceIndex %= static_cast<int>(wap);
+                }
+            }
+
+            const int loadedIndex = qMax(qMin(sequenceIndex, pixmaps.size()-1), 0);
+
+            if (loadedIndex != 0) {
+                m_pixmap = pixmaps[loadedIndex];
+            }
+        }
+
+        if (m_pixmap.isNull()) {
+            m_pixmap = values["iconPixmap"].value<QPixmap>();
+        }
+
         if (m_pixmap.isNull()) {
             // Use the icon that fits to the MIME-type
             QString iconName = values["iconName"].toString();
@@ -974,6 +1041,11 @@ void KStandardItemListWidget::updatePixmapCache()
             KPixmapModifier::scale(m_pixmap, QSize(maxIconWidth, maxIconHeight) * qApp->devicePixelRatio());
         }
 
+        if (m_pixmap.isNull()) {
+            m_hoverPixmap = QPixmap();
+            return;
+        }
+
         if (m_isCut) {
             KIconEffect* effect = KIconLoader::global()->iconEffect();
             m_pixmap = effect->apply(m_pixmap, KIconLoader::Desktop, KIconLoader::DisabledState);
@@ -986,6 +1058,10 @@ void KStandardItemListWidget::updatePixmapCache()
         if (m_layout == IconsLayout && isSelected()) {
             const QColor color = palette().brush(QPalette::Normal, QPalette::Highlight).color();
             QImage image = m_pixmap.toImage();
+            if (image.isNull()) {
+                m_hoverPixmap = QPixmap();
+                return;
+            }
             KIconEffect::colorize(image, color, 0.8f);
             m_pixmap = QPixmap::fromImage(image);
         }
@@ -1125,7 +1201,7 @@ QString KStandardItemListWidget::elideRightKeepExtension(const QString &text, in
             QString ret = m_customizedFontMetrics.elidedText(text.chopped(extensionLength),
                                                              Qt::ElideRight,
                                                              elidingWidth - extensionWidth);
-            ret.append(text.right(extensionLength));
+            ret.append(text.rightRef(extensionLength));
             return ret;
         }
     }
@@ -1217,7 +1293,7 @@ void KStandardItemListWidget::updateIconsLayoutTextCache()
 
     // Calculate the position for each additional information
     qreal y = nameTextInfo->pos.y() + nameHeight;
-    foreach (const QByteArray& role, m_sortedVisibleRoles) {
+    for (const QByteArray& role : qAsConst(m_sortedVisibleRoles)) {
         if (role == "text") {
             continue;
         }
@@ -1280,7 +1356,7 @@ void KStandardItemListWidget::updateCompactLayoutTextCache()
     const qreal x = option.padding * 3 + scaledIconSize;
     qreal y = qRound((widgetHeight - textLinesHeight) / 2);
     const qreal maxWidth = size().width() - x - option.padding;
-    foreach (const QByteArray& role, m_sortedVisibleRoles) {
+    for (const QByteArray& role : qAsConst(m_sortedVisibleRoles)) {
         const QString text = roleText(role, values);
         TextInfo* textInfo = m_textInfo.value(role);
         textInfo->staticText.setText(text);
@@ -1325,13 +1401,13 @@ void KStandardItemListWidget::updateDetailsLayoutTextCache()
     if (m_supportsItemExpanding) {
         firstColumnInc += (m_expansionArea.left() + m_expansionArea.right() + widgetHeight) / 2;
     } else {
-        firstColumnInc += option.padding;
+        firstColumnInc += option.padding + leadingPadding();
     }
 
     qreal x = firstColumnInc;
     const qreal y = qMax(qreal(option.padding), (widgetHeight - fontHeight) / 2);
 
-    foreach (const QByteArray& role, m_sortedVisibleRoles) {
+    for (const QByteArray& role : qAsConst(m_sortedVisibleRoles)) {
         QString text = roleText(role, values);
 
         // Elide the text in case it does not fit into the available column-width
@@ -1341,7 +1417,7 @@ void KStandardItemListWidget::updateDetailsLayoutTextCache()
 
         const bool isTextRole = (role == "text");
         if (isTextRole) {
-            availableTextWidth -= firstColumnInc;
+            availableTextWidth -= firstColumnInc - leadingPadding();
         }
 
         if (requiredWidth > availableTextWidth) {
@@ -1363,7 +1439,7 @@ void KStandardItemListWidget::updateDetailsLayoutTextCache()
 
             // The column after the name should always be aligned on the same x-position independent
             // from the expansion-level shown in the name column
-            x -= firstColumnInc;
+            x -= firstColumnInc - leadingPadding();
         } else if (isRoleRightAligned(role)) {
             textInfo->pos.rx() += roleWidth - requiredWidth - columnWidthInc;
         }
@@ -1375,8 +1451,11 @@ void KStandardItemListWidget::updateAdditionalInfoTextColor()
     QColor c1;
     if (m_customTextColor.isValid()) {
         c1 = m_customTextColor;
-    } else if (isSelected() && m_layout != DetailsLayout) {
-        c1 = styleOption().palette.highlightedText().color();
+    } else if (isSelected()) {
+        // The detail text colour needs to match the main text (HighlightedText) for the same level
+        // of readability. We short circuit early here to avoid interpolating with another colour.
+        m_additionalInfoTextColor = styleOption().palette.color(QPalette::HighlightedText);
+        return;
     } else {
         c1 = styleOption().palette.text().color();
     }
@@ -1415,15 +1494,15 @@ void KStandardItemListWidget::drawSiblingsInformation(QPainter* painter)
     const int x = (m_expansionArea.left() + m_expansionArea.right() - siblingSize) / 2;
     QRect siblingRect(x, 0, siblingSize, siblingSize);
 
-    QStyleOption option;
-    option.palette.setColor(QPalette::Text, option.palette.color(normalTextColorRole()));
     bool isItemSibling = true;
 
     const QBitArray siblings = siblingsInformation();
+    QStyleOption option;
+    const auto normalColor = option.palette.color(normalTextColorRole());
+    const auto highlightColor = option.palette.color(expansionAreaHovered() ? QPalette::Highlight : normalTextColorRole());
     for (int i = siblings.count() - 1; i >= 0; --i) {
         option.rect = siblingRect;
         option.state = siblings.at(i) ? QStyle::State_Sibling : QStyle::State_None;
-
         if (isItemSibling) {
             option.state |= QStyle::State_Item;
             if (m_isExpandable) {
@@ -1432,7 +1511,10 @@ void KStandardItemListWidget::drawSiblingsInformation(QPainter* painter)
             if (data().value("isExpanded").toBool()) {
                 option.state |= QStyle::State_Open;
             }
+            option.palette.setColor(QPalette::Text, highlightColor);
             isItemSibling = false;
+        } else {
+            option.palette.setColor(QPalette::Text, normalColor);
         }
 
         style()->drawPrimitive(QStyle::PE_IndicatorBranch, &option, painter);
@@ -1491,7 +1573,8 @@ QPixmap KStandardItemListWidget::pixmapForIcon(const QString& name, const QStrin
         if (icon.isNull()) {
             icon = QIcon(name);
         }
-        if (icon.isNull()) {
+        if (icon.isNull()
+            || icon.pixmap(size / qApp->devicePixelRatio(), size / qApp->devicePixelRatio(), mode).isNull()) {
             icon = fallbackIcon;
         }
 
@@ -1505,7 +1588,7 @@ QPixmap KStandardItemListWidget::pixmapForIcon(const QString& name, const QStrin
         // It is more efficient to do it here, as KIconLoader::drawOverlays()
         // assumes that an overlay will be drawn and has some additional
         // setup time.
-        foreach (const QString& overlay, overlays) {
+        for (const QString& overlay : overlays) {
             if (!overlay.isEmpty()) {
                 int state = KIconLoader::DefaultState;