src/kitemviews/kstandarditemlistwidget.cpp

   1 /*
   2  * SPDX-FileCopyrightText: 2012 Peter Penz <peter.penz19@gmail.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-or-later
   5  */
   6
   7 #include "kstandarditemlistwidget.h"
   8
   9 #include "kfileitemlistview.h"
  10 #include "kfileitemmodel.h"
  11 #include "private/kfileitemclipboard.h"
  12 #include "private/kitemlistroleeditor.h"
  13 #include "private/kitemviewsutils.h"
  14 #include "private/kpixmapmodifier.h"
  15
  16 #include <KIconEffect>
  17 #include <KIconLoader>
  18 #include <KIconUtils>
  19 #include <KRatingPainter>
  20 #include <KStringHandler>
  21
  22 #include <QApplication>
  23 #include <QGraphicsScene>
  24 #include <QGraphicsSceneResizeEvent>
  25 #include <QGraphicsView>
  26 #include <QPixmapCache>
  27 #include <QStyleOption>
  28 #include <QTextBoundaryFinder>
  29 #include <QVariantAnimation>
  30
  31 // #define KSTANDARDITEMLISTWIDGET_DEBUG
  32
  33 KStandardItemListWidgetInformant::KStandardItemListWidgetInformant()
  34     : KItemListWidgetInformant()
  35 {
  36 }
  37
  38 KStandardItemListWidgetInformant::~KStandardItemListWidgetInformant()
  39 {
  40 }
  41
  42 void KStandardItemListWidgetInformant::calculateItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints,
  43                                                               qreal &logicalWidthHint,
  44                                                               const KItemListView *view) const
  45 {
  46     switch (static_cast<const KStandardItemListView *>(view)->itemLayout()) {
  47     case KStandardItemListView::IconsLayout:
  48         calculateIconsLayoutItemSizeHints(logicalHeightHints, logicalWidthHint, view);
  49         break;
  50
  51     case KStandardItemListView::CompactLayout:
  52         calculateCompactLayoutItemSizeHints(logicalHeightHints, logicalWidthHint, view);
  53         break;
  54
  55     case KStandardItemListView::DetailsLayout:
  56         calculateDetailsLayoutItemSizeHints(logicalHeightHints, logicalWidthHint, view);
  57         break;
  58
  59     default:
  60         Q_ASSERT(false);
  61         break;
  62     }
  63 }
  64
  65 qreal KStandardItemListWidgetInformant::preferredRoleColumnWidth(const QByteArray &role, int index, const KItemListView *view) const
  66 {
  67     const QHash<QByteArray, QVariant> values = view->model()->data(index);
  68     const KItemListStyleOption &option = view->styleOption();
  69
  70     const QString text = roleText(role, values);
  71     qreal width = KStandardItemListWidget::columnPadding(option);
  72
  73     const QFontMetrics &normalFontMetrics = option.fontMetrics;
  74     const QFontMetrics linkFontMetrics(customizedFontForLinks(option.font));
  75
  76     if (role == "rating") {
  77         width += KStandardItemListWidget::preferredRatingSize(option).width();
  78     } else {
  79         // If current item is a link, we use the customized link font metrics instead of the normal font metrics.
  80         const QFontMetrics &fontMetrics = itemIsLink(index, view) ? linkFontMetrics : normalFontMetrics;
  81
  82         width += fontMetrics.horizontalAdvance(text);
  83
  84         if (role == "text") {
  85             if (view->supportsItemExpanding()) {
  86                 // Increase the width by the expansion-toggle and the current expansion level
  87                 const int expandedParentsCount = values.value("expandedParentsCount", 0).toInt();
  88                 const qreal height = option.padding * 2 + qMax(option.iconSize, fontMetrics.height());
  89                 width += (expandedParentsCount + 1) * height;
  90             }
  91
  92             // Increase the width by the required space for the icon
  93             width += option.padding * 2 + option.iconSize;
  94         }
  95     }
  96
  97     return width;
  98 }
  99
 100 QString KStandardItemListWidgetInformant::itemText(int index, const KItemListView *view) const
 101 {
 102     return view->model()->data(index).value("text").toString();
 103 }
 104
 105 bool KStandardItemListWidgetInformant::itemIsLink(int index, const KItemListView *view) const
 106 {
 107     Q_UNUSED(index)
 108     Q_UNUSED(view)
 109     return false;
 110 }
 111
 112 QString KStandardItemListWidgetInformant::roleText(const QByteArray &role, const QHash<QByteArray, QVariant> &values, ForUsageAs forUsageAs) const
 113 {
 114     if (role == "rating") {
 115         if (forUsageAs == ForUsageAs::DisplayedText) {
 116             // Always use an empty text, as the rating is shown by the image m_rating.
 117             return QString();
 118         } else {
 119             const int rating{values.value(role).toInt()};
 120             // Check if there are half stars
 121             if (rating % 2) {
 122                 return i18ncp("@accessible rating", "%1 and a half stars", "%1 and a half stars", rating / 2);
 123             }
 124             return i18ncp("@accessible rating", "%1 star", "%1 stars", rating / 2);
 125         }
 126     }
 127     return values.value(role).toString();
 128 }
 129
 130 QFont KStandardItemListWidgetInformant::customizedFontForLinks(const QFont &baseFont) const
 131 {
 132     return baseFont;
 133 }
 134
 135 void KStandardItemListWidgetInformant::calculateIconsLayoutItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints,
 136                                                                          qreal &logicalWidthHint,
 137                                                                          const KItemListView *view) const
 138 {
 139     const KItemListStyleOption &option = view->styleOption();
 140     const QFont &normalFont = option.font;
 141     const int additionalRolesCount = qMax(view->visibleRoles().count() - 1, 0);
 142
 143     const qreal itemWidth = view->itemSize().width();
 144     const qreal maxWidth = itemWidth - 2 * option.padding;
 145     const qreal additionalRolesSpacing = additionalRolesCount * option.fontMetrics.lineSpacing();
 146     const qreal spacingAndIconHeight = option.iconSize + option.padding * 3;
 147
 148     const QFont linkFont = customizedFontForLinks(normalFont);
 149
 150     QTextOption textOption(Qt::AlignHCenter);
 151     textOption.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere);
 152
 153     for (int index = 0; index < logicalHeightHints.count(); ++index) {
 154         if (logicalHeightHints.at(index).first > 0.0) {
 155             continue;
 156         }
 157
 158         // If the current item is a link, we use the customized link font instead of the normal font.
 159         const QFont &font = itemIsLink(index, view) ? linkFont : normalFont;
 160
 161         const QString &text = KStringHandler::preProcessWrap(itemText(index, view));
 162
 163         // Calculate the number of lines required for wrapping the name
 164         qreal textHeight = 0;
 165         QTextLayout layout(text, font);
 166         layout.setTextOption(textOption);
 167         layout.beginLayout();
 168         QTextLine line;
 169         int lineCount = 0;
 170         bool isElided = false;
 171         while ((line = layout.createLine()).isValid()) {
 172             line.setLineWidth(maxWidth);
 173             line.naturalTextWidth();
 174             textHeight += line.height();
 175
 176             ++lineCount;
 177             if (lineCount == option.maxTextLines) {
 178                 isElided = layout.createLine().isValid();
 179                 break;
 180             }
 181         }
 182         layout.endLayout();
 183
 184         // Add one line for each additional information
 185         textHeight += additionalRolesSpacing;
 186
 187         logicalHeightHints[index].first = textHeight + spacingAndIconHeight;
 188         logicalHeightHints[index].second = isElided;
 189     }
 190
 191     logicalWidthHint = itemWidth;
 192 }
 193
 194 void KStandardItemListWidgetInformant::calculateCompactLayoutItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints,
 195                                                                            qreal &logicalWidthHint,
 196                                                                            const KItemListView *view) const
 197 {
 198     const KItemListStyleOption &option = view->styleOption();
 199     const QFontMetrics &normalFontMetrics = option.fontMetrics;
 200     const int additionalRolesCount = qMax(view->visibleRoles().count() - 1, 0);
 201
 202     const QList<QByteArray> &visibleRoles = view->visibleRoles();
 203     const bool showOnlyTextRole = (visibleRoles.count() == 1) && (visibleRoles.first() == "text");
 204     const qreal maxWidth = option.maxTextWidth;
 205     const qreal paddingAndIconWidth = option.padding * 4 + option.iconSize;
 206     const qreal height = option.padding * 2 + qMax(option.iconSize, (1 + additionalRolesCount) * normalFontMetrics.lineSpacing());
 207
 208     const QFontMetrics linkFontMetrics(customizedFontForLinks(option.font));
 209
 210     for (int index = 0; index < logicalHeightHints.count(); ++index) {
 211         if (logicalHeightHints.at(index).first > 0.0) {
 212             continue;
 213         }
 214
 215         // If the current item is a link, we use the customized link font metrics instead of the normal font metrics.
 216         const QFontMetrics &fontMetrics = itemIsLink(index, view) ? linkFontMetrics : normalFontMetrics;
 217
 218         // For each row exactly one role is shown. Calculate the maximum required width that is necessary
 219         // to show all roles without horizontal clipping.
 220         qreal maximumRequiredWidth = 0.0;
 221
 222         if (showOnlyTextRole) {
 223             maximumRequiredWidth = fontMetrics.horizontalAdvance(itemText(index, view));
 224         } else {
 225             const QHash<QByteArray, QVariant> &values = view->model()->data(index);
 226             for (const QByteArray &role : visibleRoles) {
 227                 const QString &text = roleText(role, values);
 228                 const qreal requiredWidth = fontMetrics.horizontalAdvance(text);
 229                 maximumRequiredWidth = qMax(maximumRequiredWidth, requiredWidth);
 230             }
 231         }
 232
 233         qreal width = paddingAndIconWidth + maximumRequiredWidth;
 234         if (maxWidth > 0 && width > maxWidth) {
 235             width = maxWidth;
 236         }
 237
 238         logicalHeightHints[index].first = width;
 239     }
 240
 241     logicalWidthHint = height;
 242 }
 243
 244 void KStandardItemListWidgetInformant::calculateDetailsLayoutItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints,
 245                                                                            qreal &logicalWidthHint,
 246                                                                            const KItemListView *view) const
 247 {
 248     const KItemListStyleOption &option = view->styleOption();
 249     const qreal height = option.padding * 2 + qMax(option.iconSize, option.fontMetrics.height());
 250     logicalHeightHints.fill(std::make_pair(height, false));
 251     logicalWidthHint = -1.0;
 252 }
 253
 254 KStandardItemListWidget::KStandardItemListWidget(KItemListWidgetInformant *informant, QGraphicsItem *parent)
 255     : KItemListWidget(informant, parent)
 256     , m_textInfo()
 257     , m_isCut(false)
 258     , m_isHidden(false)
 259     , m_customizedFont()
 260     , m_customizedFontMetrics(m_customizedFont)
 261     , m_isExpandable(false)
 262     , m_highlightEntireRow(false)
 263     , m_supportsItemExpanding(false)
 264     , m_dirtyLayout(true)
 265     , m_dirtyContent(true)
 266     , m_dirtyContentRoles()
 267     , m_layout(IconsLayout)
 268     , m_pixmapPos()
 269     , m_pixmap()
 270     , m_scaledPixmapSize()
 271     , m_columnWidthSum()
 272     , m_iconRect()
 273     , m_hoverPixmap()
 274     , m_textRect()
 275     , m_sortedVisibleRoles()
 276     , m_expansionArea()
 277     , m_customTextColor()
 278     , m_additionalInfoTextColor()
 279     , m_overlays()
 280     , m_rating()
 281     , m_roleEditor(nullptr)
 282     , m_oldRoleEditor(nullptr)
 283 {
 284 }
 285
 286 KStandardItemListWidget::~KStandardItemListWidget()
 287 {
 288     qDeleteAll(m_textInfo);
 289     m_textInfo.clear();
 290
 291     if (m_roleEditor) {
 292         m_roleEditor->deleteLater();
 293     }
 294
 295     if (m_oldRoleEditor) {
 296         m_oldRoleEditor->deleteLater();
 297     }
 298 }
 299
 300 void KStandardItemListWidget::setLayout(Layout layout)
 301 {
 302     if (m_layout != layout) {
 303         m_layout = layout;
 304         m_dirtyLayout = true;
 305         updateAdditionalInfoTextColor();
 306         update();
 307     }
 308 }
 309
 310 void KStandardItemListWidget::setHighlightEntireRow(bool highlightEntireRow)
 311 {
 312     if (m_highlightEntireRow != highlightEntireRow) {
 313         m_highlightEntireRow = highlightEntireRow;
 314         m_dirtyLayout = true;
 315         update();
 316     }
 317 }
 318
 319 bool KStandardItemListWidget::highlightEntireRow() const
 320 {
 321     return m_highlightEntireRow;
 322 }
 323
 324 void KStandardItemListWidget::setSupportsItemExpanding(bool supportsItemExpanding)
 325 {
 326     if (m_supportsItemExpanding != supportsItemExpanding) {
 327         m_supportsItemExpanding = supportsItemExpanding;
 328         m_dirtyLayout = true;
 329         update();
 330     }
 331 }
 332
 333 bool KStandardItemListWidget::supportsItemExpanding() const
 334 {
 335     return m_supportsItemExpanding;
 336 }
 337
 338 void KStandardItemListWidget::paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
 339 {
 340     const_cast<KStandardItemListWidget *>(this)->triggerCacheRefreshing();
 341
 342     KItemListWidget::paint(painter, option, widget);
 343
 344     if (!m_expansionArea.isEmpty()) {
 345         drawSiblingsInformation(painter);
 346     }
 347
 348     const KItemListStyleOption &itemListStyleOption = styleOption();
 349     if (isHovered() && !m_pixmap.isNull()) {
 350         if (hoverOpacity() < 1.0) {
 351             /*
 352              * Linear interpolation between m_pixmap and m_hoverPixmap.
 353              *
 354              * Note that this cannot be achieved by painting m_hoverPixmap over
 355              * m_pixmap, even if the opacities are adjusted. For details see
 356              * https://git.reviewboard.kde.org/r/109614/
 357              */
 358             // Paint pixmap1 so that pixmap1 = m_pixmap * (1.0 - hoverOpacity())
 359             QPixmap pixmap1(m_pixmap.size());
 360             pixmap1.setDevicePixelRatio(m_pixmap.devicePixelRatio());
 361             pixmap1.fill(Qt::transparent);
 362             {
 363                 QPainter p(&pixmap1);
 364                 p.setOpacity(1.0 - hoverOpacity());
 365                 p.drawPixmap(0, 0, m_pixmap);
 366             }
 367
 368             // Paint pixmap2 so that pixmap2 = m_hoverPixmap * hoverOpacity()
 369             QPixmap pixmap2(pixmap1.size());
 370             pixmap2.setDevicePixelRatio(pixmap1.devicePixelRatio());
 371             pixmap2.fill(Qt::transparent);
 372             {
 373                 QPainter p(&pixmap2);
 374                 p.setOpacity(hoverOpacity());
 375                 p.drawPixmap(0, 0, m_hoverPixmap);
 376             }
 377
 378             // Paint pixmap2 on pixmap1 using CompositionMode_Plus
 379             // Now pixmap1 = pixmap2 + m_pixmap * (1.0 - hoverOpacity())
 380             //             = m_hoverPixmap * hoverOpacity() + m_pixmap * (1.0 - hoverOpacity())
 381             {
 382                 QPainter p(&pixmap1);
 383                 p.setCompositionMode(QPainter::CompositionMode_Plus);
 384                 p.drawPixmap(0, 0, pixmap2);
 385             }
 386
 387             // Finally paint pixmap1 on the widget
 388             drawPixmap(painter, pixmap1);
 389         } else {
 390             drawPixmap(painter, m_hoverPixmap);
 391         }
 392     } else if (!m_pixmap.isNull()) {
 393         drawPixmap(painter, m_pixmap);
 394     }
 395
 396     painter->setFont(m_customizedFont);
 397     painter->setPen(textColor(*widget));
 398     const TextInfo *textInfo = m_textInfo.value("text");
 399
 400     if (!textInfo) {
 401         // It seems that we can end up here even if m_textInfo does not contain
 402         // the key "text", see bug 306167. According to triggerCacheRefreshing(),
 403         // this can only happen if the index is negative. This can happen when
 404         // the item is about to be removed, see KItemListView::slotItemsRemoved().
 405         // TODO: try to reproduce the crash and find a better fix.
 406         return;
 407     }
 408
 409     painter->drawStaticText(textInfo->pos, textInfo->staticText);
 410
 411     bool clipAdditionalInfoBounds = false;
 412     if (m_supportsItemExpanding && m_sortedVisibleRoles.count() > 1) {
 413         // Prevent a possible overlapping of the additional-information-texts with the icon.
 414         // This will happen if the user has resized the width of the name-column to be very narrow while having folders expanded.
 415         // We only want to draw additional info text outside the area of the icon or expansion area, so we set a clip rect that does not contain the icon area.
 416         // This needs to work both for left-to-right as well as right-to-left layout directions.
 417         const TextInfo *potentiallyOverlappingRoleText = m_textInfo.value(m_sortedVisibleRoles[1]); // Only the first column after the name column can overlap.
 418         if (layoutDirection() == Qt::LeftToRight) { // In left-to-right languages the left end of text would overlap. This is mirrored for right-to-left.
 419             const qreal minX = m_iconRect.right() + 2 * itemListStyleOption.padding;
 420             if (potentiallyOverlappingRoleText->pos.x() < minX) {
 421                 clipAdditionalInfoBounds = true;
 422                 painter->save();
 423                 painter->setClipRect(minX, 0, size().width() - minX, size().height(), Qt::IntersectClip);
 424             }
 425         } else {
 426             const qreal maxX = m_iconRect.left() - 2 * itemListStyleOption.padding;
 427             if (potentiallyOverlappingRoleText->pos.x() + m_customizedFontMetrics.horizontalAdvance(potentiallyOverlappingRoleText->staticText.text()) > maxX) {
 428                 clipAdditionalInfoBounds = true;
 429                 painter->save();
 430                 painter->setClipRect(0, 0, maxX, size().height(), Qt::IntersectClip);
 431             }
 432         }
 433     }
 434
 435     painter->setPen(m_additionalInfoTextColor);
 436     painter->setFont(m_customizedFont);
 437
 438     for (int i = 1; i < m_sortedVisibleRoles.count(); ++i) {
 439         const TextInfo *textInfo = m_textInfo.value(m_sortedVisibleRoles[i]);
 440         painter->drawStaticText(textInfo->pos, textInfo->staticText);
 441     }
 442
 443     if (!m_rating.isNull()) {
 444         const TextInfo *ratingTextInfo = m_textInfo.value("rating");
 445         QPointF pos = ratingTextInfo->pos;
 446         const Qt::Alignment align = ratingTextInfo->staticText.textOption().alignment();
 447         if (align & Qt::AlignHCenter) {
 448             pos.rx() += (size().width() - m_rating.width() / m_rating.devicePixelRatioF()) / 2 - 2;
 449         }
 450         painter->drawPixmap(pos, m_rating);
 451     }
 452
 453     if (clipAdditionalInfoBounds) {
 454         painter->restore();
 455     }
 456
 457 #ifdef KSTANDARDITEMLISTWIDGET_DEBUG
 458     painter->setBrush(Qt::NoBrush);
 459     painter->setPen(Qt::green);
 460     painter->drawRect(m_iconRect);
 461
 462     painter->setPen(Qt::blue);
 463     painter->drawRect(m_textRect);
 464
 465     painter->setPen(Qt::red);
 466     painter->drawText(QPointF(0, m_customizedFontMetrics.height()), QString::number(index()));
 467     painter->drawRect(rect());
 468 #endif
 469 }
 470
 471 QRectF KStandardItemListWidget::iconRect() const
 472 {
 473     const_cast<KStandardItemListWidget *>(this)->triggerCacheRefreshing();
 474     return m_iconRect;
 475 }
 476
 477 QRectF KStandardItemListWidget::textRect() const
 478 {
 479     const_cast<KStandardItemListWidget *>(this)->triggerCacheRefreshing();
 480     return m_textRect;
 481 }
 482
 483 QRectF KStandardItemListWidget::textFocusRect() const
 484 {
 485     // In the compact- and details-layout a larger textRect() is returned to be aligned
 486     // with the iconRect(). This is useful to have a larger selection/hover-area
 487     // when having a quite large icon size but only one line of text. Still the
 488     // focus rectangle should be shown as narrow as possible around the text.
 489
 490     const_cast<KStandardItemListWidget *>(this)->triggerCacheRefreshing();
 491
 492     switch (m_layout) {
 493     case CompactLayout: {
 494         QRectF rect = m_textRect;
 495         const TextInfo *topText = m_textInfo.value(m_sortedVisibleRoles.first());
 496         const TextInfo *bottomText = m_textInfo.value(m_sortedVisibleRoles.last());
 497         rect.setTop(topText->pos.y());
 498         rect.setBottom(bottomText->pos.y() + bottomText->staticText.size().height());
 499         return rect;
 500     }
 501
 502     case DetailsLayout: {
 503         QRectF rect = m_textRect;
 504         const TextInfo *textInfo = m_textInfo.value(m_sortedVisibleRoles.first());
 505         rect.setTop(textInfo->pos.y());
 506         rect.setBottom(textInfo->pos.y() + textInfo->staticText.size().height());
 507
 508         const KItemListStyleOption &option = styleOption();
 509         if (option.extendedSelectionRegion) {
 510             const QString text = textInfo->staticText.text();
 511             rect.setWidth(m_customizedFontMetrics.horizontalAdvance(text) + 2 * option.padding);
 512         }
 513
 514         return rect;
 515     }
 516
 517     default:
 518         break;
 519     }
 520
 521     return m_textRect;
 522 }
 523
 524 QRectF KStandardItemListWidget::selectionRect() const
 525 {
 526     const_cast<KStandardItemListWidget *>(this)->triggerCacheRefreshing();
 527
 528     switch (m_layout) {
 529     case IconsLayout:
 530         return m_textRect;
 531
 532     case CompactLayout:
 533     case DetailsLayout: {
 534         const int padding = styleOption().padding;
 535         QRectF adjustedIconRect = iconRect().adjusted(-padding, -padding, padding, padding);
 536         QRectF result = adjustedIconRect | m_textRect;
 537         if (m_highlightEntireRow) {
 538             if (layoutDirection() == Qt::LeftToRight) {
 539                 result.setRight(leftPadding() + m_columnWidthSum);
 540             } else {
 541                 result.setLeft(size().width() - m_columnWidthSum - rightPadding());
 542             }
 543         }
 544         return result;
 545     }
 546
 547     default:
 548         Q_ASSERT(false);
 549         break;
 550     }
 551
 552     return m_textRect;
 553 }
 554
 555 QRectF KStandardItemListWidget::expansionToggleRect() const
 556 {
 557     const_cast<KStandardItemListWidget *>(this)->triggerCacheRefreshing();
 558     return m_isExpandable ? m_expansionArea : QRectF();
 559 }
 560
 561 QRectF KStandardItemListWidget::selectionToggleRect() const
 562 {
 563     const_cast<KStandardItemListWidget *>(this)->triggerCacheRefreshing();
 564
 565     const QRectF widgetIconRect = iconRect();
 566     const int widgetIconSize = iconSize();
 567     int toggleSize = KIconLoader::SizeSmall;
 568     if (widgetIconSize >= KIconLoader::SizeEnormous) {
 569         toggleSize = KIconLoader::SizeMedium;
 570     } else if (widgetIconSize >= KIconLoader::SizeLarge) {
 571         toggleSize = KIconLoader::SizeSmallMedium;
 572     }
 573
 574     QPointF pos = widgetIconRect.topLeft();
 575
 576     // If the selection toggle has a very small distance to the
 577     // widget borders, the size of the selection toggle will get
 578     // increased to prevent an accidental clicking of the item
 579     // when trying to hit the toggle.
 580     const int widgetHeight = size().height();
 581     const int widgetWidth = size().width();
 582     const int minMargin = 2;
 583
 584     if (toggleSize + minMargin * 2 >= widgetHeight) {
 585         pos.rx() -= (widgetHeight - toggleSize) / 2;
 586         toggleSize = widgetHeight;
 587         pos.setY(0);
 588     }
 589     if (toggleSize + minMargin * 2 >= widgetWidth) {
 590         pos.ry() -= (widgetWidth - toggleSize) / 2;
 591         toggleSize = widgetWidth;
 592         pos.setX(0);
 593     }
 594
 595     if (QApplication::isRightToLeft()) {
 596         pos.setX(widgetIconRect.right() - (pos.x() + toggleSize - widgetIconRect.left()));
 597     }
 598
 599     return QRectF(pos, QSizeF(toggleSize, toggleSize));
 600 }
 601
 602 QPixmap KStandardItemListWidget::createDragPixmap(const QStyleOptionGraphicsItem *option, QWidget *widget)
 603 {
 604     QPixmap pixmap = KItemListWidget::createDragPixmap(option, widget);
 605     if (m_layout != DetailsLayout) {
 606         return pixmap;
 607     }
 608
 609     // Only return the content of the text-column as pixmap
 610     const int leftClip = m_pixmapPos.x();
 611
 612     const TextInfo *textInfo = m_textInfo.value("text");
 613     const int rightClip = textInfo->pos.x() + textInfo->staticText.size().width() + 2 * styleOption().padding;
 614
 615     QPixmap clippedPixmap(rightClip - leftClip + 1, pixmap.height());
 616     clippedPixmap.fill(Qt::transparent);
 617
 618     QPainter painter(&clippedPixmap);
 619     painter.drawPixmap(-leftClip, 0, pixmap);
 620
 621     return clippedPixmap;
 622 }
 623
 624 void KStandardItemListWidget::startActivateSoonAnimation(int timeUntilActivation)
 625 {
 626     if (m_activateSoonAnimation) {
 627         m_activateSoonAnimation->stop(); // automatically DeleteWhenStopped
 628     }
 629
 630     m_activateSoonAnimation = new QVariantAnimation{this};
 631     m_activateSoonAnimation->setStartValue(0.0);
 632     m_activateSoonAnimation->setEndValue(1.0);
 633     m_activateSoonAnimation->setDuration(timeUntilActivation);
 634
 635     const QVariant originalIconName{data()["iconName"]};
 636     connect(m_activateSoonAnimation, &QVariantAnimation::valueChanged, this, [originalIconName, this](const QVariant &value) {
 637         auto progress = value.toFloat();
 638
 639         QVariant wantedIconName;
 640         if (progress < 0.333) {
 641             wantedIconName = "folder-open";
 642         } else if (progress < 0.666) {
 643             wantedIconName = originalIconName;
 644         } else {
 645             wantedIconName = "folder-open";
 646         }
 647
 648         QHash<QByteArray, QVariant> itemData{data()};
 649         if (itemData["iconName"] != wantedIconName) {
 650             itemData.insert("iconName", wantedIconName);
 651             setData(itemData);
 652             invalidateIconCache();
 653         }
 654     });
 655
 656     connect(m_activateSoonAnimation, &QObject::destroyed, this, [originalIconName, this]() {
 657         QHash<QByteArray, QVariant> itemData{data()};
 658         if (itemData["iconName"] == "folder-open") {
 659             itemData.insert("iconName", originalIconName);
 660             setData(itemData);
 661             invalidateIconCache();
 662         }
 663     });
 664
 665     m_activateSoonAnimation->start(QAbstractAnimation::DeleteWhenStopped);
 666 }
 667
 668 bool KStandardItemListWidget::isIconControlledByActivateSoonAnimation() const
 669 {
 670     return m_activateSoonAnimation && data()["iconName"] == "folder-open";
 671 }
 672
 673 KItemListWidgetInformant *KStandardItemListWidget::createInformant()
 674 {
 675     return new KStandardItemListWidgetInformant();
 676 }
 677
 678 void KStandardItemListWidget::invalidateCache()
 679 {
 680     m_dirtyLayout = true;
 681     m_dirtyContent = true;
 682 }
 683
 684 void KStandardItemListWidget::invalidateIconCache()
 685 {
 686     m_dirtyContent = true;
 687     m_dirtyContentRoles.insert("iconPixmap");
 688     m_dirtyContentRoles.insert("iconOverlays");
 689 }
 690
 691 void KStandardItemListWidget::refreshCache()
 692 {
 693 }
 694
 695 bool KStandardItemListWidget::isRoleRightAligned(const QByteArray &role) const
 696 {
 697     Q_UNUSED(role)
 698     return false;
 699 }
 700
 701 bool KStandardItemListWidget::isHidden() const
 702 {
 703     return false;
 704 }
 705
 706 QFont KStandardItemListWidget::customizedFont(const QFont &baseFont) const
 707 {
 708     return baseFont;
 709 }
 710
 711 QPalette::ColorRole KStandardItemListWidget::normalTextColorRole() const
 712 {
 713     return QPalette::Text;
 714 }
 715
 716 void KStandardItemListWidget::setTextColor(const QColor &color)
 717 {
 718     if (color != m_customTextColor) {
 719         m_customTextColor = color;
 720         updateAdditionalInfoTextColor();
 721         update();
 722     }
 723 }
 724
 725 QColor KStandardItemListWidget::textColor(const QWidget &widget) const
 726 {
 727     if (!isSelected()) {
 728         if (m_isHidden) {
 729             return m_additionalInfoTextColor;
 730         } else if (m_customTextColor.isValid()) {
 731             return m_customTextColor;
 732         }
 733     }
 734
 735     const QPalette::ColorGroup group = isActiveWindow() && widget.hasFocus() ? QPalette::Active : QPalette::Inactive;
 736     const QPalette::ColorRole role = isSelected() ? QPalette::HighlightedText : normalTextColorRole();
 737     return styleOption().palette.color(group, role);
 738 }
 739
 740 void KStandardItemListWidget::setOverlays(QHash<Qt::Corner, QString> &overlays)
 741 {
 742     if (overlays == m_overlays) {
 743         return;
 744     }
 745
 746     m_overlays = overlays;
 747     m_dirtyContent = true;
 748     m_dirtyContentRoles.insert("iconOverlays");
 749     update();
 750 }
 751
 752 QHash<Qt::Corner, QString> KStandardItemListWidget::overlays() const
 753 {
 754     return m_overlays;
 755 }
 756
 757 QString KStandardItemListWidget::roleText(const QByteArray &role, const QHash<QByteArray, QVariant> &values) const
 758 {
 759     return static_cast<const KStandardItemListWidgetInformant *>(informant())->roleText(role, values);
 760 }
 761
 762 void KStandardItemListWidget::dataChanged(const QHash<QByteArray, QVariant> &current, const QSet<QByteArray> &roles)
 763 {
 764     Q_UNUSED(current)
 765
 766     m_dirtyContent = true;
 767
 768     QSet<QByteArray> dirtyRoles;
 769     if (roles.isEmpty()) {
 770         const auto visibleRoles = this->visibleRoles();
 771         dirtyRoles = QSet<QByteArray>(visibleRoles.constBegin(), visibleRoles.constEnd());
 772     } else {
 773         dirtyRoles = roles;
 774     }
 775
 776     // The URL might have changed (i.e., if the sort order of the items has
 777     // been changed). Therefore, the "is cut" state must be updated.
 778     KFileItemClipboard *clipboard = KFileItemClipboard::instance();
 779     const QUrl itemUrl = data().value("url").toUrl();
 780     m_isCut = clipboard->isCut(itemUrl);
 781
 782     // The icon-state might depend from other roles and hence is
 783     // marked as dirty whenever a role has been changed
 784     dirtyRoles.insert("iconPixmap");
 785     dirtyRoles.insert("iconName");
 786
 787     QSetIterator<QByteArray> it(dirtyRoles);
 788     while (it.hasNext()) {
 789         const QByteArray &role = it.next();
 790         m_dirtyContentRoles.insert(role);
 791     }
 792 }
 793
 794 void KStandardItemListWidget::visibleRolesChanged(const QList<QByteArray> &current, const QList<QByteArray> &previous)
 795 {
 796     Q_UNUSED(previous)
 797     m_sortedVisibleRoles = current;
 798     m_dirtyLayout = true;
 799 }
 800
 801 void KStandardItemListWidget::columnWidthChanged(const QByteArray &role, qreal current, qreal previous)
 802 {
 803     Q_UNUSED(role)
 804     Q_UNUSED(current)
 805     Q_UNUSED(previous)
 806     m_dirtyLayout = true;
 807 }
 808
 809 void KStandardItemListWidget::sidePaddingChanged(qreal leftPaddingWidth, qreal rightPaddingWidth)
 810 {
 811     Q_UNUSED(leftPaddingWidth)
 812     Q_UNUSED(rightPaddingWidth)
 813     m_dirtyLayout = true;
 814 }
 815
 816 void KStandardItemListWidget::styleOptionChanged(const KItemListStyleOption &current, const KItemListStyleOption &previous)
 817 {
 818     KItemListWidget::styleOptionChanged(current, previous);
 819
 820     updateAdditionalInfoTextColor();
 821     m_dirtyLayout = true;
 822 }
 823
 824 void KStandardItemListWidget::hoveredChanged(bool hovered)
 825 {
 826     if (!hovered && m_activateSoonAnimation) {
 827         m_activateSoonAnimation->stop(); // automatically DeleteWhenStopped
 828     }
 829     m_dirtyLayout = true;
 830 }
 831
 832 void KStandardItemListWidget::selectedChanged(bool selected)
 833 {
 834     Q_UNUSED(selected)
 835     updateAdditionalInfoTextColor();
 836     m_dirtyContent = true;
 837 }
 838
 839 void KStandardItemListWidget::siblingsInformationChanged(const QBitArray &current, const QBitArray &previous)
 840 {
 841     Q_UNUSED(current)
 842     Q_UNUSED(previous)
 843     m_dirtyLayout = true;
 844 }
 845
 846 int KStandardItemListWidget::numberOfUnicodeCharactersIn(const QString &text)
 847 {
 848     int count = 0;
 849     QTextBoundaryFinder boundaryFinder(QTextBoundaryFinder::Grapheme, text);
 850     while (boundaryFinder.toNextBoundary() != -1) {
 851         ++count;
 852     }
 853     return count;
 854 }
 855
 856 int KStandardItemListWidget::selectionLength(const QString &text) const
 857 {
 858     return numberOfUnicodeCharactersIn(text);
 859 }
 860
 861 void KStandardItemListWidget::editedRoleChanged(const QByteArray &current, const QByteArray &previous)
 862 {
 863     Q_UNUSED(previous)
 864
 865     QGraphicsView *parent = scene()->views()[0];
 866     if (current.isEmpty() || !parent || current != "text") {
 867         if (m_roleEditor) {
 868             Q_EMIT roleEditingCanceled(index(), current, data().value(current));
 869             closeRoleEditor();
 870         }
 871         return;
 872     }
 873
 874     Q_ASSERT(!m_roleEditor);
 875
 876     const TextInfo *textInfo = m_textInfo.value("text");
 877
 878     m_roleEditor = new KItemListRoleEditor(parent);
 879     m_roleEditor->setRole(current);
 880     m_roleEditor->setAllowUpDownKeyChainEdit(m_layout != IconsLayout);
 881     m_roleEditor->setFont(styleOption().font);
 882
 883     const QString text = data().value(current).toString();
 884     m_roleEditor->setPlainText(text);
 885
 886     QTextOption textOption = textInfo->staticText.textOption();
 887     m_roleEditor->document()->setDefaultTextOption(textOption);
 888
 889     const int textSelectionLength = selectionLength(text);
 890
 891     if (textSelectionLength > 0) {
 892         QTextCursor cursor = m_roleEditor->textCursor();
 893         cursor.movePosition(QTextCursor::StartOfBlock);
 894         cursor.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor, textSelectionLength);
 895         m_roleEditor->setTextCursor(cursor);
 896     }
 897
 898     connect(m_roleEditor, &KItemListRoleEditor::roleEditingCanceled, this, &KStandardItemListWidget::slotRoleEditingCanceled);
 899     connect(m_roleEditor, &KItemListRoleEditor::roleEditingFinished, this, &KStandardItemListWidget::slotRoleEditingFinished);
 900
 901     // Adjust the geometry of the editor
 902     QRectF rect = roleEditingRect(current);
 903     const int frameWidth = m_roleEditor->frameWidth();
 904     rect.adjust(-frameWidth, -frameWidth, frameWidth, frameWidth);
 905     rect.translate(pos());
 906     if (rect.right() > parent->width()) {
 907         rect.setWidth(parent->width() - rect.left());
 908     }
 909     m_roleEditor->setGeometry(rect.toRect());
 910     m_roleEditor->autoAdjustSize();
 911     m_roleEditor->show();
 912     m_roleEditor->setFocus();
 913 }
 914
 915 void KStandardItemListWidget::iconSizeChanged(int current, int previous)
 916 {
 917     KItemListWidget::iconSizeChanged(current, previous);
 918
 919     invalidateIconCache();
 920     triggerCacheRefreshing();
 921     update();
 922 }
 923
 924 void KStandardItemListWidget::resizeEvent(QGraphicsSceneResizeEvent *event)
 925 {
 926     if (m_roleEditor) {
 927         setEditedRole(QByteArray());
 928         Q_ASSERT(!m_roleEditor);
 929     }
 930
 931     KItemListWidget::resizeEvent(event);
 932
 933     m_dirtyLayout = true;
 934 }
 935
 936 void KStandardItemListWidget::showEvent(QShowEvent *event)
 937 {
 938     KItemListWidget::showEvent(event);
 939
 940     // Listen to changes of the clipboard to mark the item as cut/uncut
 941     KFileItemClipboard *clipboard = KFileItemClipboard::instance();
 942
 943     const QUrl itemUrl = data().value("url").toUrl();
 944     m_isCut = clipboard->isCut(itemUrl);
 945
 946     connect(clipboard, &KFileItemClipboard::cutItemsChanged, this, &KStandardItemListWidget::slotCutItemsChanged);
 947 }
 948
 949 void KStandardItemListWidget::hideEvent(QHideEvent *event)
 950 {
 951     disconnect(KFileItemClipboard::instance(), &KFileItemClipboard::cutItemsChanged, this, &KStandardItemListWidget::slotCutItemsChanged);
 952
 953     KItemListWidget::hideEvent(event);
 954 }
 955
 956 bool KStandardItemListWidget::event(QEvent *event)
 957 {
 958     if (event->type() == QEvent::WindowDeactivate || event->type() == QEvent::WindowActivate || event->type() == QEvent::PaletteChange) {
 959         m_dirtyContent = true;
 960     }
 961
 962     return KItemListWidget::event(event);
 963 }
 964
 965 void KStandardItemListWidget::finishRoleEditing()
 966 {
 967     if (!editedRole().isEmpty() && m_roleEditor) {
 968         slotRoleEditingFinished(editedRole(), KIO::encodeFileName(m_roleEditor->toPlainText()));
 969     }
 970 }
 971
 972 void KStandardItemListWidget::slotCutItemsChanged()
 973 {
 974     const QUrl itemUrl = data().value("url").toUrl();
 975     const bool isCut = KFileItemClipboard::instance()->isCut(itemUrl);
 976     if (m_isCut != isCut) {
 977         m_isCut = isCut;
 978         m_pixmap = QPixmap();
 979         m_dirtyContent = true;
 980         update();
 981     }
 982 }
 983
 984 void KStandardItemListWidget::slotRoleEditingCanceled(const QByteArray &role, const QVariant &value)
 985 {
 986     closeRoleEditor();
 987     Q_EMIT roleEditingCanceled(index(), role, value);
 988     setEditedRole(QByteArray());
 989 }
 990
 991 void KStandardItemListWidget::slotRoleEditingFinished(const QByteArray &role, const QVariant &value)
 992 {
 993     closeRoleEditor();
 994     Q_EMIT roleEditingFinished(index(), role, value);
 995     setEditedRole(QByteArray());
 996 }
 997
 998 void KStandardItemListWidget::triggerCacheRefreshing()
 999 {
1000     if ((!m_dirtyContent && !m_dirtyLayout) || index() < 0) {
1001         return;
1002     }
1003
1004     refreshCache();
1005
1006     const QHash<QByteArray, QVariant> values = data();
1007     m_isExpandable = m_supportsItemExpanding && values["isExpandable"].toBool();
1008     m_isHidden = isHidden();
1009     m_customizedFont = customizedFont(styleOption().font);
1010     m_customizedFontMetrics = QFontMetrics(m_customizedFont);
1011     m_columnWidthSum = std::accumulate(m_sortedVisibleRoles.begin(), m_sortedVisibleRoles.end(), qreal(), [this](qreal sum, const auto &role) {
1012         return sum + columnWidth(role);
1013     });
1014
1015     updateExpansionArea();
1016     updateTextsCache();
1017     updatePixmapCache();
1018     clearHoverCache();
1019
1020     m_dirtyLayout = false;
1021     m_dirtyContent = false;
1022     m_dirtyContentRoles.clear();
1023 }
1024
1025 void KStandardItemListWidget::updateExpansionArea()
1026 {
1027     if (m_supportsItemExpanding) {
1028         const QHash<QByteArray, QVariant> values = data();
1029         const int expandedParentsCount = values.value("expandedParentsCount", 0).toInt();
1030         if (expandedParentsCount >= 0) {
1031             const int widgetIconSize = iconSize();
1032             const qreal widgetHeight = size().height();
1033             const qreal inc = (widgetHeight - widgetIconSize) / 2;
1034             const qreal x = expandedParentsCount * widgetHeight + inc;
1035             const qreal y = inc;
1036             if (layoutDirection() == Qt::LeftToRight) {
1037                 const qreal leftPaddingWidth = m_highlightEntireRow ? leftPadding() : 0;
1038                 m_expansionArea = QRectF(leftPaddingWidth + x, y, widgetIconSize, widgetIconSize);
1039                 return;
1040             }
1041             const qreal rightPaddingWidth = m_highlightEntireRow ? rightPadding() : 0;
1042             m_expansionArea = QRectF(size().width() - rightPaddingWidth - x - widgetIconSize, y, widgetIconSize, widgetIconSize);
1043             return;
1044         }
1045     }
1046
1047     m_expansionArea = QRectF();
1048 }
1049
1050 void KStandardItemListWidget::updatePixmapCache()
1051 {
1052     // Precondition: Requires already updated m_textPos values to calculate
1053     // the remaining height when the alignment is vertical.
1054
1055     const QSizeF widgetSize = size();
1056     const bool iconOnTop = (m_layout == IconsLayout);
1057     const KItemListStyleOption &option = styleOption();
1058     const qreal padding = option.padding;
1059     const qreal dpr = KItemViewsUtils::devicePixelRatio(this);
1060
1061     const int widgetIconSize = iconSize();
1062     const int maxIconWidth = iconOnTop ? widgetSize.width() - 2 * padding : widgetIconSize;
1063     const int maxIconHeight = widgetIconSize;
1064
1065     const QHash<QByteArray, QVariant> values = data();
1066
1067     bool updatePixmap = (m_pixmap.width() != maxIconWidth || m_pixmap.height() != maxIconHeight);
1068     if (!updatePixmap && m_dirtyContent) {
1069         updatePixmap = m_dirtyContentRoles.isEmpty() || m_dirtyContentRoles.contains("iconPixmap") || m_dirtyContentRoles.contains("iconName")
1070             || m_dirtyContentRoles.contains("iconOverlays");
1071     }
1072
1073     if (updatePixmap) {
1074         m_pixmap = QPixmap();
1075
1076         int sequenceIndex = hoverSequenceIndex();
1077
1078         if (values.contains("hoverSequencePixmaps") && !isIconControlledByActivateSoonAnimation()) {
1079             // Use one of the hover sequence pixmaps instead of the default
1080             // icon pixmap.
1081
1082             const QVector<QPixmap> pixmaps = values["hoverSequencePixmaps"].value<QVector<QPixmap>>();
1083
1084             if (values.contains("hoverSequenceWraparoundPoint")) {
1085                 const float wap = values["hoverSequenceWraparoundPoint"].toFloat();
1086                 if (wap >= 1.0f) {
1087                     sequenceIndex %= static_cast<int>(wap);
1088                 }
1089             }
1090
1091             const int loadedIndex = qMax(qMin(sequenceIndex, pixmaps.size() - 1), 0);
1092
1093             if (loadedIndex != 0) {
1094                 m_pixmap = pixmaps[loadedIndex];
1095             }
1096         }
1097
1098         if (m_pixmap.isNull() && !isIconControlledByActivateSoonAnimation()) {
1099             m_pixmap = values["iconPixmap"].value<QPixmap>();
1100         }
1101
1102         if (m_pixmap.isNull()) {
1103             // Use the icon that fits to the MIME-type
1104             QString iconName = values["iconName"].toString();
1105             if (iconName.isEmpty()) {
1106                 // The icon-name has not been not resolved by KFileItemModelRolesUpdater,
1107                 // use a generic icon as fallback
1108                 iconName = QStringLiteral("unknown");
1109             }
1110             const QStringList overlays = values["iconOverlays"].toStringList();
1111             const bool hasFocus = scene()->views()[0]->parentWidget()->hasFocus();
1112             m_pixmap = pixmapForIcon(iconName,
1113                                      m_overlays,
1114                                      QSize(maxIconWidth, maxIconHeight),
1115                                      m_layout != IconsLayout && isActiveWindow() && isSelected() && hasFocus ? QIcon::Selected : QIcon::Normal);
1116
1117         } else {
1118             if (!m_overlays.isEmpty()) {
1119                 m_pixmap = addOverlays(m_pixmap, m_overlays, QSize(maxIconWidth, maxIconHeight), dpr);
1120             } else if (m_pixmap.width() / m_pixmap.devicePixelRatio() != maxIconWidth || m_pixmap.height() / m_pixmap.devicePixelRatio() != maxIconHeight) {
1121                 // A custom pixmap has been applied. Assure that the pixmap
1122                 // is scaled to the maximum available size.
1123                 KPixmapModifier::scale(m_pixmap, QSize(maxIconWidth, maxIconHeight) * dpr);
1124             }
1125         }
1126
1127         if (m_pixmap.isNull()) {
1128             m_hoverPixmap = QPixmap();
1129             return;
1130         }
1131
1132         if (m_isCut) {
1133             KIconEffect::toDisabled(m_pixmap);
1134         }
1135
1136         if (m_isHidden) {
1137             KIconEffect::semiTransparent(m_pixmap);
1138         }
1139
1140         if (m_layout == IconsLayout && isSelected()) {
1141             const QColor color = palette().brush(QPalette::Normal, QPalette::Highlight).color();
1142             QImage image = m_pixmap.toImage();
1143             if (image.isNull()) {
1144                 m_hoverPixmap = QPixmap();
1145                 return;
1146             }
1147             KIconEffect::colorize(image, color, 0.8f);
1148             m_pixmap = QPixmap::fromImage(image);
1149         }
1150     }
1151
1152     int scaledIconSize = 0;
1153     if (iconOnTop) {
1154         const TextInfo *textInfo = m_textInfo.value("text");
1155         scaledIconSize = static_cast<int>(textInfo->pos.y() - 2 * padding);
1156     } else {
1157         const int textRowsCount = (m_layout == CompactLayout) ? visibleRoles().count() : 1;
1158         const qreal requiredTextHeight = textRowsCount * m_customizedFontMetrics.height();
1159         scaledIconSize = (requiredTextHeight < maxIconHeight) ? widgetSize.height() - 2 * padding : maxIconHeight;
1160     }
1161
1162     const int maxScaledIconWidth = iconOnTop ? widgetSize.width() - 2 * padding : scaledIconSize;
1163     const int maxScaledIconHeight = scaledIconSize;
1164
1165     m_scaledPixmapSize = m_pixmap.size();
1166     m_scaledPixmapSize.scale(maxScaledIconWidth * dpr, maxScaledIconHeight * dpr, Qt::KeepAspectRatio);
1167     m_scaledPixmapSize = m_scaledPixmapSize / dpr;
1168
1169     if (iconOnTop) {
1170         // Center horizontally and align on bottom within the icon-area
1171         m_pixmapPos.setX((widgetSize.width() - m_scaledPixmapSize.width()) / 2.0);
1172         m_pixmapPos.setY(padding + scaledIconSize - m_scaledPixmapSize.height());
1173     } else {
1174         // Center horizontally and vertically within the icon-area
1175         const TextInfo *textInfo = m_textInfo.value("text");
1176         if (QApplication::isRightToLeft()) {
1177             m_pixmapPos.setX(m_textRect.right() + 2.0 * padding);
1178         } else {
1179             m_pixmapPos.setX(textInfo->pos.x() - 2.0 * padding - (scaledIconSize + m_scaledPixmapSize.width()) / 2.0);
1180         }
1181
1182         // Derive icon's vertical center from the center of the text frame, including
1183         // any necessary adjustment if the font's midline is offset from the frame center
1184         const qreal midlineShift = m_customizedFontMetrics.height() / 2.0 - m_customizedFontMetrics.descent() - m_customizedFontMetrics.capHeight() / 2.0;
1185         m_pixmapPos.setY(m_textRect.center().y() + midlineShift - m_scaledPixmapSize.height() / 2.0);
1186     }
1187
1188     if (m_layout == IconsLayout) {
1189         m_iconRect = QRectF(m_pixmapPos, QSizeF(m_scaledPixmapSize));
1190     } else {
1191         const qreal widthOffset = widgetIconSize - m_scaledPixmapSize.width();
1192         const qreal heightOffset = widgetIconSize - m_scaledPixmapSize.height();
1193         const QPointF squareIconPos(m_pixmapPos.x() - 0.5 * widthOffset, m_pixmapPos.y() - 0.5 * heightOffset);
1194         const QSizeF squareIconSize(widgetIconSize, widgetIconSize);
1195         m_iconRect = QRectF(squareIconPos, squareIconSize);
1196     }
1197
1198     // Prepare the pixmap that is used when the item gets hovered
1199     if (isHovered()) {
1200         m_hoverPixmap = m_pixmap;
1201         KIconEffect::toActive(m_hoverPixmap);
1202     } else if (hoverOpacity() <= 0.0) {
1203         // No hover animation is ongoing. Clear m_hoverPixmap to save memory.
1204         m_hoverPixmap = QPixmap();
1205     }
1206 }
1207
1208 void KStandardItemListWidget::updateTextsCache()
1209 {
1210     QTextOption textOption;
1211     switch (m_layout) {
1212     case IconsLayout:
1213         textOption.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere);
1214         textOption.setAlignment(Qt::AlignHCenter);
1215         break;
1216     case CompactLayout:
1217         textOption.setAlignment(QApplication::isRightToLeft() ? Qt::AlignRight : Qt::AlignLeft);
1218         textOption.setWrapMode(QTextOption::NoWrap);
1219         break;
1220     case DetailsLayout:
1221         textOption.setAlignment(Qt::AlignLeft);
1222         textOption.setWrapMode(QTextOption::NoWrap);
1223         break;
1224     default:
1225         Q_ASSERT(false);
1226         break;
1227     }
1228
1229     qDeleteAll(m_textInfo);
1230     m_textInfo.clear();
1231     for (int i = 0; i < m_sortedVisibleRoles.count(); ++i) {
1232         TextInfo *textInfo = new TextInfo();
1233         textInfo->staticText.setTextFormat(Qt::PlainText);
1234         textInfo->staticText.setPerformanceHint(QStaticText::AggressiveCaching);
1235         textInfo->staticText.setTextOption(textOption);
1236         m_textInfo.insert(m_sortedVisibleRoles[i], textInfo);
1237     }
1238
1239     switch (m_layout) {
1240     case IconsLayout:
1241         updateIconsLayoutTextCache();
1242         break;
1243     case CompactLayout:
1244         updateCompactLayoutTextCache();
1245         break;
1246     case DetailsLayout:
1247         updateDetailsLayoutTextCache();
1248         break;
1249     default:
1250         Q_ASSERT(false);
1251         break;
1252     }
1253
1254     const TextInfo *ratingTextInfo = m_textInfo.value("rating");
1255     if (ratingTextInfo) {
1256         // The text of the rating-role has been set to empty to get
1257         // replaced by a rating-image showing the rating as stars.
1258         const KItemListStyleOption &option = styleOption();
1259         QSizeF ratingSize = preferredRatingSize(option);
1260
1261         const qreal availableWidth = (m_layout == DetailsLayout) ? columnWidth("rating") - columnPadding(option) : size().width();
1262         if (ratingSize.width() > availableWidth) {
1263             ratingSize.rwidth() = availableWidth;
1264         }
1265         const qreal dpr = KItemViewsUtils::devicePixelRatio(this);
1266         m_rating = QPixmap(ratingSize.toSize() * dpr);
1267         m_rating.setDevicePixelRatio(dpr);
1268         m_rating.fill(Qt::transparent);
1269
1270         QPainter painter(&m_rating);
1271         const QRect rect(QPoint(0, 0), ratingSize.toSize());
1272         const int rating = data().value("rating").toInt();
1273         KRatingPainter::paintRating(&painter, rect, Qt::AlignJustify | Qt::AlignVCenter, rating);
1274     } else if (!m_rating.isNull()) {
1275         m_rating = QPixmap();
1276     }
1277 }
1278
1279 QString KStandardItemListWidget::escapeString(const QString &text) const
1280 {
1281     QString escaped(text);
1282
1283     const QChar returnSymbol(0x21b5);
1284     escaped.replace('\n', returnSymbol);
1285
1286     return escaped;
1287 }
1288
1289 void KStandardItemListWidget::updateIconsLayoutTextCache()
1290 {
1291     //      +------+
1292     //      | Icon |
1293     //      +------+
1294     //
1295     //    Name role that
1296     // might get wrapped above
1297     //    several lines.
1298     //  Additional role 1
1299     //  Additional role 2
1300
1301     const QHash<QByteArray, QVariant> values = data();
1302
1303     const KItemListStyleOption &option = styleOption();
1304     const qreal padding = option.padding;
1305     const qreal maxWidth = size().width() - 2 * padding;
1306     const qreal lineSpacing = m_customizedFontMetrics.lineSpacing();
1307
1308     // Initialize properties for the "text" role. It will be used as anchor
1309     // for initializing the position of the other roles.
1310     TextInfo *nameTextInfo = m_textInfo.value("text");
1311     const QString nameText = KStringHandler::preProcessWrap(escapeString(values["text"].toString()));
1312     nameTextInfo->staticText.setText(nameText);
1313
1314     // Calculate the number of lines required for the name and the required width
1315     qreal nameWidth = 0;
1316     qreal nameHeight = 0;
1317     QTextLine line;
1318
1319     QTextLayout layout(nameTextInfo->staticText.text(), m_customizedFont);
1320     layout.setTextOption(nameTextInfo->staticText.textOption());
1321     layout.beginLayout();
1322     int nameLineIndex = 0;
1323     while ((line = layout.createLine()).isValid()) {
1324         line.setLineWidth(maxWidth);
1325         nameWidth = qMax(nameWidth, line.naturalTextWidth());
1326         nameHeight += line.height();
1327
1328         ++nameLineIndex;
1329         if (nameLineIndex == option.maxTextLines) {
1330             // The maximum number of textlines has been reached. If this is
1331             // the case provide an elided text if necessary.
1332             const int textLength = line.textStart() + line.textLength();
1333             if (textLength < nameText.length()) {
1334                 // Elide the last line of the text
1335                 qreal elidingWidth = maxWidth;
1336                 qreal lastLineWidth;
1337                 do {
1338                     QString lastTextLine = nameText.mid(line.textStart());
1339                     lastTextLine = m_customizedFontMetrics.elidedText(lastTextLine, Qt::ElideMiddle, elidingWidth);
1340                     const QString elidedText = nameText.left(line.textStart()) + lastTextLine;
1341                     nameTextInfo->staticText.setText(elidedText);
1342
1343                     lastLineWidth = m_customizedFontMetrics.horizontalAdvance(lastTextLine);
1344
1345                     // We do the text eliding in a loop with decreasing width (1 px / iteration)
1346                     // to avoid problems related to different width calculation code paths
1347                     // within Qt. (see bug 337104)
1348                     elidingWidth -= 1.0;
1349                 } while (lastLineWidth > maxWidth);
1350
1351                 nameWidth = qMax(nameWidth, lastLineWidth);
1352             }
1353             break;
1354         }
1355     }
1356     layout.endLayout();
1357
1358     // Use one line for each additional information
1359     nameTextInfo->staticText.setTextWidth(maxWidth);
1360     nameTextInfo->pos = QPointF(padding, iconSize() + 2 * padding);
1361     m_textRect = QRectF(padding + (maxWidth - nameWidth) / 2, nameTextInfo->pos.y(), nameWidth, nameHeight);
1362
1363     // Calculate the position for each additional information
1364     qreal y = nameTextInfo->pos.y() + nameHeight;
1365     for (const QByteArray &role : std::as_const(m_sortedVisibleRoles)) {
1366         if (role == "text") {
1367             continue;
1368         }
1369
1370         const QString text = roleText(role, values);
1371         TextInfo *textInfo = m_textInfo.value(role);
1372         textInfo->staticText.setText(text);
1373
1374         qreal requiredWidth = 0;
1375
1376         QTextLayout layout(text, m_customizedFont);
1377         QTextOption textOption;
1378         textOption.setWrapMode(QTextOption::NoWrap);
1379         layout.setTextOption(textOption);
1380
1381         layout.beginLayout();
1382         QTextLine textLine = layout.createLine();
1383         if (textLine.isValid()) {
1384             textLine.setLineWidth(maxWidth);
1385             requiredWidth = textLine.naturalTextWidth();
1386             if (requiredWidth > maxWidth) {
1387                 const QString elidedText = m_customizedFontMetrics.elidedText(text, Qt::ElideMiddle, maxWidth);
1388                 textInfo->staticText.setText(elidedText);
1389                 requiredWidth = m_customizedFontMetrics.horizontalAdvance(elidedText);
1390             } else if (role == "rating") {
1391                 // Use the width of the rating pixmap, because the rating text is empty.
1392                 requiredWidth = m_rating.width() / m_rating.devicePixelRatioF();
1393             }
1394         }
1395         layout.endLayout();
1396
1397         textInfo->pos = QPointF(padding, y);
1398         textInfo->staticText.setTextWidth(maxWidth);
1399
1400         const QRectF textRect(padding + (maxWidth - requiredWidth) / 2, y, requiredWidth, lineSpacing);
1401
1402         // Ignore empty roles. Avoids a text rect taller than the area that actually contains text.
1403         if (!textRect.isEmpty()) {
1404             m_textRect |= textRect;
1405         }
1406
1407         y += lineSpacing;
1408     }
1409
1410     // Add a padding to the text rectangle
1411     m_textRect.adjust(-padding, -padding, padding, padding);
1412 }
1413
1414 void KStandardItemListWidget::updateCompactLayoutTextCache()
1415 {
1416     // +------+  Name role
1417     // | Icon |  Additional role 1
1418     // +------+  Additional role 2
1419
1420     const QHash<QByteArray, QVariant> values = data();
1421
1422     const KItemListStyleOption &option = styleOption();
1423     const qreal widgetHeight = size().height();
1424     const qreal lineSpacing = m_customizedFontMetrics.lineSpacing();
1425     const qreal textLinesHeight = qMax(visibleRoles().count(), 1) * lineSpacing;
1426
1427     qreal maximumRequiredTextWidth = 0;
1428     const qreal x = QApplication::isRightToLeft() ? option.padding : option.padding * 3 + iconSize();
1429     qreal y = qRound((widgetHeight - textLinesHeight) / 2);
1430     const qreal maxWidth = size().width() - iconSize() - 4 * option.padding;
1431     for (const QByteArray &role : std::as_const(m_sortedVisibleRoles)) {
1432         const QString text = escapeString(roleText(role, values));
1433         TextInfo *textInfo = m_textInfo.value(role);
1434         textInfo->staticText.setText(text);
1435
1436         qreal requiredWidth = m_customizedFontMetrics.horizontalAdvance(text);
1437         if (requiredWidth > maxWidth) {
1438             requiredWidth = maxWidth;
1439             const QString elidedText = m_customizedFontMetrics.elidedText(text, Qt::ElideMiddle, maxWidth);
1440             textInfo->staticText.setText(elidedText);
1441         }
1442
1443         textInfo->pos = QPointF(x, y);
1444         textInfo->staticText.setTextWidth(maxWidth);
1445
1446         maximumRequiredTextWidth = qMax(maximumRequiredTextWidth, requiredWidth);
1447
1448         y += lineSpacing;
1449     }
1450
1451     m_textRect = QRectF(x - option.padding, 0, maximumRequiredTextWidth + 2 * option.padding, widgetHeight);
1452 }
1453
1454 void KStandardItemListWidget::updateDetailsLayoutTextCache()
1455 {
1456     // Precondition: Requires already updated m_expansionArea
1457     // to determine the left position.
1458
1459     // +------+
1460     // | Icon |  Name role   Additional role 1   Additional role 2
1461     // +------+
1462     // Mirror the above for right-to-left languages.
1463     const bool isLeftToRight = QApplication::layoutDirection() == Qt::LeftToRight;
1464     m_textRect = QRectF();
1465
1466     const KItemListStyleOption &option = styleOption();
1467     const QHash<QByteArray, QVariant> values = data();
1468
1469     const qreal widgetHeight = size().height();
1470     const int fontHeight = m_customizedFontMetrics.height();
1471
1472     const qreal columnWidthInc = columnPadding(option);
1473     qreal firstColumnInc = iconSize();
1474     if (m_supportsItemExpanding) {
1475         firstColumnInc += isLeftToRight ? (m_expansionArea.left() + m_expansionArea.right() + widgetHeight) / 2
1476                                         : ((size().width() - m_expansionArea.left()) + (size().width() - m_expansionArea.right()) + widgetHeight) / 2;
1477     } else {
1478         firstColumnInc += option.padding + (isLeftToRight ? leftPadding() : rightPadding());
1479     }
1480
1481     qreal x = firstColumnInc;
1482     const qreal y = qMax(qreal(option.padding), (widgetHeight - fontHeight) / 2);
1483
1484     for (const QByteArray &role : std::as_const(m_sortedVisibleRoles)) {
1485         QString text = roleText(role, values);
1486
1487         // Elide the text in case it does not fit into the available column-width
1488         qreal requiredWidth = m_customizedFontMetrics.horizontalAdvance(text);
1489         const qreal roleWidth = columnWidth(role);
1490         qreal availableTextWidth = roleWidth - columnWidthInc;
1491
1492         const bool isTextRole = (role == "text");
1493         if (isTextRole) {
1494             text = escapeString(text);
1495             availableTextWidth -= firstColumnInc - (isLeftToRight ? leftPadding() : rightPadding());
1496         }
1497
1498         if (requiredWidth > availableTextWidth) {
1499             text = m_customizedFontMetrics.elidedText(text, Qt::ElideMiddle, availableTextWidth);
1500             requiredWidth = m_customizedFontMetrics.horizontalAdvance(text);
1501         }
1502
1503         TextInfo *textInfo = m_textInfo.value(role);
1504         textInfo->staticText.setText(text);
1505         textInfo->pos = QPointF(isLeftToRight ? (x + columnWidthInc / 2) : (size().width() - (x + columnWidthInc / 2) - requiredWidth), y);
1506         x += roleWidth;
1507
1508         if (isTextRole) {
1509             m_textRect = QRectF(textInfo->pos.x() - option.padding, 0, requiredWidth + 2 * option.padding, size().height());
1510
1511             // The column after the name should always be aligned on the same x-position independent
1512             // from the expansion-level shown in the name column
1513             x -= firstColumnInc - (isLeftToRight ? leftPadding() : rightPadding());
1514         } else if (isRoleRightAligned(role) && isLeftToRight) {
1515             textInfo->pos.rx() += roleWidth - requiredWidth - columnWidthInc;
1516         }
1517     }
1518 }
1519
1520 void KStandardItemListWidget::updateAdditionalInfoTextColor()
1521 {
1522     QColor c1;
1523     const bool hasFocus = scene()->views()[0]->parentWidget()->hasFocus();
1524     if (m_customTextColor.isValid()) {
1525         c1 = m_customTextColor;
1526     } else if (isSelected() && hasFocus && (m_layout != DetailsLayout || m_highlightEntireRow)) {
1527         // The detail text color needs to match the main text (HighlightedText) for the same level
1528         // of readability. We short circuit early here to avoid interpolating with another color.
1529         m_additionalInfoTextColor = styleOption().palette.color(QPalette::HighlightedText);
1530         return;
1531     } else {
1532         c1 = styleOption().palette.text().color();
1533     }
1534
1535     // For the color of the additional info the inactive text color
1536     // is not used as this might lead to unreadable text for some color schemes. Instead
1537     // the text color c1 is slightly mixed with the background color.
1538     const QColor c2 = styleOption().palette.base().color();
1539     const int p1 = 70;
1540     const int p2 = 100 - p1;
1541     m_additionalInfoTextColor =
1542         QColor((c1.red() * p1 + c2.red() * p2) / 100, (c1.green() * p1 + c2.green() * p2) / 100, (c1.blue() * p1 + c2.blue() * p2) / 100);
1543 }
1544
1545 QPixmap KStandardItemListWidget::addOverlays(const QPixmap &pixmap,
1546                                              const QHash<Qt::Corner, QString> &overlays,
1547                                              const QSize &size,
1548                                              qreal devicePixelRatioF,
1549                                              QIcon::Mode mode) const
1550 {
1551     if (overlays.isEmpty()) {
1552         return pixmap;
1553     }
1554
1555     QHash<Qt::Corner, QIcon> overlayIcons;
1556
1557     for (const auto &[corner, overlay] : overlays.asKeyValueRange()) {
1558         overlayIcons.insert(corner, QIcon::fromTheme(overlay));
1559     }
1560
1561     return KIconUtils::addOverlays(pixmap, overlayIcons).pixmap(size, devicePixelRatioF, mode);
1562 }
1563
1564 void KStandardItemListWidget::drawPixmap(QPainter *painter, const QPixmap &pixmap)
1565 {
1566     if (m_scaledPixmapSize != pixmap.size() / pixmap.devicePixelRatio()) {
1567         const qreal dpr = KItemViewsUtils::devicePixelRatio(this);
1568         QPixmap scaledPixmap = pixmap;
1569         KPixmapModifier::scale(scaledPixmap, m_scaledPixmapSize * dpr);
1570         scaledPixmap.setDevicePixelRatio(dpr);
1571         painter->drawPixmap(m_pixmapPos, scaledPixmap);
1572
1573 #ifdef KSTANDARDITEMLISTWIDGET_DEBUG
1574         painter->setPen(Qt::blue);
1575         painter->drawRect(QRectF(m_pixmapPos, QSizeF(m_scaledPixmapSize)));
1576 #endif
1577     } else {
1578         painter->drawPixmap(m_pixmapPos, pixmap);
1579     }
1580 }
1581
1582 void KStandardItemListWidget::drawSiblingsInformation(QPainter *painter)
1583 {
1584     const int siblingSize = size().height();
1585     const int x = (m_expansionArea.left() + m_expansionArea.right() - siblingSize) / 2;
1586     QRect siblingRect(x, 0, siblingSize, siblingSize);
1587
1588     bool isItemSibling = true;
1589
1590     const QBitArray siblings = siblingsInformation();
1591     QStyleOption option;
1592     const auto normalColor = option.palette.color(normalTextColorRole());
1593     const auto highlightColor = option.palette.color(expansionAreaHovered() ? QPalette::Highlight : normalTextColorRole());
1594     for (int i = siblings.count() - 1; i >= 0; --i) {
1595         option.rect = siblingRect;
1596         option.state = siblings.at(i) ? QStyle::State_Sibling : QStyle::State_None;
1597         if (isItemSibling) {
1598             option.state |= QStyle::State_Item;
1599             if (m_isExpandable) {
1600                 option.state |= QStyle::State_Children;
1601             }
1602             if (data().value("isExpanded").toBool()) {
1603                 option.state |= QStyle::State_Open;
1604             }
1605             option.palette.setColor(QPalette::Text, highlightColor);
1606             isItemSibling = false;
1607         } else {
1608             option.palette.setColor(QPalette::Text, normalColor);
1609         }
1610
1611         style()->drawPrimitive(QStyle::PE_IndicatorBranch, &option, painter);
1612
1613         siblingRect.translate(layoutDirection() == Qt::LeftToRight ? -siblingRect.width() : siblingRect.width(), 0);
1614     }
1615 }
1616
1617 QRectF KStandardItemListWidget::roleEditingRect(const QByteArray &role) const
1618 {
1619     const TextInfo *textInfo = m_textInfo.value(role);
1620     if (!textInfo) {
1621         return QRectF();
1622     }
1623
1624     QRectF rect(textInfo->pos, textInfo->staticText.size());
1625     if (m_layout == DetailsLayout) {
1626         rect.setWidth(columnWidth(role) - rect.x());
1627     }
1628
1629     return rect;
1630 }
1631
1632 void KStandardItemListWidget::closeRoleEditor()
1633 {
1634     disconnect(m_roleEditor, &KItemListRoleEditor::roleEditingCanceled, this, &KStandardItemListWidget::slotRoleEditingCanceled);
1635     disconnect(m_roleEditor, &KItemListRoleEditor::roleEditingFinished, this, &KStandardItemListWidget::slotRoleEditingFinished);
1636
1637     if (m_roleEditor->hasFocus()) {
1638         // If the editing was not ended by a FocusOut event, we have
1639         // to transfer the keyboard focus back to the KItemListContainer.
1640         scene()->views()[0]->parentWidget()->setFocus();
1641     }
1642
1643     if (m_oldRoleEditor) {
1644         m_oldRoleEditor->deleteLater();
1645     }
1646     m_oldRoleEditor = m_roleEditor;
1647     m_roleEditor->hide();
1648     m_roleEditor = nullptr;
1649 }
1650
1651 QPixmap KStandardItemListWidget::pixmapForIcon(const QString &name, const QHash<Qt::Corner, QString> &overlays, const QSize &size, QIcon::Mode mode) const
1652 {
1653     static const QIcon fallbackIcon = QIcon::fromTheme(QStringLiteral("unknown"));
1654     const qreal dpr = KItemViewsUtils::devicePixelRatio(this);
1655
1656     int iconHeight = size.height();
1657     QSize iconSize = QSize(iconHeight, iconHeight);
1658
1659     const QString key = "KStandardItemListWidget:" % name % ":" % overlays.values().join(QLatin1Char(':')) % ":" % QString::number(iconHeight) % "@"
1660         % QString::number(dpr) % ":" % QString::number(mode);
1661     QPixmap pixmap;
1662
1663     if (!QPixmapCache::find(key, &pixmap)) {
1664         QIcon icon = QIcon::fromTheme(name);
1665         if (icon.isNull()) {
1666             icon = QIcon(name);
1667         }
1668         if (!icon.isNull()) {
1669             pixmap = icon.pixmap(iconSize, dpr, mode);
1670         }
1671         if (pixmap.isNull()) {
1672             icon = fallbackIcon;
1673             pixmap = icon.pixmap(iconSize, dpr, mode);
1674         }
1675         if (pixmap.width() != iconHeight * dpr || pixmap.height() != iconHeight * dpr) {
1676             KPixmapModifier::scale(pixmap, iconSize * dpr);
1677         }
1678
1679         pixmap = addOverlays(pixmap, overlays, size, dpr, mode);
1680
1681         QPixmapCache::insert(key, pixmap);
1682     }
1683     pixmap.setDevicePixelRatio(dpr);
1684
1685     return pixmap;
1686 }
1687
1688 QSizeF KStandardItemListWidget::preferredRatingSize(const KItemListStyleOption &option)
1689 {
1690     const qreal height = option.fontMetrics.ascent();
1691     return QSizeF(height * 5, height);
1692 }
1693
1694 qreal KStandardItemListWidget::columnPadding(const KItemListStyleOption &option)
1695 {
1696     return option.padding * 6;
1697 }
1698
1699 #include "moc_kstandarditemlistwidget.cpp"