2 * SPDX-FileCopyrightText: 2012 Peter Penz <peter.penz19@gmail.com>
4 * SPDX-License-Identifier: GPL-2.0-or-later
7 #include "kstandarditemlistwidget.h"
9 #include "kfileitemlistview.h"
10 #include "private/kfileitemclipboard.h"
11 #include "private/kitemlistroleeditor.h"
12 #include "private/kitemviewsutils.h"
13 #include "private/kpixmapmodifier.h"
15 #include <KIconEffect>
16 #include <KIconLoader>
18 #include <KRatingPainter>
19 #include <KStringHandler>
20 #include <klocalizedstring.h>
22 #include <QApplication>
23 #include <QGraphicsScene>
24 #include <QGraphicsSceneResizeEvent>
25 #include <QGraphicsView>
26 #include <QPixmapCache>
27 #include <QStyleOption>
28 #include <QTextBoundaryFinder>
29 #include <QVariantAnimation>
31 // #define KSTANDARDITEMLISTWIDGET_DEBUG
33 KStandardItemListWidgetInformant::KStandardItemListWidgetInformant()
34 : KItemListWidgetInformant()
38 KStandardItemListWidgetInformant::~KStandardItemListWidgetInformant()
42 void KStandardItemListWidgetInformant::calculateItemSizeHints(QVector
<std::pair
<qreal
, bool>> &logicalHeightHints
,
43 qreal
&logicalWidthHint
,
44 const KItemListView
*view
) const
46 switch (static_cast<const KStandardItemListView
*>(view
)->itemLayout()) {
47 case KStandardItemListView::IconsLayout
:
48 calculateIconsLayoutItemSizeHints(logicalHeightHints
, logicalWidthHint
, view
);
51 case KStandardItemListView::CompactLayout
:
52 calculateCompactLayoutItemSizeHints(logicalHeightHints
, logicalWidthHint
, view
);
55 case KStandardItemListView::DetailsLayout
:
56 calculateDetailsLayoutItemSizeHints(logicalHeightHints
, logicalWidthHint
, view
);
65 qreal
KStandardItemListWidgetInformant::preferredRoleColumnWidth(const QByteArray
&role
, int index
, const KItemListView
*view
) const
67 const QHash
<QByteArray
, QVariant
> values
= view
->model()->data(index
);
68 const KItemListStyleOption
&option
= view
->styleOption();
70 const QString text
= roleText(role
, values
);
71 qreal width
= KStandardItemListWidget::columnPadding(option
);
73 const QFontMetrics
&normalFontMetrics
= option
.fontMetrics
;
74 const QFontMetrics
linkFontMetrics(customizedFontForLinks(option
.font
));
76 if (role
== "rating") {
77 width
+= KStandardItemListWidget::preferredRatingSize(option
).width();
79 // If current item is a link, we use the customized link font metrics instead of the normal font metrics.
80 const QFontMetrics
&fontMetrics
= itemIsLink(index
, view
) ? linkFontMetrics
: normalFontMetrics
;
82 width
+= fontMetrics
.horizontalAdvance(text
);
85 if (view
->supportsItemExpanding()) {
86 // Increase the width by the expansion-toggle and the current expansion level
87 const int expandedParentsCount
= values
.value("expandedParentsCount", 0).toInt();
88 const qreal height
= option
.padding
* 2 + qMax(option
.iconSize
, fontMetrics
.height());
89 width
+= (expandedParentsCount
+ 1) * height
;
92 // Increase the width by the required space for the icon
93 width
+= option
.padding
* 2 + option
.iconSize
;
100 QString
KStandardItemListWidgetInformant::itemText(int index
, const KItemListView
*view
) const
102 return view
->model()->data(index
).value("text").toString();
105 bool KStandardItemListWidgetInformant::itemIsLink(int index
, const KItemListView
*view
) const
112 QString
KStandardItemListWidgetInformant::roleText(const QByteArray
&role
, const QHash
<QByteArray
, QVariant
> &values
, ForUsageAs forUsageAs
) const
114 if (role
== "rating") {
115 if (forUsageAs
== ForUsageAs::DisplayedText
) {
116 // Always use an empty text, as the rating is shown by the image m_rating.
119 const int rating
{values
.value(role
).toInt()};
120 // Check if there are half stars
122 return i18ncp("@accessible rating", "%1 and a half stars", "%1 and a half stars", rating
/ 2);
124 return i18ncp("@accessible rating", "%1 star", "%1 stars", rating
/ 2);
127 return values
.value(role
).toString();
130 QFont
KStandardItemListWidgetInformant::customizedFontForLinks(const QFont
&baseFont
) const
135 void KStandardItemListWidgetInformant::calculateIconsLayoutItemSizeHints(QVector
<std::pair
<qreal
, bool>> &logicalHeightHints
,
136 qreal
&logicalWidthHint
,
137 const KItemListView
*view
) const
139 const KItemListStyleOption
&option
= view
->styleOption();
140 const QFont
&normalFont
= option
.font
;
141 const int additionalRolesCount
= qMax(view
->visibleRoles().count() - 1, 0);
143 const qreal itemWidth
= view
->itemSize().width();
144 const qreal maxWidth
= itemWidth
- 2 * option
.padding
;
145 const qreal additionalRolesSpacing
= additionalRolesCount
* option
.fontMetrics
.lineSpacing();
146 const qreal spacingAndIconHeight
= option
.iconSize
+ option
.padding
* 3;
148 const QFont linkFont
= customizedFontForLinks(normalFont
);
150 QTextOption
textOption(Qt::AlignHCenter
);
151 textOption
.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere
);
153 for (int index
= 0; index
< logicalHeightHints
.count(); ++index
) {
154 if (logicalHeightHints
.at(index
).first
> 0.0) {
158 // If the current item is a link, we use the customized link font instead of the normal font.
159 const QFont
&font
= itemIsLink(index
, view
) ? linkFont
: normalFont
;
161 const QString
&text
= KStringHandler::preProcessWrap(itemText(index
, view
));
163 // Calculate the number of lines required for wrapping the name
164 qreal textHeight
= 0;
165 QTextLayout
layout(text
, font
);
166 layout
.setTextOption(textOption
);
167 layout
.beginLayout();
170 bool isElided
= false;
171 while ((line
= layout
.createLine()).isValid()) {
172 line
.setLineWidth(maxWidth
);
173 line
.naturalTextWidth();
174 textHeight
+= line
.height();
177 if (lineCount
== option
.maxTextLines
) {
178 isElided
= layout
.createLine().isValid();
184 // Add one line for each additional information
185 textHeight
+= additionalRolesSpacing
;
187 logicalHeightHints
[index
].first
= textHeight
+ spacingAndIconHeight
;
188 logicalHeightHints
[index
].second
= isElided
;
191 logicalWidthHint
= itemWidth
;
194 void KStandardItemListWidgetInformant::calculateCompactLayoutItemSizeHints(QVector
<std::pair
<qreal
, bool>> &logicalHeightHints
,
195 qreal
&logicalWidthHint
,
196 const KItemListView
*view
) const
198 const KItemListStyleOption
&option
= view
->styleOption();
199 const QFontMetrics
&normalFontMetrics
= option
.fontMetrics
;
200 const int additionalRolesCount
= qMax(view
->visibleRoles().count() - 1, 0);
202 const QList
<QByteArray
> &visibleRoles
= view
->visibleRoles();
203 const bool showOnlyTextRole
= (visibleRoles
.count() == 1) && (visibleRoles
.first() == "text");
204 const qreal maxWidth
= option
.maxTextWidth
;
205 const qreal paddingAndIconWidth
= option
.padding
* 4 + option
.iconSize
;
206 const qreal height
= option
.padding
* 2 + qMax(option
.iconSize
, (1 + additionalRolesCount
) * normalFontMetrics
.lineSpacing());
208 const QFontMetrics
linkFontMetrics(customizedFontForLinks(option
.font
));
210 for (int index
= 0; index
< logicalHeightHints
.count(); ++index
) {
211 if (logicalHeightHints
.at(index
).first
> 0.0) {
215 // If the current item is a link, we use the customized link font metrics instead of the normal font metrics.
216 const QFontMetrics
&fontMetrics
= itemIsLink(index
, view
) ? linkFontMetrics
: normalFontMetrics
;
218 // For each row exactly one role is shown. Calculate the maximum required width that is necessary
219 // to show all roles without horizontal clipping.
220 qreal maximumRequiredWidth
= 0.0;
222 if (showOnlyTextRole
) {
223 maximumRequiredWidth
= fontMetrics
.horizontalAdvance(itemText(index
, view
));
225 const QHash
<QByteArray
, QVariant
> &values
= view
->model()->data(index
);
226 for (const QByteArray
&role
: visibleRoles
) {
227 const QString
&text
= roleText(role
, values
);
228 const qreal requiredWidth
= fontMetrics
.horizontalAdvance(text
);
229 maximumRequiredWidth
= qMax(maximumRequiredWidth
, requiredWidth
);
233 qreal width
= paddingAndIconWidth
+ maximumRequiredWidth
;
234 if (maxWidth
> 0 && width
> maxWidth
) {
238 logicalHeightHints
[index
].first
= width
;
241 logicalWidthHint
= height
;
244 void KStandardItemListWidgetInformant::calculateDetailsLayoutItemSizeHints(QVector
<std::pair
<qreal
, bool>> &logicalHeightHints
,
245 qreal
&logicalWidthHint
,
246 const KItemListView
*view
) const
248 const KItemListStyleOption
&option
= view
->styleOption();
249 const qreal height
= option
.padding
* 2 + qMax(option
.iconSize
, option
.fontMetrics
.height());
250 logicalHeightHints
.fill(std::make_pair(height
, false));
251 logicalWidthHint
= -1.0;
254 KStandardItemListWidget::KStandardItemListWidget(KItemListWidgetInformant
*informant
, QGraphicsItem
*parent
)
255 : KItemListWidget(informant
, parent
)
260 , m_customizedFontMetrics(m_customizedFont
)
261 , m_isExpandable(false)
262 , m_highlightEntireRow(false)
263 , m_supportsItemExpanding(false)
264 , m_dirtyLayout(true)
265 , m_dirtyContent(true)
266 , m_dirtyContentRoles()
267 , m_layout(IconsLayout
)
270 , m_scaledPixmapSize()
275 , m_sortedVisibleRoles()
277 , m_customTextColor()
278 , m_additionalInfoTextColor()
281 , m_roleEditor(nullptr)
282 , m_oldRoleEditor(nullptr)
286 KStandardItemListWidget::~KStandardItemListWidget()
288 qDeleteAll(m_textInfo
);
292 m_roleEditor
->deleteLater();
295 if (m_oldRoleEditor
) {
296 m_oldRoleEditor
->deleteLater();
300 void KStandardItemListWidget::setLayout(Layout layout
)
302 if (m_layout
!= layout
) {
304 m_dirtyLayout
= true;
305 updateAdditionalInfoTextColor();
310 void KStandardItemListWidget::setHighlightEntireRow(bool highlightEntireRow
)
312 if (m_highlightEntireRow
!= highlightEntireRow
) {
313 m_highlightEntireRow
= highlightEntireRow
;
314 m_dirtyLayout
= true;
319 bool KStandardItemListWidget::highlightEntireRow() const
321 return m_highlightEntireRow
;
324 void KStandardItemListWidget::setSupportsItemExpanding(bool supportsItemExpanding
)
326 if (m_supportsItemExpanding
!= supportsItemExpanding
) {
327 m_supportsItemExpanding
= supportsItemExpanding
;
328 m_dirtyLayout
= true;
333 bool KStandardItemListWidget::supportsItemExpanding() const
335 return m_supportsItemExpanding
;
338 void KStandardItemListWidget::paint(QPainter
*painter
, const QStyleOptionGraphicsItem
*option
, QWidget
*widget
)
340 const_cast<KStandardItemListWidget
*>(this)->triggerCacheRefreshing();
342 KItemListWidget::paint(painter
, option
, widget
);
344 if (!m_expansionArea
.isEmpty()) {
345 drawSiblingsInformation(painter
);
348 auto pixmap
= isHovered() ? m_hoverPixmap
: m_pixmap
;
349 if (!m_overlays
.isEmpty()) {
350 const qreal dpr
= KItemViewsUtils::devicePixelRatio(this);
352 const bool iconOnTop
= (m_layout
== IconsLayout
);
353 const KItemListStyleOption
&option
= styleOption();
354 const qreal padding
= option
.padding
;
356 const int widgetIconSize
= iconSize();
357 const int maxIconWidth
= iconOnTop
? size().width() - 2 * padding
: widgetIconSize
;
358 const int maxIconHeight
= widgetIconSize
;
360 pixmap
= addOverlays(pixmap
, m_overlays
, QSize(maxIconWidth
, maxIconHeight
), dpr
);
363 const KItemListStyleOption
&itemListStyleOption
= styleOption();
364 if (isHovered() && !pixmap
.isNull()) {
365 if (hoverOpacity() < 1.0) {
367 * Linear interpolation between pixmap and m_hoverPixmap.
369 * Note that this cannot be achieved by painting m_hoverPixmap over
370 * pixmap, even if the opacities are adjusted. For details see
371 * https://git.reviewboard.kde.org/r/109614/
373 // Paint pixmap1 so that pixmap1 = pixmap * (1.0 - hoverOpacity())
374 QPixmap
pixmap1(pixmap
.size());
375 pixmap1
.setDevicePixelRatio(pixmap
.devicePixelRatio());
376 pixmap1
.fill(Qt::transparent
);
378 QPainter
p(&pixmap1
);
379 p
.setOpacity(1.0 - hoverOpacity());
380 p
.drawPixmap(0, 0, pixmap
);
383 // Paint pixmap2 so that pixmap2 = m_hoverPixmap * hoverOpacity()
384 QPixmap
pixmap2(pixmap1
.size());
385 pixmap2
.setDevicePixelRatio(pixmap1
.devicePixelRatio());
386 pixmap2
.fill(Qt::transparent
);
388 QPainter
p(&pixmap2
);
389 p
.setOpacity(hoverOpacity());
390 p
.drawPixmap(0, 0, m_hoverPixmap
);
393 // Paint pixmap2 on pixmap1 using CompositionMode_Plus
394 // Now pixmap1 = pixmap2 + pixmap * (1.0 - hoverOpacity())
395 // = m_hoverPixmap * hoverOpacity() + pixmap * (1.0 - hoverOpacity())
397 QPainter
p(&pixmap1
);
398 p
.setCompositionMode(QPainter::CompositionMode_Plus
);
399 p
.drawPixmap(0, 0, pixmap2
);
402 // Finally paint pixmap1 on the widget
403 drawPixmap(painter
, pixmap1
);
405 drawPixmap(painter
, pixmap
);
407 } else if (!pixmap
.isNull()) {
408 drawPixmap(painter
, pixmap
);
411 painter
->setFont(m_customizedFont
);
412 painter
->setPen(textColor(*widget
));
413 const TextInfo
*textInfo
= m_textInfo
.value("text");
416 // It seems that we can end up here even if m_textInfo does not contain
417 // the key "text", see bug 306167. According to triggerCacheRefreshing(),
418 // this can only happen if the index is negative. This can happen when
419 // the item is about to be removed, see KItemListView::slotItemsRemoved().
420 // TODO: try to reproduce the crash and find a better fix.
424 painter
->drawStaticText(textInfo
->pos
, textInfo
->staticText
);
426 bool clipAdditionalInfoBounds
= false;
427 if (m_supportsItemExpanding
&& m_sortedVisibleRoles
.count() > 1) {
428 // Prevent a possible overlapping of the additional-information-texts with the icon.
429 // This will happen if the user has resized the width of the name-column to be very narrow while having folders expanded.
430 // We only want to draw additional info text outside the area of the icon or expansion area, so we set a clip rect that does not contain the icon area.
431 // This needs to work both for left-to-right as well as right-to-left layout directions.
432 const TextInfo
*potentiallyOverlappingRoleText
= m_textInfo
.value(m_sortedVisibleRoles
[1]); // Only the first column after the name column can overlap.
433 if (layoutDirection() == Qt::LeftToRight
) { // In left-to-right languages the left end of text would overlap. This is mirrored for right-to-left.
434 const qreal minX
= m_iconRect
.right() + 2 * itemListStyleOption
.padding
;
435 if (potentiallyOverlappingRoleText
->pos
.x() < minX
) {
436 clipAdditionalInfoBounds
= true;
438 painter
->setClipRect(minX
, 0, size().width() - minX
, size().height(), Qt::IntersectClip
);
441 const qreal maxX
= m_iconRect
.left() - 2 * itemListStyleOption
.padding
;
442 if (potentiallyOverlappingRoleText
->pos
.x() + m_customizedFontMetrics
.horizontalAdvance(potentiallyOverlappingRoleText
->staticText
.text()) > maxX
) {
443 clipAdditionalInfoBounds
= true;
445 painter
->setClipRect(0, 0, maxX
, size().height(), Qt::IntersectClip
);
450 painter
->setPen(m_additionalInfoTextColor
);
451 painter
->setFont(m_customizedFont
);
453 for (int i
= 1; i
< m_sortedVisibleRoles
.count(); ++i
) {
454 const TextInfo
*textInfo
= m_textInfo
.value(m_sortedVisibleRoles
[i
]);
455 painter
->drawStaticText(textInfo
->pos
, textInfo
->staticText
);
458 if (!m_rating
.isNull()) {
459 const TextInfo
*ratingTextInfo
= m_textInfo
.value("rating");
460 QPointF pos
= ratingTextInfo
->pos
;
461 const Qt::Alignment align
= ratingTextInfo
->staticText
.textOption().alignment();
462 if (align
& Qt::AlignHCenter
) {
463 pos
.rx() += (size().width() - m_rating
.width() / m_rating
.devicePixelRatioF()) / 2 - 2;
465 painter
->drawPixmap(pos
, m_rating
);
468 if (clipAdditionalInfoBounds
) {
472 #ifdef KSTANDARDITEMLISTWIDGET_DEBUG
473 painter
->setBrush(Qt::NoBrush
);
474 painter
->setPen(Qt::green
);
475 painter
->drawRect(m_iconRect
);
477 painter
->setPen(Qt::blue
);
478 painter
->drawRect(m_textRect
);
480 painter
->setPen(Qt::red
);
481 painter
->drawText(QPointF(0, m_customizedFontMetrics
.height()), QString::number(index()));
482 painter
->drawRect(rect());
486 QRectF
KStandardItemListWidget::iconRect() const
488 const_cast<KStandardItemListWidget
*>(this)->triggerCacheRefreshing();
492 QRectF
KStandardItemListWidget::textRect() const
494 const_cast<KStandardItemListWidget
*>(this)->triggerCacheRefreshing();
498 QRectF
KStandardItemListWidget::textFocusRect() const
500 // In the compact- and details-layout a larger textRect() is returned to be aligned
501 // with the iconRect(). This is useful to have a larger selection/hover-area
502 // when having a quite large icon size but only one line of text. Still the
503 // focus rectangle should be shown as narrow as possible around the text.
505 const_cast<KStandardItemListWidget
*>(this)->triggerCacheRefreshing();
508 case CompactLayout
: {
509 QRectF rect
= m_textRect
;
510 const TextInfo
*topText
= m_textInfo
.value(m_sortedVisibleRoles
.first());
511 const TextInfo
*bottomText
= m_textInfo
.value(m_sortedVisibleRoles
.last());
512 rect
.setTop(topText
->pos
.y());
513 rect
.setBottom(bottomText
->pos
.y() + bottomText
->staticText
.size().height());
517 case DetailsLayout
: {
518 QRectF rect
= m_textRect
;
519 const TextInfo
*textInfo
= m_textInfo
.value(m_sortedVisibleRoles
.first());
520 rect
.setTop(textInfo
->pos
.y());
521 rect
.setBottom(textInfo
->pos
.y() + textInfo
->staticText
.size().height());
523 const KItemListStyleOption
&option
= styleOption();
524 if (option
.extendedSelectionRegion
) {
525 const QString text
= textInfo
->staticText
.text();
526 rect
.setWidth(m_customizedFontMetrics
.horizontalAdvance(text
) + 2 * option
.padding
);
539 QRectF
KStandardItemListWidget::selectionRect() const
541 const_cast<KStandardItemListWidget
*>(this)->triggerCacheRefreshing();
548 case DetailsLayout
: {
549 const int padding
= styleOption().padding
;
550 QRectF adjustedIconRect
= iconRect().adjusted(-padding
, -padding
, padding
, padding
);
551 QRectF result
= adjustedIconRect
| m_textRect
;
552 if (m_highlightEntireRow
) {
553 if (layoutDirection() == Qt::LeftToRight
) {
554 result
.setRight(leftPadding() + m_columnWidthSum
);
556 result
.setLeft(size().width() - m_columnWidthSum
- rightPadding());
570 QRectF
KStandardItemListWidget::expansionToggleRect() const
572 const_cast<KStandardItemListWidget
*>(this)->triggerCacheRefreshing();
573 return m_isExpandable
? m_expansionArea
: QRectF();
576 QRectF
KStandardItemListWidget::selectionToggleRect() const
578 const_cast<KStandardItemListWidget
*>(this)->triggerCacheRefreshing();
580 const QRectF widgetIconRect
= iconRect();
581 const int widgetIconSize
= iconSize();
582 int toggleSize
= KIconLoader::SizeSmall
;
583 if (widgetIconSize
>= KIconLoader::SizeEnormous
) {
584 toggleSize
= KIconLoader::SizeMedium
;
585 } else if (widgetIconSize
>= KIconLoader::SizeLarge
) {
586 toggleSize
= KIconLoader::SizeSmallMedium
;
589 QPointF pos
= widgetIconRect
.topLeft();
591 // If the selection toggle has a very small distance to the
592 // widget borders, the size of the selection toggle will get
593 // increased to prevent an accidental clicking of the item
594 // when trying to hit the toggle.
595 const int widgetHeight
= size().height();
596 const int widgetWidth
= size().width();
597 const int minMargin
= 2;
599 if (toggleSize
+ minMargin
* 2 >= widgetHeight
) {
600 pos
.rx() -= (widgetHeight
- toggleSize
) / 2;
601 toggleSize
= widgetHeight
;
604 if (toggleSize
+ minMargin
* 2 >= widgetWidth
) {
605 pos
.ry() -= (widgetWidth
- toggleSize
) / 2;
606 toggleSize
= widgetWidth
;
610 if (QApplication::isRightToLeft()) {
611 pos
.setX(widgetIconRect
.right() - (pos
.x() + toggleSize
- widgetIconRect
.left()));
614 return QRectF(pos
, QSizeF(toggleSize
, toggleSize
));
617 QPixmap
KStandardItemListWidget::createDragPixmap(const QStyleOptionGraphicsItem
*option
, QWidget
*widget
)
619 QPixmap pixmap
= KItemListWidget::createDragPixmap(option
, widget
);
620 if (m_layout
!= DetailsLayout
) {
624 // Only return the content of the text-column as pixmap
625 const int leftClip
= m_pixmapPos
.x();
627 const TextInfo
*textInfo
= m_textInfo
.value("text");
628 const int rightClip
= textInfo
->pos
.x() + textInfo
->staticText
.size().width() + 2 * styleOption().padding
;
630 QPixmap
clippedPixmap(rightClip
- leftClip
+ 1, pixmap
.height());
631 clippedPixmap
.fill(Qt::transparent
);
633 QPainter
painter(&clippedPixmap
);
634 painter
.drawPixmap(-leftClip
, 0, pixmap
);
636 return clippedPixmap
;
639 void KStandardItemListWidget::startActivateSoonAnimation(int timeUntilActivation
)
641 if (m_activateSoonAnimation
) {
642 m_activateSoonAnimation
->stop(); // automatically DeleteWhenStopped
645 m_activateSoonAnimation
= new QVariantAnimation
{this};
646 m_activateSoonAnimation
->setStartValue(0.0);
647 m_activateSoonAnimation
->setEndValue(1.0);
648 m_activateSoonAnimation
->setDuration(timeUntilActivation
);
650 const QVariant originalIconName
{data()["iconName"]};
651 connect(m_activateSoonAnimation
, &QVariantAnimation::valueChanged
, this, [originalIconName
, this](const QVariant
&value
) {
652 auto progress
= value
.toFloat();
654 QVariant wantedIconName
;
655 if (progress
< 0.333) {
656 wantedIconName
= "folder-open";
657 } else if (progress
< 0.666) {
658 wantedIconName
= originalIconName
;
660 wantedIconName
= "folder-open";
663 QHash
<QByteArray
, QVariant
> itemData
{data()};
664 if (itemData
["iconName"] != wantedIconName
) {
665 itemData
.insert("iconName", wantedIconName
);
667 invalidateIconCache();
671 connect(m_activateSoonAnimation
, &QObject::destroyed
, this, [originalIconName
, this]() {
672 QHash
<QByteArray
, QVariant
> itemData
{data()};
673 if (itemData
["iconName"] == "folder-open") {
674 itemData
.insert("iconName", originalIconName
);
676 invalidateIconCache();
680 m_activateSoonAnimation
->start(QAbstractAnimation::DeleteWhenStopped
);
683 bool KStandardItemListWidget::isIconControlledByActivateSoonAnimation() const
685 return m_activateSoonAnimation
&& data()["iconName"] == "folder-open";
688 KItemListWidgetInformant
*KStandardItemListWidget::createInformant()
690 return new KStandardItemListWidgetInformant();
693 void KStandardItemListWidget::invalidateCache()
695 m_dirtyLayout
= true;
696 m_dirtyContent
= true;
699 void KStandardItemListWidget::invalidateIconCache()
701 m_dirtyContent
= true;
702 m_dirtyContentRoles
.insert("iconPixmap");
705 void KStandardItemListWidget::refreshCache()
709 bool KStandardItemListWidget::isRoleRightAligned(const QByteArray
&role
) const
715 bool KStandardItemListWidget::isHidden() const
720 QFont
KStandardItemListWidget::customizedFont(const QFont
&baseFont
) const
725 QPalette::ColorRole
KStandardItemListWidget::normalTextColorRole() const
727 return QPalette::Text
;
730 void KStandardItemListWidget::setTextColor(const QColor
&color
)
732 if (color
!= m_customTextColor
) {
733 m_customTextColor
= color
;
734 updateAdditionalInfoTextColor();
739 QColor
KStandardItemListWidget::textColor(const QWidget
&widget
) const
743 return m_additionalInfoTextColor
;
744 } else if (m_customTextColor
.isValid()) {
745 return m_customTextColor
;
749 const QPalette::ColorGroup group
= isActiveWindow() && widget
.hasFocus() ? QPalette::Active
: QPalette::Inactive
;
750 const QPalette::ColorRole role
= isSelected() ? QPalette::HighlightedText
: normalTextColorRole();
751 return styleOption().palette
.color(group
, role
);
754 void KStandardItemListWidget::setOverlays(QHash
<Qt::Corner
, QString
> &overlays
)
756 if (overlays
== m_overlays
) {
760 m_overlays
= overlays
;
761 m_dirtyContent
= true;
762 m_dirtyContentRoles
.insert("iconOverlays");
766 QHash
<Qt::Corner
, QString
> KStandardItemListWidget::overlays() const
771 QString
KStandardItemListWidget::roleText(const QByteArray
&role
, const QHash
<QByteArray
, QVariant
> &values
) const
773 return static_cast<const KStandardItemListWidgetInformant
*>(informant())->roleText(role
, values
);
776 void KStandardItemListWidget::dataChanged(const QHash
<QByteArray
, QVariant
> ¤t
, const QSet
<QByteArray
> &roles
)
780 m_dirtyContent
= true;
782 QSet
<QByteArray
> dirtyRoles
;
783 if (roles
.isEmpty()) {
784 const auto visibleRoles
= this->visibleRoles();
785 dirtyRoles
= QSet
<QByteArray
>(visibleRoles
.constBegin(), visibleRoles
.constEnd());
790 // The URL might have changed (i.e., if the sort order of the items has
791 // been changed). Therefore, the "is cut" state must be updated.
792 KFileItemClipboard
*clipboard
= KFileItemClipboard::instance();
793 const QUrl itemUrl
= data().value("url").toUrl();
794 m_isCut
= clipboard
->isCut(itemUrl
);
796 // The icon-state might depend from other roles and hence is
797 // marked as dirty whenever a role has been changed
798 dirtyRoles
.insert("iconPixmap");
799 dirtyRoles
.insert("iconName");
801 QSetIterator
<QByteArray
> it(dirtyRoles
);
802 while (it
.hasNext()) {
803 const QByteArray
&role
= it
.next();
804 m_dirtyContentRoles
.insert(role
);
808 void KStandardItemListWidget::visibleRolesChanged(const QList
<QByteArray
> ¤t
, const QList
<QByteArray
> &previous
)
811 m_sortedVisibleRoles
= current
;
812 m_dirtyLayout
= true;
815 void KStandardItemListWidget::columnWidthChanged(const QByteArray
&role
, qreal current
, qreal previous
)
820 m_dirtyLayout
= true;
823 void KStandardItemListWidget::sidePaddingChanged(qreal leftPaddingWidth
, qreal rightPaddingWidth
)
825 Q_UNUSED(leftPaddingWidth
)
826 Q_UNUSED(rightPaddingWidth
)
827 m_dirtyLayout
= true;
830 void KStandardItemListWidget::styleOptionChanged(const KItemListStyleOption
¤t
, const KItemListStyleOption
&previous
)
832 KItemListWidget::styleOptionChanged(current
, previous
);
834 updateAdditionalInfoTextColor();
835 m_dirtyLayout
= true;
838 void KStandardItemListWidget::hoveredChanged(bool hovered
)
840 if (!hovered
&& m_activateSoonAnimation
) {
841 m_activateSoonAnimation
->stop(); // automatically DeleteWhenStopped
843 m_dirtyLayout
= true;
846 void KStandardItemListWidget::selectedChanged(bool selected
)
849 updateAdditionalInfoTextColor();
850 m_dirtyContent
= true;
853 void KStandardItemListWidget::siblingsInformationChanged(const QBitArray
¤t
, const QBitArray
&previous
)
857 m_dirtyLayout
= true;
860 int KStandardItemListWidget::numberOfUnicodeCharactersIn(const QString
&text
)
863 QTextBoundaryFinder
boundaryFinder(QTextBoundaryFinder::Grapheme
, text
);
864 while (boundaryFinder
.toNextBoundary() != -1) {
870 int KStandardItemListWidget::selectionLength(const QString
&text
) const
872 return numberOfUnicodeCharactersIn(text
);
875 void KStandardItemListWidget::editedRoleChanged(const QByteArray
¤t
, const QByteArray
&previous
)
879 QGraphicsView
*parent
= scene()->views()[0];
880 if (current
.isEmpty() || !parent
|| current
!= "text") {
882 Q_EMIT
roleEditingCanceled(index(), current
, data().value(current
));
888 Q_ASSERT(!m_roleEditor
);
890 const TextInfo
*textInfo
= m_textInfo
.value("text");
892 m_roleEditor
= new KItemListRoleEditor(parent
);
893 m_roleEditor
->setRole(current
);
894 m_roleEditor
->setAllowUpDownKeyChainEdit(m_layout
!= IconsLayout
);
895 m_roleEditor
->setFont(styleOption().font
);
897 const QString text
= data().value(current
).toString();
898 m_roleEditor
->setPlainText(text
);
900 QTextOption textOption
= textInfo
->staticText
.textOption();
901 m_roleEditor
->document()->setDefaultTextOption(textOption
);
903 const int textSelectionLength
= selectionLength(text
);
905 if (textSelectionLength
> 0) {
906 QTextCursor cursor
= m_roleEditor
->textCursor();
907 cursor
.movePosition(QTextCursor::StartOfBlock
);
908 cursor
.movePosition(QTextCursor::NextCharacter
, QTextCursor::KeepAnchor
, textSelectionLength
);
909 m_roleEditor
->setTextCursor(cursor
);
912 connect(m_roleEditor
, &KItemListRoleEditor::roleEditingCanceled
, this, &KStandardItemListWidget::slotRoleEditingCanceled
);
913 connect(m_roleEditor
, &KItemListRoleEditor::roleEditingFinished
, this, &KStandardItemListWidget::slotRoleEditingFinished
);
915 // Adjust the geometry of the editor
916 QRectF rect
= roleEditingRect(current
);
917 const int frameWidth
= m_roleEditor
->frameWidth();
918 rect
.adjust(-frameWidth
, -frameWidth
, frameWidth
, frameWidth
);
919 rect
.translate(pos());
920 if (rect
.right() > parent
->width()) {
921 rect
.setWidth(parent
->width() - rect
.left());
923 m_roleEditor
->setGeometry(rect
.toRect());
924 m_roleEditor
->autoAdjustSize();
925 m_roleEditor
->show();
926 m_roleEditor
->setFocus();
929 void KStandardItemListWidget::iconSizeChanged(int current
, int previous
)
931 KItemListWidget::iconSizeChanged(current
, previous
);
933 invalidateIconCache();
934 triggerCacheRefreshing();
938 void KStandardItemListWidget::resizeEvent(QGraphicsSceneResizeEvent
*event
)
941 setEditedRole(QByteArray());
942 Q_ASSERT(!m_roleEditor
);
945 KItemListWidget::resizeEvent(event
);
947 m_dirtyLayout
= true;
950 void KStandardItemListWidget::showEvent(QShowEvent
*event
)
952 KItemListWidget::showEvent(event
);
954 // Listen to changes of the clipboard to mark the item as cut/uncut
955 KFileItemClipboard
*clipboard
= KFileItemClipboard::instance();
957 const QUrl itemUrl
= data().value("url").toUrl();
958 m_isCut
= clipboard
->isCut(itemUrl
);
960 connect(clipboard
, &KFileItemClipboard::cutItemsChanged
, this, &KStandardItemListWidget::slotCutItemsChanged
);
963 void KStandardItemListWidget::hideEvent(QHideEvent
*event
)
965 disconnect(KFileItemClipboard::instance(), &KFileItemClipboard::cutItemsChanged
, this, &KStandardItemListWidget::slotCutItemsChanged
);
967 KItemListWidget::hideEvent(event
);
970 bool KStandardItemListWidget::event(QEvent
*event
)
972 if (event
->type() == QEvent::WindowDeactivate
|| event
->type() == QEvent::WindowActivate
|| event
->type() == QEvent::PaletteChange
) {
973 m_dirtyContent
= true;
976 return KItemListWidget::event(event
);
979 void KStandardItemListWidget::finishRoleEditing()
981 if (!editedRole().isEmpty() && m_roleEditor
) {
982 slotRoleEditingFinished(editedRole(), KIO::encodeFileName(m_roleEditor
->toPlainText()));
986 void KStandardItemListWidget::slotCutItemsChanged()
988 const QUrl itemUrl
= data().value("url").toUrl();
989 const bool isCut
= KFileItemClipboard::instance()->isCut(itemUrl
);
990 if (m_isCut
!= isCut
) {
992 m_pixmap
= QPixmap();
993 m_dirtyContent
= true;
998 void KStandardItemListWidget::slotRoleEditingCanceled(const QByteArray
&role
, const QVariant
&value
)
1001 Q_EMIT
roleEditingCanceled(index(), role
, value
);
1002 setEditedRole(QByteArray());
1005 void KStandardItemListWidget::slotRoleEditingFinished(const QByteArray
&role
, const QVariant
&value
)
1008 Q_EMIT
roleEditingFinished(index(), role
, value
);
1009 setEditedRole(QByteArray());
1012 void KStandardItemListWidget::triggerCacheRefreshing()
1014 if ((!m_dirtyContent
&& !m_dirtyLayout
) || index() < 0) {
1020 const QHash
<QByteArray
, QVariant
> values
= data();
1021 m_isExpandable
= m_supportsItemExpanding
&& values
["isExpandable"].toBool();
1022 m_isHidden
= isHidden();
1023 m_customizedFont
= customizedFont(styleOption().font
);
1024 m_customizedFontMetrics
= QFontMetrics(m_customizedFont
);
1025 m_columnWidthSum
= std::accumulate(m_sortedVisibleRoles
.begin(), m_sortedVisibleRoles
.end(), qreal(), [this](qreal sum
, const auto &role
) {
1026 return sum
+ columnWidth(role
);
1029 updateExpansionArea();
1031 updatePixmapCache();
1034 m_dirtyLayout
= false;
1035 m_dirtyContent
= false;
1036 m_dirtyContentRoles
.clear();
1039 void KStandardItemListWidget::updateExpansionArea()
1041 if (m_supportsItemExpanding
) {
1042 const QHash
<QByteArray
, QVariant
> values
= data();
1043 const int expandedParentsCount
= values
.value("expandedParentsCount", 0).toInt();
1044 if (expandedParentsCount
>= 0) {
1045 const int widgetIconSize
= iconSize();
1046 const qreal widgetHeight
= size().height();
1047 const qreal inc
= (widgetHeight
- widgetIconSize
) / 2;
1048 const qreal x
= expandedParentsCount
* widgetHeight
+ inc
;
1049 const qreal y
= inc
;
1050 if (layoutDirection() == Qt::LeftToRight
) {
1051 const qreal leftPaddingWidth
= m_highlightEntireRow
? leftPadding() : 0;
1052 m_expansionArea
= QRectF(leftPaddingWidth
+ x
, y
, widgetIconSize
, widgetIconSize
);
1055 const qreal rightPaddingWidth
= m_highlightEntireRow
? rightPadding() : 0;
1056 m_expansionArea
= QRectF(size().width() - rightPaddingWidth
- x
- widgetIconSize
, y
, widgetIconSize
, widgetIconSize
);
1061 m_expansionArea
= QRectF();
1064 void KStandardItemListWidget::updatePixmapCache()
1066 // Precondition: Requires already updated m_textPos values to calculate
1067 // the remaining height when the alignment is vertical.
1069 const QSizeF widgetSize
= size();
1070 const bool iconOnTop
= (m_layout
== IconsLayout
);
1071 const KItemListStyleOption
&option
= styleOption();
1072 const qreal padding
= option
.padding
;
1073 const qreal dpr
= KItemViewsUtils::devicePixelRatio(this);
1075 const int widgetIconSize
= iconSize();
1076 const int maxIconWidth
= iconOnTop
? widgetSize
.width() - 2 * padding
: widgetIconSize
;
1077 const int maxIconHeight
= widgetIconSize
;
1079 const QHash
<QByteArray
, QVariant
> values
= data();
1081 bool updatePixmap
= (m_pixmap
.width() != maxIconWidth
|| m_pixmap
.height() != maxIconHeight
);
1082 if (!updatePixmap
&& m_dirtyContent
) {
1083 updatePixmap
= m_dirtyContentRoles
.isEmpty() || m_dirtyContentRoles
.contains("iconPixmap") || m_dirtyContentRoles
.contains("iconName")
1084 || m_dirtyContentRoles
.contains("iconOverlays");
1088 m_pixmap
= QPixmap();
1090 int sequenceIndex
= hoverSequenceIndex();
1092 if (values
.contains("hoverSequencePixmaps") && !isIconControlledByActivateSoonAnimation()) {
1093 // Use one of the hover sequence pixmaps instead of the default
1096 const QVector
<QPixmap
> pixmaps
= values
["hoverSequencePixmaps"].value
<QVector
<QPixmap
>>();
1098 if (values
.contains("hoverSequenceWraparoundPoint")) {
1099 const float wap
= values
["hoverSequenceWraparoundPoint"].toFloat();
1101 sequenceIndex
%= static_cast<int>(wap
);
1105 const int loadedIndex
= qMax(qMin(sequenceIndex
, pixmaps
.size() - 1), 0);
1107 if (loadedIndex
!= 0) {
1108 m_pixmap
= pixmaps
[loadedIndex
];
1112 if (m_pixmap
.isNull() && !isIconControlledByActivateSoonAnimation()) {
1113 m_pixmap
= values
["iconPixmap"].value
<QPixmap
>();
1116 if (m_pixmap
.isNull()) {
1117 // Use the icon that fits to the MIME-type
1118 QString iconName
= values
["iconName"].toString();
1119 if (iconName
.isEmpty()) {
1120 // The icon-name has not been not resolved by KFileItemModelRolesUpdater,
1121 // use a generic icon as fallback
1122 iconName
= QStringLiteral("unknown");
1124 const QStringList overlays
= values
["iconOverlays"].toStringList();
1125 const bool hasFocus
= scene()->views()[0]->parentWidget()->hasFocus();
1126 m_pixmap
= pixmapForIcon(iconName
,
1127 QSize(maxIconWidth
, maxIconHeight
),
1128 m_layout
!= IconsLayout
&& isActiveWindow() && isSelected() && hasFocus
? QIcon::Selected
: QIcon::Normal
);
1131 if (m_pixmap
.width() / m_pixmap
.devicePixelRatio() != maxIconWidth
|| m_pixmap
.height() / m_pixmap
.devicePixelRatio() != maxIconHeight
) {
1132 // A custom pixmap has been applied. Assure that the pixmap
1133 // is scaled to the maximum available size.
1134 KPixmapModifier::scale(m_pixmap
, QSize(maxIconWidth
, maxIconHeight
) * dpr
);
1138 if (m_pixmap
.isNull()) {
1139 m_hoverPixmap
= QPixmap();
1144 KIconEffect::toDisabled(m_pixmap
);
1148 KIconEffect::semiTransparent(m_pixmap
);
1151 if (m_layout
== IconsLayout
&& isSelected()) {
1152 const QColor color
= palette().brush(QPalette::Normal
, QPalette::Highlight
).color();
1153 QImage image
= m_pixmap
.toImage();
1154 if (image
.isNull()) {
1155 m_hoverPixmap
= QPixmap();
1158 KIconEffect::colorize(image
, color
, 0.8f
);
1159 m_pixmap
= QPixmap::fromImage(image
);
1163 int scaledIconSize
= 0;
1165 const TextInfo
*textInfo
= m_textInfo
.value("text");
1166 scaledIconSize
= static_cast<int>(textInfo
->pos
.y() - 2 * padding
);
1168 const int textRowsCount
= (m_layout
== CompactLayout
) ? visibleRoles().count() : 1;
1169 const qreal requiredTextHeight
= textRowsCount
* m_customizedFontMetrics
.height();
1170 scaledIconSize
= (requiredTextHeight
< maxIconHeight
) ? widgetSize
.height() - 2 * padding
: maxIconHeight
;
1173 const int maxScaledIconWidth
= iconOnTop
? widgetSize
.width() - 2 * padding
: scaledIconSize
;
1174 const int maxScaledIconHeight
= scaledIconSize
;
1176 m_scaledPixmapSize
= m_pixmap
.size();
1177 m_scaledPixmapSize
.scale(maxScaledIconWidth
* dpr
, maxScaledIconHeight
* dpr
, Qt::KeepAspectRatio
);
1178 m_scaledPixmapSize
= m_scaledPixmapSize
/ dpr
;
1181 // Center horizontally and align on bottom within the icon-area
1182 m_pixmapPos
.setX((widgetSize
.width() - m_scaledPixmapSize
.width()) / 2.0);
1183 m_pixmapPos
.setY(padding
+ scaledIconSize
- m_scaledPixmapSize
.height());
1185 // Center horizontally and vertically within the icon-area
1186 const TextInfo
*textInfo
= m_textInfo
.value("text");
1187 if (QApplication::isRightToLeft()) {
1188 m_pixmapPos
.setX(m_textRect
.right() + 2.0 * padding
);
1190 m_pixmapPos
.setX(textInfo
->pos
.x() - 2.0 * padding
- (scaledIconSize
+ m_scaledPixmapSize
.width()) / 2.0);
1193 // Derive icon's vertical center from the center of the text frame, including
1194 // any necessary adjustment if the font's midline is offset from the frame center
1195 const qreal midlineShift
= m_customizedFontMetrics
.height() / 2.0 - m_customizedFontMetrics
.descent() - m_customizedFontMetrics
.capHeight() / 2.0;
1196 m_pixmapPos
.setY(m_textRect
.center().y() + midlineShift
- m_scaledPixmapSize
.height() / 2.0);
1199 if (m_layout
== IconsLayout
) {
1200 m_iconRect
= QRectF(m_pixmapPos
, QSizeF(m_scaledPixmapSize
));
1202 const qreal widthOffset
= widgetIconSize
- m_scaledPixmapSize
.width();
1203 const qreal heightOffset
= widgetIconSize
- m_scaledPixmapSize
.height();
1204 const QPointF
squareIconPos(m_pixmapPos
.x() - 0.5 * widthOffset
, m_pixmapPos
.y() - 0.5 * heightOffset
);
1205 const QSizeF
squareIconSize(widgetIconSize
, widgetIconSize
);
1206 m_iconRect
= QRectF(squareIconPos
, squareIconSize
);
1209 // Prepare the pixmap that is used when the item gets hovered
1211 m_hoverPixmap
= m_pixmap
;
1212 KIconEffect::toActive(m_hoverPixmap
);
1213 } else if (hoverOpacity() <= 0.0) {
1214 // No hover animation is ongoing. Clear m_hoverPixmap to save memory.
1215 m_hoverPixmap
= QPixmap();
1219 void KStandardItemListWidget::updateTextsCache()
1221 QTextOption textOption
;
1224 textOption
.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere
);
1225 textOption
.setAlignment(Qt::AlignHCenter
);
1228 textOption
.setAlignment(QApplication::isRightToLeft() ? Qt::AlignRight
: Qt::AlignLeft
);
1229 textOption
.setWrapMode(QTextOption::NoWrap
);
1232 textOption
.setAlignment(Qt::AlignLeft
);
1233 textOption
.setWrapMode(QTextOption::NoWrap
);
1240 qDeleteAll(m_textInfo
);
1242 for (int i
= 0; i
< m_sortedVisibleRoles
.count(); ++i
) {
1243 TextInfo
*textInfo
= new TextInfo();
1244 textInfo
->staticText
.setTextFormat(Qt::PlainText
);
1245 textInfo
->staticText
.setPerformanceHint(QStaticText::AggressiveCaching
);
1246 textInfo
->staticText
.setTextOption(textOption
);
1247 m_textInfo
.insert(m_sortedVisibleRoles
[i
], textInfo
);
1252 updateIconsLayoutTextCache();
1255 updateCompactLayoutTextCache();
1258 updateDetailsLayoutTextCache();
1265 const TextInfo
*ratingTextInfo
= m_textInfo
.value("rating");
1266 if (ratingTextInfo
) {
1267 // The text of the rating-role has been set to empty to get
1268 // replaced by a rating-image showing the rating as stars.
1269 const KItemListStyleOption
&option
= styleOption();
1270 QSizeF ratingSize
= preferredRatingSize(option
);
1272 const qreal availableWidth
= (m_layout
== DetailsLayout
) ? columnWidth("rating") - columnPadding(option
) : size().width();
1273 if (ratingSize
.width() > availableWidth
) {
1274 ratingSize
.rwidth() = availableWidth
;
1276 const qreal dpr
= KItemViewsUtils::devicePixelRatio(this);
1277 m_rating
= QPixmap(ratingSize
.toSize() * dpr
);
1278 m_rating
.setDevicePixelRatio(dpr
);
1279 m_rating
.fill(Qt::transparent
);
1281 QPainter
painter(&m_rating
);
1282 const QRect
rect(QPoint(0, 0), ratingSize
.toSize());
1283 const int rating
= data().value("rating").toInt();
1284 KRatingPainter::paintRating(&painter
, rect
, Qt::AlignJustify
| Qt::AlignVCenter
, rating
);
1285 } else if (!m_rating
.isNull()) {
1286 m_rating
= QPixmap();
1290 QString
KStandardItemListWidget::escapeString(const QString
&text
) const
1292 QString
escaped(text
);
1294 const QChar
returnSymbol(0x21b5);
1295 escaped
.replace('\n', returnSymbol
);
1300 void KStandardItemListWidget::updateIconsLayoutTextCache()
1307 // might get wrapped above
1309 // Additional role 1
1310 // Additional role 2
1312 const QHash
<QByteArray
, QVariant
> values
= data();
1314 const KItemListStyleOption
&option
= styleOption();
1315 const qreal padding
= option
.padding
;
1316 const qreal maxWidth
= size().width() - 2 * padding
;
1317 const qreal lineSpacing
= m_customizedFontMetrics
.lineSpacing();
1319 // Initialize properties for the "text" role. It will be used as anchor
1320 // for initializing the position of the other roles.
1321 TextInfo
*nameTextInfo
= m_textInfo
.value("text");
1322 const QString nameText
= KStringHandler::preProcessWrap(escapeString(values
["text"].toString()));
1323 nameTextInfo
->staticText
.setText(nameText
);
1325 // Calculate the number of lines required for the name and the required width
1326 qreal nameWidth
= 0;
1327 qreal nameHeight
= 0;
1330 QTextLayout
layout(nameTextInfo
->staticText
.text(), m_customizedFont
);
1331 layout
.setTextOption(nameTextInfo
->staticText
.textOption());
1332 layout
.beginLayout();
1333 int nameLineIndex
= 0;
1334 while ((line
= layout
.createLine()).isValid()) {
1335 line
.setLineWidth(maxWidth
);
1336 nameWidth
= qMax(nameWidth
, line
.naturalTextWidth());
1337 nameHeight
+= line
.height();
1340 if (nameLineIndex
== option
.maxTextLines
) {
1341 // The maximum number of textlines has been reached. If this is
1342 // the case provide an elided text if necessary.
1343 const int textLength
= line
.textStart() + line
.textLength();
1344 if (textLength
< nameText
.length()) {
1345 // Elide the last line of the text
1346 qreal elidingWidth
= maxWidth
;
1347 qreal lastLineWidth
;
1349 QString lastTextLine
= nameText
.mid(line
.textStart());
1350 lastTextLine
= m_customizedFontMetrics
.elidedText(lastTextLine
, Qt::ElideMiddle
, elidingWidth
);
1351 const QString elidedText
= nameText
.left(line
.textStart()) + lastTextLine
;
1352 nameTextInfo
->staticText
.setText(elidedText
);
1354 lastLineWidth
= m_customizedFontMetrics
.horizontalAdvance(lastTextLine
);
1356 // We do the text eliding in a loop with decreasing width (1 px / iteration)
1357 // to avoid problems related to different width calculation code paths
1358 // within Qt. (see bug 337104)
1359 elidingWidth
-= 1.0;
1360 } while (lastLineWidth
> maxWidth
);
1362 nameWidth
= qMax(nameWidth
, lastLineWidth
);
1369 // Use one line for each additional information
1370 nameTextInfo
->staticText
.setTextWidth(maxWidth
);
1371 nameTextInfo
->pos
= QPointF(padding
, iconSize() + 2 * padding
);
1372 m_textRect
= QRectF(padding
+ (maxWidth
- nameWidth
) / 2, nameTextInfo
->pos
.y(), nameWidth
, nameHeight
);
1374 // Calculate the position for each additional information
1375 qreal y
= nameTextInfo
->pos
.y() + nameHeight
;
1376 for (const QByteArray
&role
: std::as_const(m_sortedVisibleRoles
)) {
1377 if (role
== "text") {
1381 const QString text
= roleText(role
, values
);
1382 TextInfo
*textInfo
= m_textInfo
.value(role
);
1383 textInfo
->staticText
.setText(text
);
1385 qreal requiredWidth
= 0;
1387 QTextLayout
layout(text
, m_customizedFont
);
1388 QTextOption textOption
;
1389 textOption
.setWrapMode(QTextOption::NoWrap
);
1390 layout
.setTextOption(textOption
);
1392 layout
.beginLayout();
1393 QTextLine textLine
= layout
.createLine();
1394 if (textLine
.isValid()) {
1395 textLine
.setLineWidth(maxWidth
);
1396 requiredWidth
= textLine
.naturalTextWidth();
1397 if (requiredWidth
> maxWidth
) {
1398 const QString elidedText
= m_customizedFontMetrics
.elidedText(text
, Qt::ElideMiddle
, maxWidth
);
1399 textInfo
->staticText
.setText(elidedText
);
1400 requiredWidth
= m_customizedFontMetrics
.horizontalAdvance(elidedText
);
1401 } else if (role
== "rating") {
1402 // Use the width of the rating pixmap, because the rating text is empty.
1403 requiredWidth
= m_rating
.width() / m_rating
.devicePixelRatioF();
1408 textInfo
->pos
= QPointF(padding
, y
);
1409 textInfo
->staticText
.setTextWidth(maxWidth
);
1411 const QRectF
textRect(padding
+ (maxWidth
- requiredWidth
) / 2, y
, requiredWidth
, lineSpacing
);
1413 // Ignore empty roles. Avoids a text rect taller than the area that actually contains text.
1414 if (!textRect
.isEmpty()) {
1415 m_textRect
|= textRect
;
1421 // Add a padding to the text rectangle
1422 m_textRect
.adjust(-padding
, -padding
, padding
, padding
);
1425 void KStandardItemListWidget::updateCompactLayoutTextCache()
1427 // +------+ Name role
1428 // | Icon | Additional role 1
1429 // +------+ Additional role 2
1431 const QHash
<QByteArray
, QVariant
> values
= data();
1433 const KItemListStyleOption
&option
= styleOption();
1434 const qreal widgetHeight
= size().height();
1435 const qreal lineSpacing
= m_customizedFontMetrics
.lineSpacing();
1436 const qreal textLinesHeight
= qMax(visibleRoles().count(), 1) * lineSpacing
;
1438 qreal maximumRequiredTextWidth
= 0;
1439 const qreal x
= QApplication::isRightToLeft() ? option
.padding
: option
.padding
* 3 + iconSize();
1440 qreal y
= qRound((widgetHeight
- textLinesHeight
) / 2);
1441 const qreal maxWidth
= size().width() - iconSize() - 4 * option
.padding
;
1442 for (const QByteArray
&role
: std::as_const(m_sortedVisibleRoles
)) {
1443 const QString text
= escapeString(roleText(role
, values
));
1444 TextInfo
*textInfo
= m_textInfo
.value(role
);
1445 textInfo
->staticText
.setText(text
);
1447 qreal requiredWidth
= m_customizedFontMetrics
.horizontalAdvance(text
);
1448 if (requiredWidth
> maxWidth
) {
1449 requiredWidth
= maxWidth
;
1450 const QString elidedText
= m_customizedFontMetrics
.elidedText(text
, Qt::ElideMiddle
, maxWidth
);
1451 textInfo
->staticText
.setText(elidedText
);
1454 textInfo
->pos
= QPointF(x
, y
);
1455 textInfo
->staticText
.setTextWidth(maxWidth
);
1457 maximumRequiredTextWidth
= qMax(maximumRequiredTextWidth
, requiredWidth
);
1462 m_textRect
= QRectF(x
- option
.padding
, 0, maximumRequiredTextWidth
+ 2 * option
.padding
, widgetHeight
);
1465 void KStandardItemListWidget::updateDetailsLayoutTextCache()
1467 // Precondition: Requires already updated m_expansionArea
1468 // to determine the left position.
1471 // | Icon | Name role Additional role 1 Additional role 2
1473 // Mirror the above for right-to-left languages.
1474 const bool isLeftToRight
= QApplication::layoutDirection() == Qt::LeftToRight
;
1475 m_textRect
= QRectF();
1477 const KItemListStyleOption
&option
= styleOption();
1478 const QHash
<QByteArray
, QVariant
> values
= data();
1480 const qreal widgetHeight
= size().height();
1481 const int fontHeight
= m_customizedFontMetrics
.height();
1483 const qreal columnWidthInc
= columnPadding(option
);
1484 qreal firstColumnInc
= iconSize();
1485 if (m_supportsItemExpanding
) {
1486 firstColumnInc
+= isLeftToRight
? (m_expansionArea
.left() + m_expansionArea
.right() + widgetHeight
) / 2
1487 : ((size().width() - m_expansionArea
.left()) + (size().width() - m_expansionArea
.right()) + widgetHeight
) / 2;
1489 firstColumnInc
+= option
.padding
+ (isLeftToRight
? leftPadding() : rightPadding());
1492 qreal x
= firstColumnInc
;
1493 const qreal y
= qMax(qreal(option
.padding
), (widgetHeight
- fontHeight
) / 2);
1495 for (const QByteArray
&role
: std::as_const(m_sortedVisibleRoles
)) {
1496 QString text
= roleText(role
, values
);
1498 // Elide the text in case it does not fit into the available column-width
1499 qreal requiredWidth
= m_customizedFontMetrics
.horizontalAdvance(text
);
1500 const qreal roleWidth
= columnWidth(role
);
1501 qreal availableTextWidth
= roleWidth
- columnWidthInc
;
1503 const bool isTextRole
= (role
== "text");
1505 text
= escapeString(text
);
1506 availableTextWidth
-= firstColumnInc
- (isLeftToRight
? leftPadding() : rightPadding());
1509 if (requiredWidth
> availableTextWidth
) {
1510 text
= m_customizedFontMetrics
.elidedText(text
, Qt::ElideMiddle
, availableTextWidth
);
1511 requiredWidth
= m_customizedFontMetrics
.horizontalAdvance(text
);
1514 TextInfo
*textInfo
= m_textInfo
.value(role
);
1515 textInfo
->staticText
.setText(text
);
1516 textInfo
->pos
= QPointF(isLeftToRight
? (x
+ columnWidthInc
/ 2) : (size().width() - (x
+ columnWidthInc
/ 2) - requiredWidth
), y
);
1520 m_textRect
= QRectF(textInfo
->pos
.x() - option
.padding
, 0, requiredWidth
+ 2 * option
.padding
, size().height());
1522 // The column after the name should always be aligned on the same x-position independent
1523 // from the expansion-level shown in the name column
1524 x
-= firstColumnInc
- (isLeftToRight
? leftPadding() : rightPadding());
1525 } else if (isRoleRightAligned(role
) && isLeftToRight
) {
1526 textInfo
->pos
.rx() += roleWidth
- requiredWidth
- columnWidthInc
;
1531 void KStandardItemListWidget::updateAdditionalInfoTextColor()
1534 const bool hasFocus
= scene()->views()[0]->parentWidget()->hasFocus();
1535 if (m_customTextColor
.isValid()) {
1536 c1
= m_customTextColor
;
1537 } else if (isSelected() && hasFocus
&& (m_layout
!= DetailsLayout
|| m_highlightEntireRow
)) {
1538 // The detail text color needs to match the main text (HighlightedText) for the same level
1539 // of readability. We short circuit early here to avoid interpolating with another color.
1540 m_additionalInfoTextColor
= styleOption().palette
.color(QPalette::HighlightedText
);
1543 c1
= styleOption().palette
.text().color();
1546 // For the color of the additional info the inactive text color
1547 // is not used as this might lead to unreadable text for some color schemes. Instead
1548 // the text color c1 is slightly mixed with the background color.
1549 const QColor c2
= styleOption().palette
.base().color();
1551 const int p2
= 100 - p1
;
1552 m_additionalInfoTextColor
=
1553 QColor((c1
.red() * p1
+ c2
.red() * p2
) / 100, (c1
.green() * p1
+ c2
.green() * p2
) / 100, (c1
.blue() * p1
+ c2
.blue() * p2
) / 100);
1557 KStandardItemListWidget::addOverlays(const QPixmap
&pixmap
, const QHash
<Qt::Corner
, QString
> &overlays
, const QSize
&size
, qreal dpr
, QIcon::Mode mode
) const
1559 // similar to KIconUtils::addOverlays, keep in sync preferrably
1560 if (overlays
.isEmpty()) {
1564 int width
= size
.width();
1565 int height
= size
.height();
1566 const int iconSize
= qMin(width
, height
);
1568 // Determine the overlay icon
1570 if (iconSize
< 32) {
1572 } else if (iconSize
<= 48) {
1574 } else if (iconSize
<= 96) {
1576 } else if (iconSize
< 256) {
1582 auto phyiscalSize
= QSize(std::clamp(pixmap
.width(), qFloor(2 * overlaySize
* dpr
), qFloor(size
.width() * dpr
)),
1583 std::clamp(pixmap
.height(), qFloor(2 * overlaySize
* dpr
), qFloor(size
.height() * dpr
)));
1585 QPixmap
output(phyiscalSize
);
1586 output
.setDevicePixelRatio(dpr
);
1587 output
.fill(Qt::transparent
);
1589 QPainter
painter(&output
);
1590 painter
.drawPixmap(qFloor(phyiscalSize
.width() / dpr
/ 2) - qFloor(pixmap
.width() / pixmap
.devicePixelRatio() / 2),
1591 // align the icon to the bottom to match the behavior elsewhere
1592 qFloor(phyiscalSize
.height() / dpr
) - qFloor(pixmap
.height() / pixmap
.devicePixelRatio()),
1595 width
= qCeil(phyiscalSize
.width() / dpr
);
1596 height
= qCeil(phyiscalSize
.height() / dpr
);
1598 // Iterate over stored overlays
1599 for (const auto &[corner
, overlay
] : overlays
.asKeyValueRange()) {
1600 const QPixmap overlayPixmap
= QIcon::fromTheme(overlay
).pixmap(QSize
{overlaySize
, overlaySize
}, dpr
, mode
);
1601 if (overlayPixmap
.isNull()) {
1607 case Qt::BottomLeftCorner
:
1608 startPoint
= QPoint
{0, height
- overlaySize
};
1610 case Qt::BottomRightCorner
:
1611 startPoint
= QPoint
{width
- overlaySize
, height
- overlaySize
};
1613 case Qt::TopRightCorner
:
1614 startPoint
= QPoint
{width
- overlaySize
, 0};
1616 case Qt::TopLeftCorner
:
1617 startPoint
= QPoint
{};
1620 painter
.drawPixmap(startPoint
, overlayPixmap
);
1626 void KStandardItemListWidget::drawPixmap(QPainter
*painter
, const QPixmap
&pixmap
)
1628 if (m_scaledPixmapSize
!= pixmap
.size() / pixmap
.devicePixelRatio()) {
1629 const qreal dpr
= KItemViewsUtils::devicePixelRatio(this);
1630 QPixmap scaledPixmap
= pixmap
;
1631 KPixmapModifier::scale(scaledPixmap
, m_scaledPixmapSize
* dpr
);
1632 scaledPixmap
.setDevicePixelRatio(dpr
);
1633 painter
->drawPixmap(m_pixmapPos
, scaledPixmap
);
1635 #ifdef KSTANDARDITEMLISTWIDGET_DEBUG
1636 painter
->setPen(Qt::blue
);
1637 painter
->drawRect(QRectF(m_pixmapPos
, QSizeF(m_scaledPixmapSize
)));
1640 painter
->drawPixmap(m_pixmapPos
, pixmap
);
1644 void KStandardItemListWidget::drawSiblingsInformation(QPainter
*painter
)
1646 const int siblingSize
= size().height();
1647 const int x
= (m_expansionArea
.left() + m_expansionArea
.right() - siblingSize
) / 2;
1648 QRect
siblingRect(x
, 0, siblingSize
, siblingSize
);
1650 bool isItemSibling
= true;
1652 const QBitArray siblings
= siblingsInformation();
1653 QStyleOption option
;
1654 const auto normalColor
= option
.palette
.color(normalTextColorRole());
1655 const auto highlightColor
= option
.palette
.color(expansionAreaHovered() ? QPalette::Highlight
: normalTextColorRole());
1656 for (int i
= siblings
.count() - 1; i
>= 0; --i
) {
1657 option
.rect
= siblingRect
;
1658 option
.state
= siblings
.at(i
) ? QStyle::State_Sibling
: QStyle::State_None
;
1659 if (isItemSibling
) {
1660 option
.state
|= QStyle::State_Item
;
1661 if (m_isExpandable
) {
1662 option
.state
|= QStyle::State_Children
;
1664 if (data().value("isExpanded").toBool()) {
1665 option
.state
|= QStyle::State_Open
;
1667 option
.palette
.setColor(QPalette::Text
, highlightColor
);
1668 isItemSibling
= false;
1670 option
.palette
.setColor(QPalette::Text
, normalColor
);
1673 style()->drawPrimitive(QStyle::PE_IndicatorBranch
, &option
, painter
);
1675 siblingRect
.translate(layoutDirection() == Qt::LeftToRight
? -siblingRect
.width() : siblingRect
.width(), 0);
1679 QRectF
KStandardItemListWidget::roleEditingRect(const QByteArray
&role
) const
1681 const TextInfo
*textInfo
= m_textInfo
.value(role
);
1686 QRectF
rect(textInfo
->pos
, textInfo
->staticText
.size());
1687 if (m_layout
== DetailsLayout
) {
1688 rect
.setWidth(columnWidth(role
) - rect
.x());
1694 void KStandardItemListWidget::closeRoleEditor()
1696 disconnect(m_roleEditor
, &KItemListRoleEditor::roleEditingCanceled
, this, &KStandardItemListWidget::slotRoleEditingCanceled
);
1697 disconnect(m_roleEditor
, &KItemListRoleEditor::roleEditingFinished
, this, &KStandardItemListWidget::slotRoleEditingFinished
);
1699 if (m_roleEditor
->hasFocus()) {
1700 // If the editing was not ended by a FocusOut event, we have
1701 // to transfer the keyboard focus back to the KItemListContainer.
1702 scene()->views()[0]->parentWidget()->setFocus();
1705 if (m_oldRoleEditor
) {
1706 m_oldRoleEditor
->deleteLater();
1708 m_oldRoleEditor
= m_roleEditor
;
1709 m_roleEditor
->hide();
1710 m_roleEditor
= nullptr;
1713 QPixmap
KStandardItemListWidget::pixmapForIcon(const QString
&name
, const QSize
&size
, QIcon::Mode mode
) const
1715 static const QIcon fallbackIcon
= QIcon::fromTheme(QStringLiteral("unknown"));
1716 const qreal dpr
= KItemViewsUtils::devicePixelRatio(this);
1718 int iconHeight
= size
.height();
1719 QSize iconSize
= QSize(iconHeight
, iconHeight
);
1721 const QString key
= "KStandardItemListWidget:" % name
% ":" % QString::number(iconHeight
) % "@" % QString::number(dpr
) % ":" % QString::number(mode
);
1724 if (!QPixmapCache::find(key
, &pixmap
)) {
1725 QIcon icon
= QIcon::fromTheme(name
);
1726 if (icon
.isNull()) {
1729 if (!icon
.isNull()) {
1730 pixmap
= icon
.pixmap(iconSize
, dpr
, mode
);
1732 if (pixmap
.isNull()) {
1733 icon
= fallbackIcon
;
1734 pixmap
= icon
.pixmap(iconSize
, dpr
, mode
);
1736 if (pixmap
.width() != iconHeight
* dpr
|| pixmap
.height() != iconHeight
* dpr
) {
1737 KPixmapModifier::scale(pixmap
, iconSize
* dpr
);
1740 QPixmapCache::insert(key
, pixmap
);
1742 pixmap
.setDevicePixelRatio(dpr
);
1747 QSizeF
KStandardItemListWidget::preferredRatingSize(const KItemListStyleOption
&option
)
1749 const qreal height
= option
.fontMetrics
.ascent();
1750 return QSizeF(height
* 5, height
);
1753 qreal
KStandardItemListWidget::columnPadding(const KItemListStyleOption
&option
)
1755 return option
.padding
* 6;
1758 #include "moc_kstandarditemlistwidget.cpp"