]> cloud.milkyroute.net Git - dolphin.git/blob - src/kitemviews/kstandarditemlistwidget.cpp
Places Panel: Allow hiding of items
[dolphin.git] / src / kitemviews / kstandarditemlistwidget.cpp
1 /***************************************************************************
2 * Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com> *
3 * *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
8 * *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, write to the *
16 * Free Software Foundation, Inc., *
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
18 ***************************************************************************/
19
20 #include "kstandarditemlistwidget.h"
21
22 #include "kfileitemlistview.h"
23 #include "kfileitemmodel.h"
24
25 #include <KIcon>
26 #include <KIconEffect>
27 #include <KIconLoader>
28 #include <KLocale>
29 #include <kratingpainter.h>
30 #include <KStringHandler>
31 #include <KDebug>
32
33 #include "private/kfileitemclipboard.h"
34 #include "private/kitemlistroleeditor.h"
35 #include "private/kpixmapmodifier.h"
36
37 #include <QFontMetricsF>
38 #include <QGraphicsScene>
39 #include <QGraphicsSceneResizeEvent>
40 #include <QGraphicsView>
41 #include <QPainter>
42 #include <QStyleOption>
43 #include <QTextLayout>
44 #include <QTextLine>
45
46 // #define KSTANDARDITEMLISTWIDGET_DEBUG
47
48 KStandardItemListWidgetInformant::KStandardItemListWidgetInformant() :
49 KItemListWidgetInformant()
50 {
51 }
52
53 KStandardItemListWidgetInformant::~KStandardItemListWidgetInformant()
54 {
55 }
56
57 QSizeF KStandardItemListWidgetInformant::itemSizeHint(int index, const KItemListView* view) const
58 {
59 const QHash<QByteArray, QVariant> values = view->model()->data(index);
60 const KItemListStyleOption& option = view->styleOption();
61 const int additionalRolesCount = qMax(view->visibleRoles().count() - 1, 0);
62
63 switch (static_cast<const KStandardItemListView*>(view)->itemLayout()) {
64 case KStandardItemListWidget::IconsLayout: {
65 const QString text = KStringHandler::preProcessWrap(values["text"].toString());
66
67 const qreal itemWidth = view->itemSize().width();
68 const qreal maxWidth = itemWidth - 2 * option.padding;
69 QTextLine line;
70
71 // Calculate the number of lines required for wrapping the name
72 QTextOption textOption(Qt::AlignHCenter);
73 textOption.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere);
74
75 qreal textHeight = 0;
76 QTextLayout layout(text, option.font);
77 layout.setTextOption(textOption);
78 layout.beginLayout();
79 while ((line = layout.createLine()).isValid()) {
80 line.setLineWidth(maxWidth);
81 line.naturalTextWidth();
82 textHeight += line.height();
83 }
84 layout.endLayout();
85
86 // Add one line for each additional information
87 textHeight += additionalRolesCount * option.fontMetrics.lineSpacing();
88
89 const qreal maxTextHeight = option.maxTextSize.height();
90 if (maxTextHeight > 0 && textHeight > maxTextHeight) {
91 textHeight = maxTextHeight;
92 }
93
94 return QSizeF(itemWidth, textHeight + option.iconSize + option.padding * 3);
95 }
96
97 case KStandardItemListWidget::CompactLayout: {
98 // For each row exactly one role is shown. Calculate the maximum required width that is necessary
99 // to show all roles without horizontal clipping.
100 qreal maximumRequiredWidth = 0.0;
101
102 foreach (const QByteArray& role, view->visibleRoles()) {
103 const QString text = roleText(role, values);
104 const qreal requiredWidth = option.fontMetrics.width(text);
105 maximumRequiredWidth = qMax(maximumRequiredWidth, requiredWidth);
106 }
107
108 qreal width = option.padding * 4 + option.iconSize + maximumRequiredWidth;
109 const qreal maxWidth = option.maxTextSize.width();
110 if (maxWidth > 0 && width > maxWidth) {
111 width = maxWidth;
112 }
113 const qreal height = option.padding * 2 + qMax(option.iconSize, (1 + additionalRolesCount) * option.fontMetrics.lineSpacing());
114 return QSizeF(width, height);
115 }
116
117 case KStandardItemListWidget::DetailsLayout: {
118 const qreal height = option.padding * 2 + qMax(option.iconSize, option.fontMetrics.height());
119 return QSizeF(-1, height);
120 }
121
122 default:
123 Q_ASSERT(false);
124 break;
125 }
126
127 return QSize();
128 }
129
130 qreal KStandardItemListWidgetInformant::preferredRoleColumnWidth(const QByteArray& role,
131 int index,
132 const KItemListView* view) const
133 {
134 const QHash<QByteArray, QVariant> values = view->model()->data(index);
135 const KItemListStyleOption& option = view->styleOption();
136
137 const QString text = roleText(role, values);
138 qreal width = KStandardItemListWidget::columnPadding(option);
139
140 if (role == "rating") {
141 width += KStandardItemListWidget::preferredRatingSize(option).width();
142 } else {
143 width += option.fontMetrics.width(text);
144
145 if (role == "text") {
146 if (view->supportsItemExpanding()) {
147 // Increase the width by the expansion-toggle and the current expansion level
148 const int expandedParentsCount = values.value("expandedParentsCount", 0).toInt();
149 const qreal height = option.padding * 2 + qMax(option.iconSize, option.fontMetrics.height());
150 width += (expandedParentsCount + 1) * height;
151 }
152
153 // Increase the width by the required space for the icon
154 width += option.padding * 2 + option.iconSize;
155 }
156 }
157
158 return width;
159 }
160
161 QString KStandardItemListWidgetInformant::roleText(const QByteArray& role,
162 const QHash<QByteArray, QVariant>& values) const
163 {
164 if (role == "rating") {
165 // Always use an empty text, as the rating is shown by the image m_rating.
166 return QString();
167 }
168 return values.value(role).toString();
169 }
170
171 KStandardItemListWidget::KStandardItemListWidget(KItemListWidgetInformant* informant, QGraphicsItem* parent) :
172 KItemListWidget(informant, parent),
173 m_isCut(false),
174 m_isHidden(false),
175 m_isExpandable(false),
176 m_supportsItemExpanding(false),
177 m_dirtyLayout(true),
178 m_dirtyContent(true),
179 m_dirtyContentRoles(),
180 m_layout(IconsLayout),
181 m_pixmapPos(),
182 m_pixmap(),
183 m_scaledPixmapSize(),
184 m_iconRect(),
185 m_hoverPixmap(),
186 m_textInfo(),
187 m_textRect(),
188 m_sortedVisibleRoles(),
189 m_expansionArea(),
190 m_customTextColor(),
191 m_additionalInfoTextColor(),
192 m_overlay(),
193 m_rating(),
194 m_roleEditor(0)
195 {
196 }
197
198 KStandardItemListWidget::~KStandardItemListWidget()
199 {
200 qDeleteAll(m_textInfo);
201 m_textInfo.clear();
202
203 delete m_roleEditor;
204 }
205
206 void KStandardItemListWidget::setLayout(Layout layout)
207 {
208 if (m_layout != layout) {
209 m_layout = layout;
210 m_dirtyLayout = true;
211 updateAdditionalInfoTextColor();
212 update();
213 }
214 }
215
216 KStandardItemListWidget::Layout KStandardItemListWidget::layout() const
217 {
218 return m_layout;
219 }
220
221 void KStandardItemListWidget::setSupportsItemExpanding(bool supportsItemExpanding)
222 {
223 if (m_supportsItemExpanding != supportsItemExpanding) {
224 m_supportsItemExpanding = supportsItemExpanding;
225 m_dirtyLayout = true;
226 update();
227 }
228 }
229
230 bool KStandardItemListWidget::supportsItemExpanding() const
231 {
232 return m_supportsItemExpanding;
233 }
234
235 void KStandardItemListWidget::paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget)
236 {
237 const_cast<KStandardItemListWidget*>(this)->triggerCacheRefreshing();
238
239 KItemListWidget::paint(painter, option, widget);
240
241 if (!m_expansionArea.isEmpty()) {
242 drawSiblingsInformation(painter);
243 }
244
245 const KItemListStyleOption& itemListStyleOption = styleOption();
246 if (isHovered()) {
247 // Blend the unhovered and hovered pixmap if the hovering
248 // animation is ongoing
249 if (hoverOpacity() < 1.0) {
250 drawPixmap(painter, m_pixmap);
251 }
252
253 const qreal opacity = painter->opacity();
254 painter->setOpacity(hoverOpacity() * opacity);
255 drawPixmap(painter, m_hoverPixmap);
256 painter->setOpacity(opacity);
257 } else {
258 drawPixmap(painter, m_pixmap);
259 }
260
261 painter->setFont(itemListStyleOption.font);
262 painter->setPen(textColor());
263 const TextInfo* textInfo = m_textInfo.value("text");
264 painter->drawStaticText(textInfo->pos, textInfo->staticText);
265
266 bool clipAdditionalInfoBounds = false;
267 if (m_supportsItemExpanding) {
268 // Prevent a possible overlapping of the additional-information texts
269 // with the icon. This can happen if the user has minimized the width
270 // of the name-column to a very small value.
271 const qreal minX = m_pixmapPos.x() + m_pixmap.width() + 4 * itemListStyleOption.padding;
272 if (textInfo->pos.x() + columnWidth("text") > minX) {
273 clipAdditionalInfoBounds = true;
274 painter->save();
275 painter->setClipRect(minX, 0, size().width() - minX, size().height(), Qt::IntersectClip);
276 }
277 }
278
279 painter->setPen(m_additionalInfoTextColor);
280 painter->setFont(itemListStyleOption.font);
281
282 for (int i = 1; i < m_sortedVisibleRoles.count(); ++i) {
283 const TextInfo* textInfo = m_textInfo.value(m_sortedVisibleRoles[i]);
284 painter->drawStaticText(textInfo->pos, textInfo->staticText);
285 }
286
287 if (!m_rating.isNull()) {
288 const TextInfo* ratingTextInfo = m_textInfo.value("rating");
289 QPointF pos = ratingTextInfo->pos;
290 const Qt::Alignment align = ratingTextInfo->staticText.textOption().alignment();
291 if (align & Qt::AlignHCenter) {
292 pos.rx() += (size().width() - m_rating.width()) / 2;
293 }
294 painter->drawPixmap(pos, m_rating);
295 }
296
297 if (clipAdditionalInfoBounds) {
298 painter->restore();
299 }
300
301 #ifdef KSTANDARDITEMLISTWIDGET_DEBUG
302 painter->setBrush(Qt::NoBrush);
303 painter->setPen(Qt::green);
304 painter->drawRect(m_iconRect);
305
306 painter->setPen(Qt::red);
307 painter->drawText(QPointF(0, itemListStyleOption.fontMetrics.height()), QString::number(index()));
308 painter->drawRect(rect());
309 #endif
310 }
311
312 QRectF KStandardItemListWidget::iconRect() const
313 {
314 const_cast<KStandardItemListWidget*>(this)->triggerCacheRefreshing();
315 return m_iconRect;
316 }
317
318 QRectF KStandardItemListWidget::textRect() const
319 {
320 const_cast<KStandardItemListWidget*>(this)->triggerCacheRefreshing();
321 return m_textRect;
322 }
323
324 QRectF KStandardItemListWidget::textFocusRect() const
325 {
326 // In the compact- and details-layout a larger textRect() is returned to be aligned
327 // with the iconRect(). This is useful to have a larger selection/hover-area
328 // when having a quite large icon size but only one line of text. Still the
329 // focus rectangle should be shown as narrow as possible around the text.
330
331 const_cast<KStandardItemListWidget*>(this)->triggerCacheRefreshing();
332
333 switch (m_layout) {
334 case CompactLayout: {
335 QRectF rect = m_textRect;
336 const TextInfo* topText = m_textInfo.value(m_sortedVisibleRoles.first());
337 const TextInfo* bottomText = m_textInfo.value(m_sortedVisibleRoles.last());
338 rect.setTop(topText->pos.y());
339 rect.setBottom(bottomText->pos.y() + bottomText->staticText.size().height());
340 return rect;
341 }
342
343 case DetailsLayout: {
344 QRectF rect = m_textRect;
345 const TextInfo* textInfo = m_textInfo.value(m_sortedVisibleRoles.first());
346 rect.setTop(textInfo->pos.y());
347 rect.setBottom(textInfo->pos.y() + textInfo->staticText.size().height());
348
349 const KItemListStyleOption& option = styleOption();
350 if (option.extendedSelectionRegion) {
351 const QString text = textInfo->staticText.text();
352 rect.setWidth(option.fontMetrics.width(text) + 2 * option.padding);
353 }
354
355 return rect;
356 }
357
358 default:
359 break;
360 }
361
362 return m_textRect;
363 }
364
365 QRectF KStandardItemListWidget::expansionToggleRect() const
366 {
367 const_cast<KStandardItemListWidget*>(this)->triggerCacheRefreshing();
368 return m_isExpandable ? m_expansionArea : QRectF();
369 }
370
371 QRectF KStandardItemListWidget::selectionToggleRect() const
372 {
373 const_cast<KStandardItemListWidget*>(this)->triggerCacheRefreshing();
374
375 const int iconHeight = styleOption().iconSize;
376
377 int toggleSize = KIconLoader::SizeSmall;
378 if (iconHeight >= KIconLoader::SizeEnormous) {
379 toggleSize = KIconLoader::SizeMedium;
380 } else if (iconHeight >= KIconLoader::SizeLarge) {
381 toggleSize = KIconLoader::SizeSmallMedium;
382 }
383
384 QPointF pos = iconRect().topLeft();
385
386 // If the selection toggle has a very small distance to the
387 // widget borders, the size of the selection toggle will get
388 // increased to prevent an accidental clicking of the item
389 // when trying to hit the toggle.
390 const int widgetHeight = size().height();
391 const int widgetWidth = size().width();
392 const int minMargin = 2;
393
394 if (toggleSize + minMargin * 2 >= widgetHeight) {
395 pos.rx() -= (widgetHeight - toggleSize) / 2;
396 toggleSize = widgetHeight;
397 pos.setY(0);
398 }
399 if (toggleSize + minMargin * 2 >= widgetWidth) {
400 pos.ry() -= (widgetWidth - toggleSize) / 2;
401 toggleSize = widgetWidth;
402 pos.setX(0);
403 }
404
405 return QRectF(pos, QSizeF(toggleSize, toggleSize));
406 }
407
408 KItemListWidgetInformant* KStandardItemListWidget::createInformant()
409 {
410 return new KStandardItemListWidgetInformant();
411 }
412
413 void KStandardItemListWidget::invalidateCache()
414 {
415 m_dirtyLayout = true;
416 m_dirtyContent = true;
417 }
418
419 void KStandardItemListWidget::refreshCache()
420 {
421 }
422
423 bool KStandardItemListWidget::isRoleRightAligned(const QByteArray& role) const
424 {
425 Q_UNUSED(role);
426 return false;
427 }
428
429 bool KStandardItemListWidget::isHidden() const
430 {
431 return false;
432 }
433
434 void KStandardItemListWidget::setTextColor(const QColor& color)
435 {
436 if (color != m_customTextColor) {
437 m_customTextColor = color;
438 updateAdditionalInfoTextColor();
439 update();
440 }
441 }
442
443 QColor KStandardItemListWidget::textColor() const
444 {
445 if (m_customTextColor.isValid() && !isSelected()) {
446 return m_customTextColor;
447 }
448
449 const QPalette::ColorGroup group = isActiveWindow() ? QPalette::Active : QPalette::Inactive;
450 const QPalette::ColorRole role = isSelected() ? QPalette::HighlightedText : QPalette::Text;
451 return styleOption().palette.brush(group, role).color();
452 }
453
454 void KStandardItemListWidget::setOverlay(const QPixmap& overlay)
455 {
456 m_overlay = overlay;
457 m_dirtyContent = true;
458 update();
459 }
460
461 QPixmap KStandardItemListWidget::overlay() const
462 {
463 return m_overlay;
464 }
465
466
467 QString KStandardItemListWidget::roleText(const QByteArray& role,
468 const QHash<QByteArray, QVariant>& values) const
469 {
470 return static_cast<const KStandardItemListWidgetInformant*>(informant())->roleText(role, values);
471 }
472
473 void KStandardItemListWidget::dataChanged(const QHash<QByteArray, QVariant>& current,
474 const QSet<QByteArray>& roles)
475 {
476 Q_UNUSED(current);
477
478 m_dirtyContent = true;
479
480 QSet<QByteArray> dirtyRoles;
481 if (roles.isEmpty()) {
482 dirtyRoles = visibleRoles().toSet();
483 dirtyRoles.insert("iconPixmap");
484 dirtyRoles.insert("iconName");
485 } else {
486 dirtyRoles = roles;
487 }
488
489 QSetIterator<QByteArray> it(dirtyRoles);
490 while (it.hasNext()) {
491 const QByteArray& role = it.next();
492 m_dirtyContentRoles.insert(role);
493 }
494 }
495
496 void KStandardItemListWidget::visibleRolesChanged(const QList<QByteArray>& current,
497 const QList<QByteArray>& previous)
498 {
499 Q_UNUSED(previous);
500 m_sortedVisibleRoles = current;
501 m_dirtyLayout = true;
502 }
503
504 void KStandardItemListWidget::columnWidthChanged(const QByteArray& role,
505 qreal current,
506 qreal previous)
507 {
508 Q_UNUSED(role);
509 Q_UNUSED(current);
510 Q_UNUSED(previous);
511 m_dirtyLayout = true;
512 }
513
514 void KStandardItemListWidget::styleOptionChanged(const KItemListStyleOption& current,
515 const KItemListStyleOption& previous)
516 {
517 Q_UNUSED(current);
518 Q_UNUSED(previous);
519 updateAdditionalInfoTextColor();
520 m_dirtyLayout = true;
521 }
522
523 void KStandardItemListWidget::hoveredChanged(bool hovered)
524 {
525 Q_UNUSED(hovered);
526 m_dirtyLayout = true;
527 }
528
529 void KStandardItemListWidget::selectedChanged(bool selected)
530 {
531 Q_UNUSED(selected);
532 updateAdditionalInfoTextColor();
533 }
534
535 void KStandardItemListWidget::siblingsInformationChanged(const QBitArray& current, const QBitArray& previous)
536 {
537 Q_UNUSED(current);
538 Q_UNUSED(previous);
539 m_dirtyLayout = true;
540 }
541
542 void KStandardItemListWidget::editedRoleChanged(const QByteArray& current, const QByteArray& previous)
543 {
544 Q_UNUSED(previous);
545
546 QGraphicsView* parent = scene()->views()[0];
547 if (current.isEmpty() || !parent || current != "text") {
548 if (m_roleEditor) {
549 emit roleEditingCanceled(index(), current, data().value(current));
550 m_roleEditor->deleteLater();
551 m_roleEditor = 0;
552 }
553 return;
554 }
555
556 Q_ASSERT(!m_roleEditor);
557
558 const TextInfo* textInfo = m_textInfo.value("text");
559
560 m_roleEditor = new KItemListRoleEditor(parent);
561 m_roleEditor->setIndex(index());
562 m_roleEditor->setRole(current);
563
564 const QString text = data().value(current).toString();
565 m_roleEditor->setPlainText(text);
566
567 QTextOption textOption = textInfo->staticText.textOption();
568 m_roleEditor->document()->setDefaultTextOption(textOption);
569
570 // Select the text without MIME-type extension
571 int selectionLength = text.length();
572
573 const QString extension = KMimeType::extractKnownExtension(text);
574 if (!extension.isEmpty()) {
575 selectionLength -= extension.length() + 1;
576 }
577
578 if (selectionLength > 0) {
579 QTextCursor cursor = m_roleEditor->textCursor();
580 cursor.movePosition(QTextCursor::StartOfBlock);
581 cursor.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor, selectionLength);
582 m_roleEditor->setTextCursor(cursor);
583 }
584
585 connect(m_roleEditor, SIGNAL(roleEditingCanceled(int,QByteArray,QVariant)),
586 this, SLOT(slotRoleEditingCanceled(int,QByteArray,QVariant)));
587 connect(m_roleEditor, SIGNAL(roleEditingFinished(int,QByteArray,QVariant)),
588 this, SLOT(slotRoleEditingFinished(int,QByteArray,QVariant)));
589
590 // Adjust the geometry of the editor
591 QRectF rect = roleEditingRect(current);
592 const int frameWidth = m_roleEditor->frameWidth();
593 rect.adjust(-frameWidth, -frameWidth, frameWidth, frameWidth);
594 rect.translate(pos());
595 if (rect.right() > parent->width()) {
596 rect.setWidth(parent->width() - rect.left());
597 }
598 m_roleEditor->setGeometry(rect.toRect());
599 m_roleEditor->show();
600 m_roleEditor->setFocus();
601 }
602
603 void KStandardItemListWidget::resizeEvent(QGraphicsSceneResizeEvent* event)
604 {
605 if (m_roleEditor) {
606 setEditedRole(QByteArray());
607 Q_ASSERT(!m_roleEditor);
608 }
609
610 KItemListWidget::resizeEvent(event);
611
612 m_dirtyLayout = true;
613 }
614
615 void KStandardItemListWidget::showEvent(QShowEvent* event)
616 {
617 KItemListWidget::showEvent(event);
618
619 // Listen to changes of the clipboard to mark the item as cut/uncut
620 KFileItemClipboard* clipboard = KFileItemClipboard::instance();
621
622 const KUrl itemUrl = data().value("url").value<KUrl>();
623 m_isCut = clipboard->isCut(itemUrl);
624
625 connect(clipboard, SIGNAL(cutItemsChanged()),
626 this, SLOT(slotCutItemsChanged()));
627 }
628
629 void KStandardItemListWidget::hideEvent(QHideEvent* event)
630 {
631 disconnect(KFileItemClipboard::instance(), SIGNAL(cutItemsChanged()),
632 this, SLOT(slotCutItemsChanged()));
633
634 KItemListWidget::hideEvent(event);
635 }
636
637 void KStandardItemListWidget::slotCutItemsChanged()
638 {
639 const KUrl itemUrl = data().value("url").value<KUrl>();
640 const bool isCut = KFileItemClipboard::instance()->isCut(itemUrl);
641 if (m_isCut != isCut) {
642 m_isCut = isCut;
643 m_pixmap = QPixmap();
644 m_dirtyContent = true;
645 update();
646 }
647 }
648
649 void KStandardItemListWidget::slotRoleEditingCanceled(int index,
650 const QByteArray& role,
651 const QVariant& value)
652 {
653 m_roleEditor->deleteLater();
654 m_roleEditor = 0;
655 emit roleEditingCanceled(index, role, value);
656 setEditedRole(QByteArray());
657 }
658
659 void KStandardItemListWidget::slotRoleEditingFinished(int index,
660 const QByteArray& role,
661 const QVariant& value)
662 {
663 m_roleEditor->deleteLater();
664 m_roleEditor = 0;
665 emit roleEditingFinished(index, role, value);
666 setEditedRole(QByteArray());
667 }
668
669 void KStandardItemListWidget::triggerCacheRefreshing()
670 {
671 if ((!m_dirtyContent && !m_dirtyLayout) || index() < 0) {
672 return;
673 }
674
675 refreshCache();
676
677 const QHash<QByteArray, QVariant> values = data();
678 m_isExpandable = m_supportsItemExpanding && values["isExpandable"].toBool();
679 m_isHidden = isHidden();
680
681 updateExpansionArea();
682 updateTextsCache();
683 updatePixmapCache();
684
685 m_dirtyLayout = false;
686 m_dirtyContent = false;
687 m_dirtyContentRoles.clear();
688 }
689
690 void KStandardItemListWidget::updateExpansionArea()
691 {
692 if (m_supportsItemExpanding) {
693 const QHash<QByteArray, QVariant> values = data();
694 Q_ASSERT(values.contains("expandedParentsCount"));
695 const int expandedParentsCount = values.value("expandedParentsCount", 0).toInt();
696 if (expandedParentsCount >= 0) {
697 const qreal widgetHeight = size().height();
698 const qreal inc = (widgetHeight - KIconLoader::SizeSmall) / 2;
699 const qreal x = expandedParentsCount * widgetHeight + inc;
700 const qreal y = inc;
701 m_expansionArea = QRectF(x, y, KIconLoader::SizeSmall, KIconLoader::SizeSmall);
702 return;
703 }
704 }
705
706 m_expansionArea = QRectF();
707 }
708
709 void KStandardItemListWidget::updatePixmapCache()
710 {
711 // Precondition: Requires already updated m_textPos values to calculate
712 // the remaining height when the alignment is vertical.
713
714 const QSizeF widgetSize = size();
715 const bool iconOnTop = (m_layout == IconsLayout);
716 const KItemListStyleOption& option = styleOption();
717 const qreal padding = option.padding;
718
719 const int maxIconWidth = iconOnTop ? widgetSize.width() - 2 * padding : option.iconSize;
720 const int maxIconHeight = option.iconSize;
721
722 const QHash<QByteArray, QVariant> values = data();
723
724 bool updatePixmap = (m_pixmap.width() != maxIconWidth || m_pixmap.height() != maxIconHeight);
725 if (!updatePixmap && m_dirtyContent) {
726 updatePixmap = m_dirtyContentRoles.isEmpty()
727 || m_dirtyContentRoles.contains("iconPixmap")
728 || m_dirtyContentRoles.contains("iconName")
729 || m_dirtyContentRoles.contains("iconOverlays");
730 }
731
732 if (updatePixmap) {
733 m_pixmap = values["iconPixmap"].value<QPixmap>();
734 if (m_pixmap.isNull()) {
735 // Use the icon that fits to the MIME-type
736 QString iconName = values["iconName"].toString();
737 if (iconName.isEmpty()) {
738 // The icon-name has not been not resolved by KFileItemModelRolesUpdater,
739 // use a generic icon as fallback
740 iconName = QLatin1String("unknown");
741 }
742 m_pixmap = pixmapForIcon(iconName, maxIconHeight);
743 } else if (m_pixmap.width() != maxIconWidth || m_pixmap.height() != maxIconHeight) {
744 // A custom pixmap has been applied. Assure that the pixmap
745 // is scaled to the maximum available size.
746 KPixmapModifier::scale(m_pixmap, QSize(maxIconWidth, maxIconHeight));
747 }
748
749 const QStringList overlays = values["iconOverlays"].toStringList();
750
751 // Strangely KFileItem::overlays() returns empty string-values, so
752 // we need to check first whether an overlay must be drawn at all.
753 // It is more efficient to do it here, as KIconLoader::drawOverlays()
754 // assumes that an overlay will be drawn and has some additional
755 // setup time.
756 foreach (const QString& overlay, overlays) {
757 if (!overlay.isEmpty()) {
758 // There is at least one overlay, draw all overlays above m_pixmap
759 // and cancel the check
760 KIconLoader::global()->drawOverlays(overlays, m_pixmap, KIconLoader::Desktop);
761 break;
762 }
763 }
764
765 if (m_isCut) {
766 applyCutEffect(m_pixmap);
767 }
768
769 if (m_isHidden) {
770 applyHiddenEffect(m_pixmap);
771 }
772 }
773
774 if (!m_overlay.isNull()) {
775 QPainter painter(&m_pixmap);
776 painter.drawPixmap(0, m_pixmap.height() - m_overlay.height(), m_overlay);
777 }
778
779 int scaledIconSize = 0;
780 if (iconOnTop) {
781 const TextInfo* textInfo = m_textInfo.value("text");
782 scaledIconSize = static_cast<int>(textInfo->pos.y() - 2 * padding);
783 } else {
784 const int textRowsCount = (m_layout == CompactLayout) ? visibleRoles().count() : 1;
785 const qreal requiredTextHeight = textRowsCount * option.fontMetrics.height();
786 scaledIconSize = (requiredTextHeight < maxIconHeight) ?
787 widgetSize.height() - 2 * padding : maxIconHeight;
788 }
789
790 const int maxScaledIconWidth = iconOnTop ? widgetSize.width() - 2 * padding : scaledIconSize;
791 const int maxScaledIconHeight = scaledIconSize;
792
793 m_scaledPixmapSize = m_pixmap.size();
794 m_scaledPixmapSize.scale(maxScaledIconWidth, maxScaledIconHeight, Qt::KeepAspectRatio);
795
796 if (iconOnTop) {
797 // Center horizontally and align on bottom within the icon-area
798 m_pixmapPos.setX((widgetSize.width() - m_scaledPixmapSize.width()) / 2);
799 m_pixmapPos.setY(padding + scaledIconSize - m_scaledPixmapSize.height());
800 } else {
801 // Center horizontally and vertically within the icon-area
802 const TextInfo* textInfo = m_textInfo.value("text");
803 m_pixmapPos.setX(textInfo->pos.x() - 2 * padding
804 - (scaledIconSize + m_scaledPixmapSize.width()) / 2);
805 m_pixmapPos.setY(padding
806 + (scaledIconSize - m_scaledPixmapSize.height()) / 2);
807 }
808
809 m_iconRect = QRectF(m_pixmapPos, QSizeF(m_scaledPixmapSize));
810
811 // Prepare the pixmap that is used when the item gets hovered
812 if (isHovered()) {
813 m_hoverPixmap = m_pixmap;
814 KIconEffect* effect = KIconLoader::global()->iconEffect();
815 // In the KIconLoader terminology, active = hover.
816 if (effect->hasEffect(KIconLoader::Desktop, KIconLoader::ActiveState)) {
817 m_hoverPixmap = effect->apply(m_pixmap, KIconLoader::Desktop, KIconLoader::ActiveState);
818 } else {
819 m_hoverPixmap = m_pixmap;
820 }
821 } else if (hoverOpacity() <= 0.0) {
822 // No hover animation is ongoing. Clear m_hoverPixmap to save memory.
823 m_hoverPixmap = QPixmap();
824 }
825 }
826
827 void KStandardItemListWidget::updateTextsCache()
828 {
829 QTextOption textOption;
830 switch (m_layout) {
831 case IconsLayout:
832 textOption.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere);
833 textOption.setAlignment(Qt::AlignHCenter);
834 break;
835 case CompactLayout:
836 case DetailsLayout:
837 textOption.setAlignment(Qt::AlignLeft);
838 textOption.setWrapMode(QTextOption::NoWrap);
839 break;
840 default:
841 Q_ASSERT(false);
842 break;
843 }
844
845 qDeleteAll(m_textInfo);
846 m_textInfo.clear();
847 for (int i = 0; i < m_sortedVisibleRoles.count(); ++i) {
848 TextInfo* textInfo = new TextInfo();
849 textInfo->staticText.setTextFormat(Qt::PlainText);
850 textInfo->staticText.setPerformanceHint(QStaticText::AggressiveCaching);
851 textInfo->staticText.setTextOption(textOption);
852 m_textInfo.insert(m_sortedVisibleRoles[i], textInfo);
853 }
854
855 switch (m_layout) {
856 case IconsLayout: updateIconsLayoutTextCache(); break;
857 case CompactLayout: updateCompactLayoutTextCache(); break;
858 case DetailsLayout: updateDetailsLayoutTextCache(); break;
859 default: Q_ASSERT(false); break;
860 }
861
862 const TextInfo* ratingTextInfo = m_textInfo.value("rating");
863 if (ratingTextInfo) {
864 // The text of the rating-role has been set to empty to get
865 // replaced by a rating-image showing the rating as stars.
866 const KItemListStyleOption& option = styleOption();
867 QSizeF ratingSize = preferredRatingSize(option);
868
869 const qreal availableWidth = (m_layout == DetailsLayout)
870 ? columnWidth("rating") - columnPadding(option)
871 : m_textRect.width();
872 if (ratingSize.width() > availableWidth) {
873 ratingSize.rwidth() = availableWidth;
874 }
875 m_rating = QPixmap(ratingSize.toSize());
876 m_rating.fill(Qt::transparent);
877
878 QPainter painter(&m_rating);
879 const QRect rect(0, 0, m_rating.width(), m_rating.height());
880 const int rating = data().value("rating").toInt();
881 KRatingPainter::paintRating(&painter, rect, Qt::AlignJustify | Qt::AlignVCenter, rating);
882 } else if (!m_rating.isNull()) {
883 m_rating = QPixmap();
884 }
885 }
886
887 void KStandardItemListWidget::updateIconsLayoutTextCache()
888 {
889 // +------+
890 // | Icon |
891 // +------+
892 //
893 // Name role that
894 // might get wrapped above
895 // several lines.
896 // Additional role 1
897 // Additional role 2
898
899 const QHash<QByteArray, QVariant> values = data();
900
901 const KItemListStyleOption& option = styleOption();
902 const qreal padding = option.padding;
903 const qreal maxWidth = size().width() - 2 * padding;
904 const qreal widgetHeight = size().height();
905 const qreal lineSpacing = option.fontMetrics.lineSpacing();
906
907 // Initialize properties for the "text" role. It will be used as anchor
908 // for initializing the position of the other roles.
909 TextInfo* nameTextInfo = m_textInfo.value("text");
910 const QString nameText = KStringHandler::preProcessWrap(values["text"].toString());
911 nameTextInfo->staticText.setText(nameText);
912
913 // Calculate the number of lines required for the name and the required width
914 qreal nameWidth = 0;
915 qreal nameHeight = 0;
916 QTextLine line;
917
918 const int additionalRolesCount = qMax(visibleRoles().count() - 1, 0);
919 const int maxNameLines = (option.maxTextSize.height() / int(lineSpacing)) - additionalRolesCount;
920
921 QTextLayout layout(nameTextInfo->staticText.text(), option.font);
922 layout.setTextOption(nameTextInfo->staticText.textOption());
923 layout.beginLayout();
924 int nameLineIndex = 0;
925 while ((line = layout.createLine()).isValid()) {
926 line.setLineWidth(maxWidth);
927 nameWidth = qMax(nameWidth, line.naturalTextWidth());
928 nameHeight += line.height();
929
930 ++nameLineIndex;
931 if (nameLineIndex == maxNameLines) {
932 // The maximum number of textlines has been reached. If this is
933 // the case provide an elided text if necessary.
934 const int textLength = line.textStart() + line.textLength();
935 if (textLength < nameText.length()) {
936 // Elide the last line of the text
937 QString lastTextLine = nameText.mid(line.textStart(), line.textLength());
938 lastTextLine = option.fontMetrics.elidedText(lastTextLine,
939 Qt::ElideRight,
940 line.naturalTextWidth() - 1);
941 const QString elidedText = nameText.left(line.textStart()) + lastTextLine;
942 nameTextInfo->staticText.setText(elidedText);
943 }
944 break;
945 }
946 }
947 layout.endLayout();
948
949 // Use one line for each additional information
950 nameTextInfo->staticText.setTextWidth(maxWidth);
951 nameTextInfo->pos = QPointF(padding, widgetHeight -
952 nameHeight -
953 additionalRolesCount * lineSpacing -
954 padding);
955 m_textRect = QRectF(padding + (maxWidth - nameWidth) / 2,
956 nameTextInfo->pos.y(),
957 nameWidth,
958 nameHeight);
959
960 // Calculate the position for each additional information
961 qreal y = nameTextInfo->pos.y() + nameHeight;
962 foreach (const QByteArray& role, m_sortedVisibleRoles) {
963 if (role == "text") {
964 continue;
965 }
966
967 const QString text = roleText(role, values);
968 TextInfo* textInfo = m_textInfo.value(role);
969 textInfo->staticText.setText(text);
970
971 qreal requiredWidth = 0;
972
973 QTextLayout layout(text, option.font);
974 QTextOption textOption;
975 textOption.setWrapMode(QTextOption::NoWrap);
976 layout.setTextOption(textOption);
977
978 layout.beginLayout();
979 QTextLine textLine = layout.createLine();
980 if (textLine.isValid()) {
981 textLine.setLineWidth(maxWidth);
982 requiredWidth = textLine.naturalTextWidth();
983 if (requiredWidth > maxWidth) {
984 const QString elidedText = option.fontMetrics.elidedText(text, Qt::ElideRight, maxWidth);
985 textInfo->staticText.setText(elidedText);
986 requiredWidth = option.fontMetrics.width(elidedText);
987 }
988 }
989 layout.endLayout();
990
991 textInfo->pos = QPointF(padding, y);
992 textInfo->staticText.setTextWidth(maxWidth);
993
994 const QRectF textRect(padding + (maxWidth - requiredWidth) / 2, y, requiredWidth, lineSpacing);
995 m_textRect |= textRect;
996
997 y += lineSpacing;
998 }
999
1000 // Add a padding to the text rectangle
1001 m_textRect.adjust(-padding, -padding, padding, padding);
1002 }
1003
1004 void KStandardItemListWidget::updateCompactLayoutTextCache()
1005 {
1006 // +------+ Name role
1007 // | Icon | Additional role 1
1008 // +------+ Additional role 2
1009
1010 const QHash<QByteArray, QVariant> values = data();
1011
1012 const KItemListStyleOption& option = styleOption();
1013 const qreal widgetHeight = size().height();
1014 const qreal lineSpacing = option.fontMetrics.lineSpacing();
1015 const qreal textLinesHeight = qMax(visibleRoles().count(), 1) * lineSpacing;
1016 const int scaledIconSize = (textLinesHeight < option.iconSize) ? widgetHeight - 2 * option.padding : option.iconSize;
1017
1018 qreal maximumRequiredTextWidth = 0;
1019 const qreal x = option.padding * 3 + scaledIconSize;
1020 qreal y = qRound((widgetHeight - textLinesHeight) / 2);
1021 const qreal maxWidth = size().width() - x - option.padding;
1022 foreach (const QByteArray& role, m_sortedVisibleRoles) {
1023 const QString text = roleText(role, values);
1024 TextInfo* textInfo = m_textInfo.value(role);
1025 textInfo->staticText.setText(text);
1026
1027 qreal requiredWidth = option.fontMetrics.width(text);
1028 if (requiredWidth > maxWidth) {
1029 requiredWidth = maxWidth;
1030 const QString elidedText = option.fontMetrics.elidedText(text, Qt::ElideRight, maxWidth);
1031 textInfo->staticText.setText(elidedText);
1032 }
1033
1034 textInfo->pos = QPointF(x, y);
1035 textInfo->staticText.setTextWidth(maxWidth);
1036
1037 maximumRequiredTextWidth = qMax(maximumRequiredTextWidth, requiredWidth);
1038
1039 y += lineSpacing;
1040 }
1041
1042 m_textRect = QRectF(x - option.padding, 0, maximumRequiredTextWidth + 2 * option.padding, widgetHeight);
1043 }
1044
1045 void KStandardItemListWidget::updateDetailsLayoutTextCache()
1046 {
1047 // Precondition: Requires already updated m_expansionArea
1048 // to determine the left position.
1049
1050 // +------+
1051 // | Icon | Name role Additional role 1 Additional role 2
1052 // +------+
1053 m_textRect = QRectF();
1054
1055 const KItemListStyleOption& option = styleOption();
1056 const QHash<QByteArray, QVariant> values = data();
1057
1058 const qreal widgetHeight = size().height();
1059 const int scaledIconSize = widgetHeight - 2 * option.padding;
1060 const int fontHeight = option.fontMetrics.height();
1061
1062 const qreal columnWidthInc = columnPadding(option);
1063 qreal firstColumnInc = scaledIconSize;
1064 if (m_supportsItemExpanding) {
1065 firstColumnInc += (m_expansionArea.left() + m_expansionArea.right() + widgetHeight) / 2;
1066 } else {
1067 firstColumnInc += option.padding;
1068 }
1069
1070 qreal x = firstColumnInc;
1071 const qreal y = qMax(qreal(option.padding), (widgetHeight - fontHeight) / 2);
1072
1073 foreach (const QByteArray& role, m_sortedVisibleRoles) {
1074 QString text = roleText(role, values);
1075
1076 // Elide the text in case it does not fit into the available column-width
1077 qreal requiredWidth = option.fontMetrics.width(text);
1078 const qreal roleWidth = columnWidth(role);
1079 qreal availableTextWidth = roleWidth - columnWidthInc;
1080
1081 const bool isTextRole = (role == "text");
1082 if (isTextRole) {
1083 availableTextWidth -= firstColumnInc;
1084 }
1085
1086 if (requiredWidth > availableTextWidth) {
1087 text = option.fontMetrics.elidedText(text, Qt::ElideRight, availableTextWidth);
1088 requiredWidth = option.fontMetrics.width(text);
1089 }
1090
1091 TextInfo* textInfo = m_textInfo.value(role);
1092 textInfo->staticText.setText(text);
1093 textInfo->pos = QPointF(x + columnWidthInc / 2, y);
1094 x += roleWidth;
1095
1096 if (isTextRole) {
1097 const qreal textWidth = option.extendedSelectionRegion
1098 ? size().width() - textInfo->pos.x()
1099 : requiredWidth + 2 * option.padding;
1100 m_textRect = QRectF(textInfo->pos.x() - option.padding, 0,
1101 textWidth, size().height());
1102
1103 // The column after the name should always be aligned on the same x-position independent
1104 // from the expansion-level shown in the name column
1105 x -= firstColumnInc;
1106 } else if (isRoleRightAligned(role)) {
1107 textInfo->pos.rx() += roleWidth - requiredWidth - columnWidthInc;
1108 }
1109 }
1110 }
1111
1112 void KStandardItemListWidget::updateAdditionalInfoTextColor()
1113 {
1114 QColor c1;
1115 if (m_customTextColor.isValid()) {
1116 c1 = m_customTextColor;
1117 } else if (isSelected() && m_layout != DetailsLayout) {
1118 c1 = styleOption().palette.highlightedText().color();
1119 } else {
1120 c1 = styleOption().palette.text().color();
1121 }
1122
1123 // For the color of the additional info the inactive text color
1124 // is not used as this might lead to unreadable text for some color schemes. Instead
1125 // the text color c1 is slightly mixed with the background color.
1126 const QColor c2 = styleOption().palette.base().color();
1127 const int p1 = 70;
1128 const int p2 = 100 - p1;
1129 m_additionalInfoTextColor = QColor((c1.red() * p1 + c2.red() * p2) / 100,
1130 (c1.green() * p1 + c2.green() * p2) / 100,
1131 (c1.blue() * p1 + c2.blue() * p2) / 100);
1132 }
1133
1134 void KStandardItemListWidget::drawPixmap(QPainter* painter, const QPixmap& pixmap)
1135 {
1136 if (m_scaledPixmapSize != pixmap.size()) {
1137 QPixmap scaledPixmap = pixmap;
1138 KPixmapModifier::scale(scaledPixmap, m_scaledPixmapSize);
1139 painter->drawPixmap(m_pixmapPos, scaledPixmap);
1140
1141 #ifdef KSTANDARDITEMLISTWIDGET_DEBUG
1142 painter->setPen(Qt::blue);
1143 painter->drawRect(QRectF(m_pixmapPos, QSizeF(m_scaledPixmapSize)));
1144 #endif
1145 } else {
1146 painter->drawPixmap(m_pixmapPos, pixmap);
1147 }
1148 }
1149
1150 void KStandardItemListWidget::drawSiblingsInformation(QPainter* painter)
1151 {
1152 const int siblingSize = size().height();
1153 const int x = (m_expansionArea.left() + m_expansionArea.right() - siblingSize) / 2;
1154 QRect siblingRect(x, 0, siblingSize, siblingSize);
1155
1156 QStyleOption option;
1157 bool isItemSibling = true;
1158
1159 const QBitArray siblings = siblingsInformation();
1160 for (int i = siblings.count() - 1; i >= 0; --i) {
1161 option.rect = siblingRect;
1162 option.state = siblings.at(i) ? QStyle::State_Sibling : QStyle::State_None;
1163
1164 if (isItemSibling) {
1165 option.state |= QStyle::State_Item;
1166 if (m_isExpandable) {
1167 option.state |= QStyle::State_Children;
1168 }
1169 if (data()["isExpanded"].toBool()) {
1170 option.state |= QStyle::State_Open;
1171 }
1172 isItemSibling = false;
1173 }
1174
1175 style()->drawPrimitive(QStyle::PE_IndicatorBranch, &option, painter);
1176
1177 siblingRect.translate(-siblingRect.width(), 0);
1178 }
1179 }
1180
1181 QRectF KStandardItemListWidget::roleEditingRect(const QByteArray& role) const
1182 {
1183 const TextInfo* textInfo = m_textInfo.value(role);
1184 if (!textInfo) {
1185 return QRectF();
1186 }
1187
1188 QRectF rect(textInfo->pos, textInfo->staticText.size());
1189 if (m_layout == DetailsLayout) {
1190 rect.setWidth(columnWidth(role) - rect.x());
1191 }
1192
1193 return rect;
1194 }
1195
1196 QPixmap KStandardItemListWidget::pixmapForIcon(const QString& name, int size)
1197 {
1198 const KIcon icon(name);
1199
1200 int requestedSize;
1201 if (size <= KIconLoader::SizeSmall) {
1202 requestedSize = KIconLoader::SizeSmall;
1203 } else if (size <= KIconLoader::SizeSmallMedium) {
1204 requestedSize = KIconLoader::SizeSmallMedium;
1205 } else if (size <= KIconLoader::SizeMedium) {
1206 requestedSize = KIconLoader::SizeMedium;
1207 } else if (size <= KIconLoader::SizeLarge) {
1208 requestedSize = KIconLoader::SizeLarge;
1209 } else if (size <= KIconLoader::SizeHuge) {
1210 requestedSize = KIconLoader::SizeHuge;
1211 } else if (size <= KIconLoader::SizeEnormous) {
1212 requestedSize = KIconLoader::SizeEnormous;
1213 } else if (size <= KIconLoader::SizeEnormous * 2) {
1214 requestedSize = KIconLoader::SizeEnormous * 2;
1215 } else {
1216 requestedSize = size;
1217 }
1218
1219 QPixmap pixmap = icon.pixmap(requestedSize, requestedSize);
1220 if (requestedSize != size) {
1221 KPixmapModifier::scale(pixmap, QSize(size, size));
1222 }
1223
1224 return pixmap;
1225 }
1226
1227 void KStandardItemListWidget::applyCutEffect(QPixmap& pixmap)
1228 {
1229 KIconEffect* effect = KIconLoader::global()->iconEffect();
1230 pixmap = effect->apply(pixmap, KIconLoader::Desktop, KIconLoader::DisabledState);
1231 }
1232
1233 void KStandardItemListWidget::applyHiddenEffect(QPixmap& pixmap)
1234 {
1235 KIconEffect::semiTransparent(pixmap);
1236 }
1237
1238 QSizeF KStandardItemListWidget::preferredRatingSize(const KItemListStyleOption& option)
1239 {
1240 const qreal height = option.fontMetrics.ascent();
1241 return QSizeF(height * 5, height);
1242 }
1243
1244 qreal KStandardItemListWidget::columnPadding(const KItemListStyleOption& option)
1245 {
1246 return option.padding * 6;
1247 }
1248
1249 #include "kstandarditemlistwidget.moc"