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