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