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