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