1 /***************************************************************************
2 * Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com> *
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. *
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. *
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 ***************************************************************************/
20 #include "kstandarditemlistwidget.h"
22 #include "kfileitemlistview.h"
23 #include "kfileitemmodel.h"
26 #include <KIconEffect>
27 #include <KIconLoader>
29 #include <kratingpainter.h>
30 #include <KStringHandler>
33 #include "private/kfileitemclipboard.h"
34 #include "private/kitemlistroleeditor.h"
35 #include "private/kpixmapmodifier.h"
37 #include <QFontMetricsF>
38 #include <QGraphicsScene>
39 #include <QGraphicsSceneResizeEvent>
40 #include <QGraphicsView>
42 #include <QStyleOption>
43 #include <QTextLayout>
45 #include <QPixmapCache>
47 // #define KSTANDARDITEMLISTWIDGET_DEBUG
49 KStandardItemListWidgetInformant::KStandardItemListWidgetInformant() :
50 KItemListWidgetInformant()
54 KStandardItemListWidgetInformant::~KStandardItemListWidgetInformant()
58 QSizeF
KStandardItemListWidgetInformant::itemSizeHint(int index
, const KItemListView
* view
) const
60 const QHash
<QByteArray
, QVariant
> values
= view
->model()->data(index
);
61 const KItemListStyleOption
& option
= view
->styleOption();
62 const int additionalRolesCount
= qMax(view
->visibleRoles().count() - 1, 0);
64 switch (static_cast<const KStandardItemListView
*>(view
)->itemLayout()) {
65 case KStandardItemListWidget::IconsLayout
: {
66 const QString text
= KStringHandler::preProcessWrap(values
["text"].toString());
68 const qreal itemWidth
= view
->itemSize().width();
69 const qreal maxWidth
= itemWidth
- 2 * option
.padding
;
72 // Calculate the number of lines required for wrapping the name
73 QTextOption
textOption(Qt::AlignHCenter
);
74 textOption
.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere
);
77 QTextLayout
layout(text
, option
.font
);
78 layout
.setTextOption(textOption
);
80 while ((line
= layout
.createLine()).isValid()) {
81 line
.setLineWidth(maxWidth
);
82 line
.naturalTextWidth();
83 textHeight
+= line
.height();
87 // Add one line for each additional information
88 textHeight
+= additionalRolesCount
* option
.fontMetrics
.lineSpacing();
90 const qreal maxTextHeight
= option
.maxTextSize
.height();
91 if (maxTextHeight
> 0 && textHeight
> maxTextHeight
) {
92 textHeight
= maxTextHeight
;
95 return QSizeF(itemWidth
, textHeight
+ option
.iconSize
+ option
.padding
* 3);
98 case KStandardItemListWidget::CompactLayout
: {
99 // For each row exactly one role is shown. Calculate the maximum required width that is necessary
100 // to show all roles without horizontal clipping.
101 qreal maximumRequiredWidth
= 0.0;
103 foreach (const QByteArray
& role
, view
->visibleRoles()) {
104 const QString text
= roleText(role
, values
);
105 const qreal requiredWidth
= option
.fontMetrics
.width(text
);
106 maximumRequiredWidth
= qMax(maximumRequiredWidth
, requiredWidth
);
109 qreal width
= option
.padding
* 4 + option
.iconSize
+ maximumRequiredWidth
;
110 const qreal maxWidth
= option
.maxTextSize
.width();
111 if (maxWidth
> 0 && width
> maxWidth
) {
114 const qreal height
= option
.padding
* 2 + qMax(option
.iconSize
, (1 + additionalRolesCount
) * option
.fontMetrics
.lineSpacing());
115 return QSizeF(width
, height
);
118 case KStandardItemListWidget::DetailsLayout
: {
119 const qreal height
= option
.padding
* 2 + qMax(option
.iconSize
, option
.fontMetrics
.height());
120 return QSizeF(-1, height
);
131 qreal
KStandardItemListWidgetInformant::preferredRoleColumnWidth(const QByteArray
& role
,
133 const KItemListView
* view
) const
135 const QHash
<QByteArray
, QVariant
> values
= view
->model()->data(index
);
136 const KItemListStyleOption
& option
= view
->styleOption();
138 const QString text
= roleText(role
, values
);
139 qreal width
= KStandardItemListWidget::columnPadding(option
);
141 if (role
== "rating") {
142 width
+= KStandardItemListWidget::preferredRatingSize(option
).width();
144 width
+= option
.fontMetrics
.width(text
);
146 if (role
== "text") {
147 if (view
->supportsItemExpanding()) {
148 // Increase the width by the expansion-toggle and the current expansion level
149 const int expandedParentsCount
= values
.value("expandedParentsCount", 0).toInt();
150 const qreal height
= option
.padding
* 2 + qMax(option
.iconSize
, option
.fontMetrics
.height());
151 width
+= (expandedParentsCount
+ 1) * height
;
154 // Increase the width by the required space for the icon
155 width
+= option
.padding
* 2 + option
.iconSize
;
162 QString
KStandardItemListWidgetInformant::roleText(const QByteArray
& role
,
163 const QHash
<QByteArray
, QVariant
>& values
) const
165 if (role
== "rating") {
166 // Always use an empty text, as the rating is shown by the image m_rating.
169 return values
.value(role
).toString();
172 KStandardItemListWidget::KStandardItemListWidget(KItemListWidgetInformant
* informant
, QGraphicsItem
* parent
) :
173 KItemListWidget(informant
, parent
),
177 m_customizedFontMetrics(m_customizedFont
),
178 m_isExpandable(false),
179 m_supportsItemExpanding(false),
181 m_dirtyContent(true),
182 m_dirtyContentRoles(),
183 m_layout(IconsLayout
),
186 m_scaledPixmapSize(),
191 m_sortedVisibleRoles(),
194 m_additionalInfoTextColor(),
202 KStandardItemListWidget::~KStandardItemListWidget()
204 qDeleteAll(m_textInfo
);
208 delete m_oldRoleEditor
;
211 void KStandardItemListWidget::setLayout(Layout layout
)
213 if (m_layout
!= layout
) {
215 m_dirtyLayout
= true;
216 updateAdditionalInfoTextColor();
221 KStandardItemListWidget::Layout
KStandardItemListWidget::layout() const
226 void KStandardItemListWidget::setSupportsItemExpanding(bool supportsItemExpanding
)
228 if (m_supportsItemExpanding
!= supportsItemExpanding
) {
229 m_supportsItemExpanding
= supportsItemExpanding
;
230 m_dirtyLayout
= true;
235 bool KStandardItemListWidget::supportsItemExpanding() const
237 return m_supportsItemExpanding
;
240 void KStandardItemListWidget::paint(QPainter
* painter
, const QStyleOptionGraphicsItem
* option
, QWidget
* widget
)
242 const_cast<KStandardItemListWidget
*>(this)->triggerCacheRefreshing();
244 KItemListWidget::paint(painter
, option
, widget
);
246 if (!m_expansionArea
.isEmpty()) {
247 drawSiblingsInformation(painter
);
250 const KItemListStyleOption
& itemListStyleOption
= styleOption();
252 if (hoverOpacity() < 1.0) {
254 * Linear interpolation between m_pixmap and m_hoverPixmap.
256 * Note that this cannot be achieved by painting m_hoverPixmap over
257 * m_pixmap, even if the opacities are adjusted. For details see
258 * https://git.reviewboard.kde.org/r/109614/
260 // Paint pixmap1 so that pixmap1 = m_pixmap * (1.0 - hoverOpacity())
261 QPixmap
pixmap1(m_pixmap
.size());
262 pixmap1
.fill(Qt::transparent
);
264 QPainter
p(&pixmap1
);
265 p
.setOpacity(1.0 - hoverOpacity());
266 p
.drawPixmap(0, 0, m_pixmap
);
269 // Paint pixmap2 so that pixmap2 = m_hoverPixmap * hoverOpacity()
270 QPixmap
pixmap2(pixmap1
.size());
271 pixmap2
.fill(Qt::transparent
);
273 QPainter
p(&pixmap2
);
274 p
.setOpacity(hoverOpacity());
275 p
.drawPixmap(0, 0, m_hoverPixmap
);
278 // Paint pixmap2 on pixmap1 using CompositionMode_Plus
279 // Now pixmap1 = pixmap2 + m_pixmap * (1.0 - hoverOpacity())
280 // = m_hoverPixmap * hoverOpacity() + m_pixmap * (1.0 - hoverOpacity())
282 QPainter
p(&pixmap1
);
283 p
.setCompositionMode(QPainter::CompositionMode_Plus
);
284 p
.drawPixmap(0, 0, pixmap2
);
287 // Finally paint pixmap1 on the widget
288 drawPixmap(painter
, pixmap1
);
290 drawPixmap(painter
, m_hoverPixmap
);
293 drawPixmap(painter
, m_pixmap
);
296 painter
->setFont(m_customizedFont
);
297 painter
->setPen(textColor());
298 const TextInfo
* textInfo
= m_textInfo
.value("text");
301 // It seems that we can end up here even if m_textInfo does not contain
302 // the key "text", see bug 306167. According to triggerCacheRefreshing(),
303 // this can only happen if the index is negative. This can happen when
304 // the item is about to be removed, see KItemListView::slotItemsRemoved().
305 // TODO: try to reproduce the crash and find a better fix.
309 painter
->drawStaticText(textInfo
->pos
, textInfo
->staticText
);
311 bool clipAdditionalInfoBounds
= false;
312 if (m_supportsItemExpanding
) {
313 // Prevent a possible overlapping of the additional-information texts
314 // with the icon. This can happen if the user has minimized the width
315 // of the name-column to a very small value.
316 const qreal minX
= m_pixmapPos
.x() + m_pixmap
.width() + 4 * itemListStyleOption
.padding
;
317 if (textInfo
->pos
.x() + columnWidth("text") > minX
) {
318 clipAdditionalInfoBounds
= true;
320 painter
->setClipRect(minX
, 0, size().width() - minX
, size().height(), Qt::IntersectClip
);
324 painter
->setPen(m_additionalInfoTextColor
);
325 painter
->setFont(m_customizedFont
);
327 for (int i
= 1; i
< m_sortedVisibleRoles
.count(); ++i
) {
328 const TextInfo
* textInfo
= m_textInfo
.value(m_sortedVisibleRoles
[i
]);
329 painter
->drawStaticText(textInfo
->pos
, textInfo
->staticText
);
332 if (!m_rating
.isNull()) {
333 const TextInfo
* ratingTextInfo
= m_textInfo
.value("rating");
334 QPointF pos
= ratingTextInfo
->pos
;
335 const Qt::Alignment align
= ratingTextInfo
->staticText
.textOption().alignment();
336 if (align
& Qt::AlignHCenter
) {
337 pos
.rx() += (size().width() - m_rating
.width()) / 2 - 2;
339 painter
->drawPixmap(pos
, m_rating
);
342 if (clipAdditionalInfoBounds
) {
346 #ifdef KSTANDARDITEMLISTWIDGET_DEBUG
347 painter
->setBrush(Qt::NoBrush
);
348 painter
->setPen(Qt::green
);
349 painter
->drawRect(m_iconRect
);
351 painter
->setPen(Qt::red
);
352 painter
->drawText(QPointF(0, m_customizedFontMetrics
.height()), QString::number(index()));
353 painter
->drawRect(rect());
357 QRectF
KStandardItemListWidget::iconRect() const
359 const_cast<KStandardItemListWidget
*>(this)->triggerCacheRefreshing();
363 QRectF
KStandardItemListWidget::textRect() const
365 const_cast<KStandardItemListWidget
*>(this)->triggerCacheRefreshing();
369 QRectF
KStandardItemListWidget::textFocusRect() const
371 // In the compact- and details-layout a larger textRect() is returned to be aligned
372 // with the iconRect(). This is useful to have a larger selection/hover-area
373 // when having a quite large icon size but only one line of text. Still the
374 // focus rectangle should be shown as narrow as possible around the text.
376 const_cast<KStandardItemListWidget
*>(this)->triggerCacheRefreshing();
379 case CompactLayout
: {
380 QRectF rect
= m_textRect
;
381 const TextInfo
* topText
= m_textInfo
.value(m_sortedVisibleRoles
.first());
382 const TextInfo
* bottomText
= m_textInfo
.value(m_sortedVisibleRoles
.last());
383 rect
.setTop(topText
->pos
.y());
384 rect
.setBottom(bottomText
->pos
.y() + bottomText
->staticText
.size().height());
388 case DetailsLayout
: {
389 QRectF rect
= m_textRect
;
390 const TextInfo
* textInfo
= m_textInfo
.value(m_sortedVisibleRoles
.first());
391 rect
.setTop(textInfo
->pos
.y());
392 rect
.setBottom(textInfo
->pos
.y() + textInfo
->staticText
.size().height());
394 const KItemListStyleOption
& option
= styleOption();
395 if (option
.extendedSelectionRegion
) {
396 const QString text
= textInfo
->staticText
.text();
397 rect
.setWidth(m_customizedFontMetrics
.width(text
) + 2 * option
.padding
);
410 QRectF
KStandardItemListWidget::expansionToggleRect() const
412 const_cast<KStandardItemListWidget
*>(this)->triggerCacheRefreshing();
413 return m_isExpandable
? m_expansionArea
: QRectF();
416 QRectF
KStandardItemListWidget::selectionToggleRect() const
418 const_cast<KStandardItemListWidget
*>(this)->triggerCacheRefreshing();
420 const int iconHeight
= styleOption().iconSize
;
422 int toggleSize
= KIconLoader::SizeSmall
;
423 if (iconHeight
>= KIconLoader::SizeEnormous
) {
424 toggleSize
= KIconLoader::SizeMedium
;
425 } else if (iconHeight
>= KIconLoader::SizeLarge
) {
426 toggleSize
= KIconLoader::SizeSmallMedium
;
429 QPointF pos
= iconRect().topLeft();
431 // If the selection toggle has a very small distance to the
432 // widget borders, the size of the selection toggle will get
433 // increased to prevent an accidental clicking of the item
434 // when trying to hit the toggle.
435 const int widgetHeight
= size().height();
436 const int widgetWidth
= size().width();
437 const int minMargin
= 2;
439 if (toggleSize
+ minMargin
* 2 >= widgetHeight
) {
440 pos
.rx() -= (widgetHeight
- toggleSize
) / 2;
441 toggleSize
= widgetHeight
;
444 if (toggleSize
+ minMargin
* 2 >= widgetWidth
) {
445 pos
.ry() -= (widgetWidth
- toggleSize
) / 2;
446 toggleSize
= widgetWidth
;
450 return QRectF(pos
, QSizeF(toggleSize
, toggleSize
));
453 QPixmap
KStandardItemListWidget::createDragPixmap(const QStyleOptionGraphicsItem
* option
,
456 QPixmap pixmap
= KItemListWidget::createDragPixmap(option
, widget
);
457 if (m_layout
!= DetailsLayout
) {
461 // Only return the content of the text-column as pixmap
462 const int leftClip
= m_pixmapPos
.x();
464 const TextInfo
* textInfo
= m_textInfo
.value("text");
465 const int rightClip
= textInfo
->pos
.x() +
466 textInfo
->staticText
.size().width() +
467 2 * styleOption().padding
;
469 QPixmap
clippedPixmap(rightClip
- leftClip
+ 1, pixmap
.height());
470 clippedPixmap
.fill(Qt::transparent
);
472 QPainter
painter(&clippedPixmap
);
473 painter
.drawPixmap(-leftClip
, 0, pixmap
);
475 return clippedPixmap
;
479 KItemListWidgetInformant
* KStandardItemListWidget::createInformant()
481 return new KStandardItemListWidgetInformant();
484 void KStandardItemListWidget::invalidateCache()
486 m_dirtyLayout
= true;
487 m_dirtyContent
= true;
490 void KStandardItemListWidget::refreshCache()
494 bool KStandardItemListWidget::isRoleRightAligned(const QByteArray
& role
) const
500 bool KStandardItemListWidget::isHidden() const
505 QFont
KStandardItemListWidget::customizedFont(const QFont
& baseFont
) const
510 QPalette::ColorRole
KStandardItemListWidget::normalTextColorRole() const
512 return QPalette::Text
;
515 void KStandardItemListWidget::setTextColor(const QColor
& color
)
517 if (color
!= m_customTextColor
) {
518 m_customTextColor
= color
;
519 updateAdditionalInfoTextColor();
524 QColor
KStandardItemListWidget::textColor() const
528 return m_additionalInfoTextColor
;
529 } else if (m_customTextColor
.isValid()) {
530 return m_customTextColor
;
534 const QPalette::ColorGroup group
= isActiveWindow() ? QPalette::Active
: QPalette::Inactive
;
535 const QPalette::ColorRole role
= isSelected() ? QPalette::HighlightedText
: normalTextColorRole();
536 return styleOption().palette
.color(group
, role
);
539 void KStandardItemListWidget::setOverlay(const QPixmap
& overlay
)
542 m_dirtyContent
= true;
546 QPixmap
KStandardItemListWidget::overlay() const
552 QString
KStandardItemListWidget::roleText(const QByteArray
& role
,
553 const QHash
<QByteArray
, QVariant
>& values
) const
555 return static_cast<const KStandardItemListWidgetInformant
*>(informant())->roleText(role
, values
);
558 void KStandardItemListWidget::dataChanged(const QHash
<QByteArray
, QVariant
>& current
,
559 const QSet
<QByteArray
>& roles
)
563 m_dirtyContent
= true;
565 QSet
<QByteArray
> dirtyRoles
;
566 if (roles
.isEmpty()) {
567 dirtyRoles
= visibleRoles().toSet();
572 // The icon-state might depend from other roles and hence is
573 // marked as dirty whenever a role has been changed
574 dirtyRoles
.insert("iconPixmap");
575 dirtyRoles
.insert("iconName");
577 QSetIterator
<QByteArray
> it(dirtyRoles
);
578 while (it
.hasNext()) {
579 const QByteArray
& role
= it
.next();
580 m_dirtyContentRoles
.insert(role
);
584 void KStandardItemListWidget::visibleRolesChanged(const QList
<QByteArray
>& current
,
585 const QList
<QByteArray
>& previous
)
588 m_sortedVisibleRoles
= current
;
589 m_dirtyLayout
= true;
592 void KStandardItemListWidget::columnWidthChanged(const QByteArray
& role
,
599 m_dirtyLayout
= true;
602 void KStandardItemListWidget::styleOptionChanged(const KItemListStyleOption
& current
,
603 const KItemListStyleOption
& previous
)
607 updateAdditionalInfoTextColor();
608 m_dirtyLayout
= true;
611 void KStandardItemListWidget::hoveredChanged(bool hovered
)
614 m_dirtyLayout
= true;
617 void KStandardItemListWidget::selectedChanged(bool selected
)
620 updateAdditionalInfoTextColor();
621 m_dirtyContent
= true;
624 void KStandardItemListWidget::siblingsInformationChanged(const QBitArray
& current
, const QBitArray
& previous
)
628 m_dirtyLayout
= true;
631 int KStandardItemListWidget::selectionLength(const QString
& text
) const
633 return text
.length();
636 void KStandardItemListWidget::editedRoleChanged(const QByteArray
& current
, const QByteArray
& previous
)
640 QGraphicsView
* parent
= scene()->views()[0];
641 if (current
.isEmpty() || !parent
|| current
!= "text") {
643 emit
roleEditingCanceled(index(), current
, data().value(current
));
645 disconnect(m_roleEditor
, SIGNAL(roleEditingCanceled(QByteArray
,QVariant
)),
646 this, SLOT(slotRoleEditingCanceled(QByteArray
,QVariant
)));
647 disconnect(m_roleEditor
, SIGNAL(roleEditingFinished(QByteArray
,QVariant
)),
648 this, SLOT(slotRoleEditingFinished(QByteArray
,QVariant
)));
649 m_oldRoleEditor
= m_roleEditor
;
650 m_roleEditor
->hide();
654 } else if (m_oldRoleEditor
) {
655 // Delete the old editor before constructing the new one to
656 // prevent a memory leak.
657 m_oldRoleEditor
->deleteLater();
661 Q_ASSERT(!m_roleEditor
);
663 const TextInfo
* textInfo
= m_textInfo
.value("text");
665 m_roleEditor
= new KItemListRoleEditor(parent
);
666 m_roleEditor
->setRole(current
);
667 m_roleEditor
->setFont(styleOption().font
);
669 const QString text
= data().value(current
).toString();
670 m_roleEditor
->setPlainText(text
);
672 QTextOption textOption
= textInfo
->staticText
.textOption();
673 m_roleEditor
->document()->setDefaultTextOption(textOption
);
675 const int textSelectionLength
= selectionLength(text
);
677 if (textSelectionLength
> 0) {
678 QTextCursor cursor
= m_roleEditor
->textCursor();
679 cursor
.movePosition(QTextCursor::StartOfBlock
);
680 cursor
.movePosition(QTextCursor::NextCharacter
, QTextCursor::KeepAnchor
, textSelectionLength
);
681 m_roleEditor
->setTextCursor(cursor
);
684 connect(m_roleEditor
, SIGNAL(roleEditingCanceled(QByteArray
,QVariant
)),
685 this, SLOT(slotRoleEditingCanceled(QByteArray
,QVariant
)));
686 connect(m_roleEditor
, SIGNAL(roleEditingFinished(QByteArray
,QVariant
)),
687 this, SLOT(slotRoleEditingFinished(QByteArray
,QVariant
)));
689 // Adjust the geometry of the editor
690 QRectF rect
= roleEditingRect(current
);
691 const int frameWidth
= m_roleEditor
->frameWidth();
692 rect
.adjust(-frameWidth
, -frameWidth
, frameWidth
, frameWidth
);
693 rect
.translate(pos());
694 if (rect
.right() > parent
->width()) {
695 rect
.setWidth(parent
->width() - rect
.left());
697 m_roleEditor
->setGeometry(rect
.toRect());
698 m_roleEditor
->show();
699 m_roleEditor
->setFocus();
702 void KStandardItemListWidget::resizeEvent(QGraphicsSceneResizeEvent
* event
)
705 setEditedRole(QByteArray());
706 Q_ASSERT(!m_roleEditor
);
709 KItemListWidget::resizeEvent(event
);
711 m_dirtyLayout
= true;
714 void KStandardItemListWidget::showEvent(QShowEvent
* event
)
716 KItemListWidget::showEvent(event
);
718 // Listen to changes of the clipboard to mark the item as cut/uncut
719 KFileItemClipboard
* clipboard
= KFileItemClipboard::instance();
721 const KUrl itemUrl
= data().value("url").value
<KUrl
>();
722 m_isCut
= clipboard
->isCut(itemUrl
);
724 connect(clipboard
, SIGNAL(cutItemsChanged()),
725 this, SLOT(slotCutItemsChanged()));
728 void KStandardItemListWidget::hideEvent(QHideEvent
* event
)
730 disconnect(KFileItemClipboard::instance(), SIGNAL(cutItemsChanged()),
731 this, SLOT(slotCutItemsChanged()));
733 KItemListWidget::hideEvent(event
);
736 void KStandardItemListWidget::slotCutItemsChanged()
738 const KUrl itemUrl
= data().value("url").value
<KUrl
>();
739 const bool isCut
= KFileItemClipboard::instance()->isCut(itemUrl
);
740 if (m_isCut
!= isCut
) {
742 m_pixmap
= QPixmap();
743 m_dirtyContent
= true;
748 void KStandardItemListWidget::slotRoleEditingCanceled(const QByteArray
& role
,
749 const QVariant
& value
)
752 emit
roleEditingCanceled(index(), role
, value
);
753 setEditedRole(QByteArray());
756 void KStandardItemListWidget::slotRoleEditingFinished(const QByteArray
& role
,
757 const QVariant
& value
)
760 emit
roleEditingFinished(index(), role
, value
);
761 setEditedRole(QByteArray());
764 void KStandardItemListWidget::triggerCacheRefreshing()
766 if ((!m_dirtyContent
&& !m_dirtyLayout
) || index() < 0) {
772 const QHash
<QByteArray
, QVariant
> values
= data();
773 m_isExpandable
= m_supportsItemExpanding
&& values
["isExpandable"].toBool();
774 m_isHidden
= isHidden();
775 m_customizedFont
= customizedFont(styleOption().font
);
776 m_customizedFontMetrics
= QFontMetrics(m_customizedFont
);
778 updateExpansionArea();
782 m_dirtyLayout
= false;
783 m_dirtyContent
= false;
784 m_dirtyContentRoles
.clear();
787 void KStandardItemListWidget::updateExpansionArea()
789 if (m_supportsItemExpanding
) {
790 const QHash
<QByteArray
, QVariant
> values
= data();
791 Q_ASSERT(values
.contains("expandedParentsCount"));
792 const int expandedParentsCount
= values
.value("expandedParentsCount", 0).toInt();
793 if (expandedParentsCount
>= 0) {
794 const qreal widgetHeight
= size().height();
795 const qreal inc
= (widgetHeight
- KIconLoader::SizeSmall
) / 2;
796 const qreal x
= expandedParentsCount
* widgetHeight
+ inc
;
798 m_expansionArea
= QRectF(x
, y
, KIconLoader::SizeSmall
, KIconLoader::SizeSmall
);
803 m_expansionArea
= QRectF();
806 void KStandardItemListWidget::updatePixmapCache()
808 // Precondition: Requires already updated m_textPos values to calculate
809 // the remaining height when the alignment is vertical.
811 const QSizeF widgetSize
= size();
812 const bool iconOnTop
= (m_layout
== IconsLayout
);
813 const KItemListStyleOption
& option
= styleOption();
814 const qreal padding
= option
.padding
;
816 const int maxIconWidth
= iconOnTop
? widgetSize
.width() - 2 * padding
: option
.iconSize
;
817 const int maxIconHeight
= option
.iconSize
;
819 const QHash
<QByteArray
, QVariant
> values
= data();
821 bool updatePixmap
= (m_pixmap
.width() != maxIconWidth
|| m_pixmap
.height() != maxIconHeight
);
822 if (!updatePixmap
&& m_dirtyContent
) {
823 updatePixmap
= m_dirtyContentRoles
.isEmpty()
824 || m_dirtyContentRoles
.contains("iconPixmap")
825 || m_dirtyContentRoles
.contains("iconName")
826 || m_dirtyContentRoles
.contains("iconOverlays");
830 m_pixmap
= values
["iconPixmap"].value
<QPixmap
>();
831 if (m_pixmap
.isNull()) {
832 // Use the icon that fits to the MIME-type
833 QString iconName
= values
["iconName"].toString();
834 if (iconName
.isEmpty()) {
835 // The icon-name has not been not resolved by KFileItemModelRolesUpdater,
836 // use a generic icon as fallback
837 iconName
= QLatin1String("unknown");
839 m_pixmap
= pixmapForIcon(iconName
, maxIconHeight
);
840 } else if (m_pixmap
.width() != maxIconWidth
|| m_pixmap
.height() != maxIconHeight
) {
841 // A custom pixmap has been applied. Assure that the pixmap
842 // is scaled to the maximum available size.
843 KPixmapModifier::scale(m_pixmap
, QSize(maxIconWidth
, maxIconHeight
));
846 const QStringList overlays
= values
["iconOverlays"].toStringList();
848 // Strangely KFileItem::overlays() returns empty string-values, so
849 // we need to check first whether an overlay must be drawn at all.
850 // It is more efficient to do it here, as KIconLoader::drawOverlays()
851 // assumes that an overlay will be drawn and has some additional
853 foreach (const QString
& overlay
, overlays
) {
854 if (!overlay
.isEmpty()) {
855 // There is at least one overlay, draw all overlays above m_pixmap
856 // and cancel the check
857 KIconLoader::global()->drawOverlays(overlays
, m_pixmap
, KIconLoader::Desktop
);
863 KIconEffect
* effect
= KIconLoader::global()->iconEffect();
864 m_pixmap
= effect
->apply(m_pixmap
, KIconLoader::Desktop
, KIconLoader::DisabledState
);
868 KIconEffect::semiTransparent(m_pixmap
);
872 const QColor color
= palette().brush(QPalette::Normal
, QPalette::Highlight
).color();
873 QImage image
= m_pixmap
.toImage();
874 KIconEffect::colorize(image
, color
, 0.8f
);
875 m_pixmap
= QPixmap::fromImage(image
);
879 if (!m_overlay
.isNull()) {
880 QPainter
painter(&m_pixmap
);
881 painter
.drawPixmap(0, m_pixmap
.height() - m_overlay
.height(), m_overlay
);
884 int scaledIconSize
= 0;
886 const TextInfo
* textInfo
= m_textInfo
.value("text");
887 scaledIconSize
= static_cast<int>(textInfo
->pos
.y() - 2 * padding
);
889 const int textRowsCount
= (m_layout
== CompactLayout
) ? visibleRoles().count() : 1;
890 const qreal requiredTextHeight
= textRowsCount
* m_customizedFontMetrics
.height();
891 scaledIconSize
= (requiredTextHeight
< maxIconHeight
) ?
892 widgetSize
.height() - 2 * padding
: maxIconHeight
;
895 const int maxScaledIconWidth
= iconOnTop
? widgetSize
.width() - 2 * padding
: scaledIconSize
;
896 const int maxScaledIconHeight
= scaledIconSize
;
898 m_scaledPixmapSize
= m_pixmap
.size();
899 m_scaledPixmapSize
.scale(maxScaledIconWidth
, maxScaledIconHeight
, Qt::KeepAspectRatio
);
902 // Center horizontally and align on bottom within the icon-area
903 m_pixmapPos
.setX((widgetSize
.width() - m_scaledPixmapSize
.width()) / 2);
904 m_pixmapPos
.setY(padding
+ scaledIconSize
- m_scaledPixmapSize
.height());
906 // Center horizontally and vertically within the icon-area
907 const TextInfo
* textInfo
= m_textInfo
.value("text");
908 m_pixmapPos
.setX(textInfo
->pos
.x() - 2 * padding
909 - (scaledIconSize
+ m_scaledPixmapSize
.width()) / 2);
910 m_pixmapPos
.setY(padding
911 + (scaledIconSize
- m_scaledPixmapSize
.height()) / 2);
914 m_iconRect
= QRectF(m_pixmapPos
, QSizeF(m_scaledPixmapSize
));
916 // Prepare the pixmap that is used when the item gets hovered
918 m_hoverPixmap
= m_pixmap
;
919 KIconEffect
* effect
= KIconLoader::global()->iconEffect();
920 // In the KIconLoader terminology, active = hover.
921 if (effect
->hasEffect(KIconLoader::Desktop
, KIconLoader::ActiveState
)) {
922 m_hoverPixmap
= effect
->apply(m_pixmap
, KIconLoader::Desktop
, KIconLoader::ActiveState
);
924 m_hoverPixmap
= m_pixmap
;
926 } else if (hoverOpacity() <= 0.0) {
927 // No hover animation is ongoing. Clear m_hoverPixmap to save memory.
928 m_hoverPixmap
= QPixmap();
932 void KStandardItemListWidget::updateTextsCache()
934 QTextOption textOption
;
937 textOption
.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere
);
938 textOption
.setAlignment(Qt::AlignHCenter
);
942 textOption
.setAlignment(Qt::AlignLeft
);
943 textOption
.setWrapMode(QTextOption::NoWrap
);
950 qDeleteAll(m_textInfo
);
952 for (int i
= 0; i
< m_sortedVisibleRoles
.count(); ++i
) {
953 TextInfo
* textInfo
= new TextInfo();
954 textInfo
->staticText
.setTextFormat(Qt::PlainText
);
955 textInfo
->staticText
.setPerformanceHint(QStaticText::AggressiveCaching
);
956 textInfo
->staticText
.setTextOption(textOption
);
957 m_textInfo
.insert(m_sortedVisibleRoles
[i
], textInfo
);
961 case IconsLayout
: updateIconsLayoutTextCache(); break;
962 case CompactLayout
: updateCompactLayoutTextCache(); break;
963 case DetailsLayout
: updateDetailsLayoutTextCache(); break;
964 default: Q_ASSERT(false); break;
967 const TextInfo
* ratingTextInfo
= m_textInfo
.value("rating");
968 if (ratingTextInfo
) {
969 // The text of the rating-role has been set to empty to get
970 // replaced by a rating-image showing the rating as stars.
971 const KItemListStyleOption
& option
= styleOption();
972 QSizeF ratingSize
= preferredRatingSize(option
);
974 const qreal availableWidth
= (m_layout
== DetailsLayout
)
975 ? columnWidth("rating") - columnPadding(option
)
977 if (ratingSize
.width() > availableWidth
) {
978 ratingSize
.rwidth() = availableWidth
;
980 m_rating
= QPixmap(ratingSize
.toSize());
981 m_rating
.fill(Qt::transparent
);
983 QPainter
painter(&m_rating
);
984 const QRect
rect(0, 0, m_rating
.width(), m_rating
.height());
985 const int rating
= data().value("rating").toInt();
986 KRatingPainter::paintRating(&painter
, rect
, Qt::AlignJustify
| Qt::AlignVCenter
, rating
);
987 } else if (!m_rating
.isNull()) {
988 m_rating
= QPixmap();
992 void KStandardItemListWidget::updateIconsLayoutTextCache()
999 // might get wrapped above
1001 // Additional role 1
1002 // Additional role 2
1004 const QHash
<QByteArray
, QVariant
> values
= data();
1006 const KItemListStyleOption
& option
= styleOption();
1007 const qreal padding
= option
.padding
;
1008 const qreal maxWidth
= size().width() - 2 * padding
;
1009 const qreal widgetHeight
= size().height();
1010 const qreal lineSpacing
= m_customizedFontMetrics
.lineSpacing();
1012 // Initialize properties for the "text" role. It will be used as anchor
1013 // for initializing the position of the other roles.
1014 TextInfo
* nameTextInfo
= m_textInfo
.value("text");
1015 const QString nameText
= KStringHandler::preProcessWrap(values
["text"].toString());
1016 nameTextInfo
->staticText
.setText(nameText
);
1018 // Calculate the number of lines required for the name and the required width
1019 qreal nameWidth
= 0;
1020 qreal nameHeight
= 0;
1023 const int additionalRolesCount
= qMax(visibleRoles().count() - 1, 0);
1024 const int maxNameLines
= (option
.maxTextSize
.height() / int(lineSpacing
)) - additionalRolesCount
;
1026 QTextLayout
layout(nameTextInfo
->staticText
.text(), m_customizedFont
);
1027 layout
.setTextOption(nameTextInfo
->staticText
.textOption());
1028 layout
.beginLayout();
1029 int nameLineIndex
= 0;
1030 while ((line
= layout
.createLine()).isValid()) {
1031 line
.setLineWidth(maxWidth
);
1032 nameWidth
= qMax(nameWidth
, line
.naturalTextWidth());
1033 nameHeight
+= line
.height();
1036 if (nameLineIndex
== maxNameLines
) {
1037 // The maximum number of textlines has been reached. If this is
1038 // the case provide an elided text if necessary.
1039 const int textLength
= line
.textStart() + line
.textLength();
1040 if (textLength
< nameText
.length()) {
1041 // Elide the last line of the text
1042 QString lastTextLine
= nameText
.mid(line
.textStart(), line
.textLength());
1043 lastTextLine
= m_customizedFontMetrics
.elidedText(lastTextLine
,
1045 line
.naturalTextWidth() - 1);
1046 const QString elidedText
= nameText
.left(line
.textStart()) + lastTextLine
;
1047 nameTextInfo
->staticText
.setText(elidedText
);
1054 // Use one line for each additional information
1055 nameTextInfo
->staticText
.setTextWidth(maxWidth
);
1056 nameTextInfo
->pos
= QPointF(padding
, widgetHeight
-
1058 additionalRolesCount
* lineSpacing
-
1060 m_textRect
= QRectF(padding
+ (maxWidth
- nameWidth
) / 2,
1061 nameTextInfo
->pos
.y(),
1065 // Calculate the position for each additional information
1066 qreal y
= nameTextInfo
->pos
.y() + nameHeight
;
1067 foreach (const QByteArray
& role
, m_sortedVisibleRoles
) {
1068 if (role
== "text") {
1072 const QString text
= roleText(role
, values
);
1073 TextInfo
* textInfo
= m_textInfo
.value(role
);
1074 textInfo
->staticText
.setText(text
);
1076 qreal requiredWidth
= 0;
1078 QTextLayout
layout(text
, m_customizedFont
);
1079 QTextOption textOption
;
1080 textOption
.setWrapMode(QTextOption::NoWrap
);
1081 layout
.setTextOption(textOption
);
1083 layout
.beginLayout();
1084 QTextLine textLine
= layout
.createLine();
1085 if (textLine
.isValid()) {
1086 textLine
.setLineWidth(maxWidth
);
1087 requiredWidth
= textLine
.naturalTextWidth();
1088 if (requiredWidth
> maxWidth
) {
1089 const QString elidedText
= m_customizedFontMetrics
.elidedText(text
, Qt::ElideRight
, maxWidth
);
1090 textInfo
->staticText
.setText(elidedText
);
1091 requiredWidth
= m_customizedFontMetrics
.width(elidedText
);
1092 } else if (role
== "rating") {
1093 // Use the width of the rating pixmap, because the rating text is empty.
1094 requiredWidth
= m_rating
.width();
1099 textInfo
->pos
= QPointF(padding
, y
);
1100 textInfo
->staticText
.setTextWidth(maxWidth
);
1102 const QRectF
textRect(padding
+ (maxWidth
- requiredWidth
) / 2, y
, requiredWidth
, lineSpacing
);
1103 m_textRect
|= textRect
;
1108 // Add a padding to the text rectangle
1109 m_textRect
.adjust(-padding
, -padding
, padding
, padding
);
1112 void KStandardItemListWidget::updateCompactLayoutTextCache()
1114 // +------+ Name role
1115 // | Icon | Additional role 1
1116 // +------+ Additional role 2
1118 const QHash
<QByteArray
, QVariant
> values
= data();
1120 const KItemListStyleOption
& option
= styleOption();
1121 const qreal widgetHeight
= size().height();
1122 const qreal lineSpacing
= m_customizedFontMetrics
.lineSpacing();
1123 const qreal textLinesHeight
= qMax(visibleRoles().count(), 1) * lineSpacing
;
1124 const int scaledIconSize
= (textLinesHeight
< option
.iconSize
) ? widgetHeight
- 2 * option
.padding
: option
.iconSize
;
1126 qreal maximumRequiredTextWidth
= 0;
1127 const qreal x
= option
.padding
* 3 + scaledIconSize
;
1128 qreal y
= qRound((widgetHeight
- textLinesHeight
) / 2);
1129 const qreal maxWidth
= size().width() - x
- option
.padding
;
1130 foreach (const QByteArray
& role
, m_sortedVisibleRoles
) {
1131 const QString text
= roleText(role
, values
);
1132 TextInfo
* textInfo
= m_textInfo
.value(role
);
1133 textInfo
->staticText
.setText(text
);
1135 qreal requiredWidth
= m_customizedFontMetrics
.width(text
);
1136 if (requiredWidth
> maxWidth
) {
1137 requiredWidth
= maxWidth
;
1138 const QString elidedText
= m_customizedFontMetrics
.elidedText(text
, Qt::ElideRight
, maxWidth
);
1139 textInfo
->staticText
.setText(elidedText
);
1142 textInfo
->pos
= QPointF(x
, y
);
1143 textInfo
->staticText
.setTextWidth(maxWidth
);
1145 maximumRequiredTextWidth
= qMax(maximumRequiredTextWidth
, requiredWidth
);
1150 m_textRect
= QRectF(x
- option
.padding
, 0, maximumRequiredTextWidth
+ 2 * option
.padding
, widgetHeight
);
1153 void KStandardItemListWidget::updateDetailsLayoutTextCache()
1155 // Precondition: Requires already updated m_expansionArea
1156 // to determine the left position.
1159 // | Icon | Name role Additional role 1 Additional role 2
1161 m_textRect
= QRectF();
1163 const KItemListStyleOption
& option
= styleOption();
1164 const QHash
<QByteArray
, QVariant
> values
= data();
1166 const qreal widgetHeight
= size().height();
1167 const int scaledIconSize
= widgetHeight
- 2 * option
.padding
;
1168 const int fontHeight
= m_customizedFontMetrics
.height();
1170 const qreal columnWidthInc
= columnPadding(option
);
1171 qreal firstColumnInc
= scaledIconSize
;
1172 if (m_supportsItemExpanding
) {
1173 firstColumnInc
+= (m_expansionArea
.left() + m_expansionArea
.right() + widgetHeight
) / 2;
1175 firstColumnInc
+= option
.padding
;
1178 qreal x
= firstColumnInc
;
1179 const qreal y
= qMax(qreal(option
.padding
), (widgetHeight
- fontHeight
) / 2);
1181 foreach (const QByteArray
& role
, m_sortedVisibleRoles
) {
1182 QString text
= roleText(role
, values
);
1184 // Elide the text in case it does not fit into the available column-width
1185 qreal requiredWidth
= m_customizedFontMetrics
.width(text
);
1186 const qreal roleWidth
= columnWidth(role
);
1187 qreal availableTextWidth
= roleWidth
- columnWidthInc
;
1189 const bool isTextRole
= (role
== "text");
1191 availableTextWidth
-= firstColumnInc
;
1194 if (requiredWidth
> availableTextWidth
) {
1195 text
= m_customizedFontMetrics
.elidedText(text
, Qt::ElideRight
, availableTextWidth
);
1196 requiredWidth
= m_customizedFontMetrics
.width(text
);
1199 TextInfo
* textInfo
= m_textInfo
.value(role
);
1200 textInfo
->staticText
.setText(text
);
1201 textInfo
->pos
= QPointF(x
+ columnWidthInc
/ 2, y
);
1205 const qreal textWidth
= option
.extendedSelectionRegion
1206 ? size().width() - textInfo
->pos
.x()
1207 : requiredWidth
+ 2 * option
.padding
;
1208 m_textRect
= QRectF(textInfo
->pos
.x() - option
.padding
, 0,
1209 textWidth
, size().height());
1211 // The column after the name should always be aligned on the same x-position independent
1212 // from the expansion-level shown in the name column
1213 x
-= firstColumnInc
;
1214 } else if (isRoleRightAligned(role
)) {
1215 textInfo
->pos
.rx() += roleWidth
- requiredWidth
- columnWidthInc
;
1220 void KStandardItemListWidget::updateAdditionalInfoTextColor()
1223 if (m_customTextColor
.isValid()) {
1224 c1
= m_customTextColor
;
1225 } else if (isSelected() && m_layout
!= DetailsLayout
) {
1226 c1
= styleOption().palette
.highlightedText().color();
1228 c1
= styleOption().palette
.text().color();
1231 // For the color of the additional info the inactive text color
1232 // is not used as this might lead to unreadable text for some color schemes. Instead
1233 // the text color c1 is slightly mixed with the background color.
1234 const QColor c2
= styleOption().palette
.base().color();
1236 const int p2
= 100 - p1
;
1237 m_additionalInfoTextColor
= QColor((c1
.red() * p1
+ c2
.red() * p2
) / 100,
1238 (c1
.green() * p1
+ c2
.green() * p2
) / 100,
1239 (c1
.blue() * p1
+ c2
.blue() * p2
) / 100);
1242 void KStandardItemListWidget::drawPixmap(QPainter
* painter
, const QPixmap
& pixmap
)
1244 if (m_scaledPixmapSize
!= pixmap
.size()) {
1245 QPixmap scaledPixmap
= pixmap
;
1246 KPixmapModifier::scale(scaledPixmap
, m_scaledPixmapSize
);
1247 painter
->drawPixmap(m_pixmapPos
, scaledPixmap
);
1249 #ifdef KSTANDARDITEMLISTWIDGET_DEBUG
1250 painter
->setPen(Qt::blue
);
1251 painter
->drawRect(QRectF(m_pixmapPos
, QSizeF(m_scaledPixmapSize
)));
1254 painter
->drawPixmap(m_pixmapPos
, pixmap
);
1258 void KStandardItemListWidget::drawSiblingsInformation(QPainter
* painter
)
1260 const int siblingSize
= size().height();
1261 const int x
= (m_expansionArea
.left() + m_expansionArea
.right() - siblingSize
) / 2;
1262 QRect
siblingRect(x
, 0, siblingSize
, siblingSize
);
1264 QStyleOption option
;
1265 option
.palette
.setColor(QPalette::Text
, option
.palette
.color(normalTextColorRole()));
1266 bool isItemSibling
= true;
1268 const QBitArray siblings
= siblingsInformation();
1269 for (int i
= siblings
.count() - 1; i
>= 0; --i
) {
1270 option
.rect
= siblingRect
;
1271 option
.state
= siblings
.at(i
) ? QStyle::State_Sibling
: QStyle::State_None
;
1273 if (isItemSibling
) {
1274 option
.state
|= QStyle::State_Item
;
1275 if (m_isExpandable
) {
1276 option
.state
|= QStyle::State_Children
;
1278 if (data()["isExpanded"].toBool()) {
1279 option
.state
|= QStyle::State_Open
;
1281 isItemSibling
= false;
1284 style()->drawPrimitive(QStyle::PE_IndicatorBranch
, &option
, painter
);
1286 siblingRect
.translate(-siblingRect
.width(), 0);
1290 QRectF
KStandardItemListWidget::roleEditingRect(const QByteArray
& role
) const
1292 const TextInfo
* textInfo
= m_textInfo
.value(role
);
1297 QRectF
rect(textInfo
->pos
, textInfo
->staticText
.size());
1298 if (m_layout
== DetailsLayout
) {
1299 rect
.setWidth(columnWidth(role
) - rect
.x());
1305 void KStandardItemListWidget::closeRoleEditor()
1307 disconnect(m_roleEditor
, SIGNAL(roleEditingCanceled(QByteArray
,QVariant
)),
1308 this, SLOT(slotRoleEditingCanceled(QByteArray
,QVariant
)));
1309 disconnect(m_roleEditor
, SIGNAL(roleEditingFinished(QByteArray
,QVariant
)),
1310 this, SLOT(slotRoleEditingFinished(QByteArray
,QVariant
)));
1312 if (m_roleEditor
->hasFocus()) {
1313 // If the editing was not ended by a FocusOut event, we have
1314 // to transfer the keyboard focus back to the KItemListContainer.
1315 scene()->views()[0]->parentWidget()->setFocus();
1318 m_oldRoleEditor
= m_roleEditor
;
1319 m_roleEditor
->hide();
1323 QPixmap
KStandardItemListWidget::pixmapForIcon(const QString
& name
, int size
)
1325 const QString key
= "KStandardItemListWidget:" % name
% ":" % QString::number(size
);
1328 if (!QPixmapCache::find(key
, pixmap
)) {
1329 const KIcon
icon(name
);
1332 if (size
<= KIconLoader::SizeSmall
) {
1333 requestedSize
= KIconLoader::SizeSmall
;
1334 } else if (size
<= KIconLoader::SizeSmallMedium
) {
1335 requestedSize
= KIconLoader::SizeSmallMedium
;
1336 } else if (size
<= KIconLoader::SizeMedium
) {
1337 requestedSize
= KIconLoader::SizeMedium
;
1338 } else if (size
<= KIconLoader::SizeLarge
) {
1339 requestedSize
= KIconLoader::SizeLarge
;
1340 } else if (size
<= KIconLoader::SizeHuge
) {
1341 requestedSize
= KIconLoader::SizeHuge
;
1342 } else if (size
<= KIconLoader::SizeEnormous
) {
1343 requestedSize
= KIconLoader::SizeEnormous
;
1344 } else if (size
<= KIconLoader::SizeEnormous
* 2) {
1345 requestedSize
= KIconLoader::SizeEnormous
* 2;
1347 requestedSize
= size
;
1350 pixmap
= icon
.pixmap(requestedSize
, requestedSize
);
1351 if (requestedSize
!= size
) {
1352 KPixmapModifier::scale(pixmap
, QSize(size
, size
));
1355 QPixmapCache::insert(key
, pixmap
);
1361 QSizeF
KStandardItemListWidget::preferredRatingSize(const KItemListStyleOption
& option
)
1363 const qreal height
= option
.fontMetrics
.ascent();
1364 return QSizeF(height
* 5, height
);
1367 qreal
KStandardItemListWidget::columnPadding(const KItemListStyleOption
& option
)
1369 return option
.padding
* 6;
1372 #include "kstandarditemlistwidget.moc"