src/kitemviews/kstandarditemlistview.cpp

   1 /*
   2  * SPDX-FileCopyrightText: 2012 Peter Penz <peter.penz19@gmail.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-or-later
   5  */
   6
   7 #include "kstandarditemlistview.h"
   8
   9 #include "kstandarditemlistwidget.h"
  10
  11 #include <KIconLoader>
  12
  13 KStandardItemListView::KStandardItemListView(QGraphicsWidget* parent) :
  14     KItemListView(parent),
  15     m_itemLayout(DetailsLayout)
  16 {
  17     setAcceptDrops(true);
  18     setScrollOrientation(Qt::Vertical);
  19     setVisibleRoles({"text"});
  20     setAlternateBackgrounds(true);
  21 }
  22
  23 KStandardItemListView::~KStandardItemListView()
  24 {
  25 }
  26
  27 void KStandardItemListView::setItemLayout(ItemLayout layout)
  28 {
  29     if (m_itemLayout == layout) {
  30         return;
  31     }
  32
  33     beginTransaction();
  34
  35     const ItemLayout previous = m_itemLayout;
  36     m_itemLayout = layout;
  37
  38     // keep the leading padding option unchanged here
  39     setHighlightEntireRow(itemLayoutHighlightEntireRow(layout));
  40     setSupportsItemExpanding(itemLayoutSupportsItemExpanding(layout));
  41     setScrollOrientation(layout == CompactLayout ? Qt::Horizontal : Qt::Vertical);
  42
  43     onItemLayoutChanged(layout, previous);
  44
  45     endTransaction();
  46 }
  47
  48 KStandardItemListView::ItemLayout KStandardItemListView::itemLayout() const
  49 {
  50     return m_itemLayout;
  51 }
  52
  53 KItemListWidgetCreatorBase* KStandardItemListView::defaultWidgetCreator() const
  54 {
  55     return new KItemListWidgetCreator<KStandardItemListWidget>();
  56 }
  57
  58 KItemListGroupHeaderCreatorBase* KStandardItemListView::defaultGroupHeaderCreator() const
  59 {
  60     return new KItemListGroupHeaderCreator<KStandardItemListGroupHeader>();
  61 }
  62
  63 void KStandardItemListView::initializeItemListWidget(KItemListWidget* item)
  64 {
  65     KStandardItemListWidget* standardItemListWidget = qobject_cast<KStandardItemListWidget*>(item);
  66     Q_ASSERT(standardItemListWidget);
  67
  68     switch (itemLayout()) {
  69     case IconsLayout:   standardItemListWidget->setLayout(KStandardItemListWidget::IconsLayout); break;
  70     case CompactLayout: standardItemListWidget->setLayout(KStandardItemListWidget::CompactLayout); break;
  71     case DetailsLayout: standardItemListWidget->setLayout(KStandardItemListWidget::DetailsLayout); break;
  72     default:            Q_ASSERT(false); break;
  73     }
  74
  75     standardItemListWidget->setHighlightEntireRow(highlightEntireRow());
  76     standardItemListWidget->setSupportsItemExpanding(supportsItemExpanding());
  77 }
  78
  79
  80 bool KStandardItemListView::itemSizeHintUpdateRequired(const QSet<QByteArray>& changedRoles) const
  81 {
  82     // The only thing that can modify the item's size hint is the amount of space
  83     // needed to display the text for the visible roles.
  84     // Even if the icons have a different size they are always aligned within
  85     // the area defined by KItemStyleOption.iconSize and hence result in no
  86     // change of the item-size.
  87     const auto roles = visibleRoles();
  88     for (const QByteArray& role : roles) {
  89         if (changedRoles.contains(role)) {
  90             return true;
  91         }
  92     }
  93     return false;
  94 }
  95
  96 bool KStandardItemListView::itemLayoutHighlightEntireRow(ItemLayout layout) const
  97 {
  98     return layout == DetailsLayout;
  99 }
 100
 101 bool KStandardItemListView::itemLayoutSupportsItemExpanding(ItemLayout layout) const
 102 {
 103     return layout == DetailsLayout;
 104 }
 105
 106 void KStandardItemListView::onItemLayoutChanged(ItemLayout current, ItemLayout previous)
 107 {
 108     Q_UNUSED(current)
 109     Q_UNUSED(previous)
 110     updateLayoutOfVisibleItems();
 111 }
 112
 113 void KStandardItemListView::onScrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous)
 114 {
 115     Q_UNUSED(current)
 116     Q_UNUSED(previous)
 117     updateLayoutOfVisibleItems();
 118 }
 119
 120 void KStandardItemListView::onSupportsItemExpandingChanged(bool supportsExpanding)
 121 {
 122     Q_UNUSED(supportsExpanding)
 123     updateLayoutOfVisibleItems();
 124 }
 125
 126
 127 void KStandardItemListView::polishEvent()
 128 {
 129     switch (m_itemLayout) {
 130     case IconsLayout:   applyDefaultStyleOption(style()->pixelMetric(QStyle::PM_LargeIconSize), 2, 4, 8); break;
 131     case CompactLayout: applyDefaultStyleOption(style()->pixelMetric(QStyle::PM_SmallIconSize),  2, 8, 0); break;
 132     case DetailsLayout: applyDefaultStyleOption(style()->pixelMetric(QStyle::PM_SmallIconSize),  2, 0, 0); break;
 133     default:            Q_ASSERT(false); break;
 134     }
 135
 136     QGraphicsWidget::polishEvent();
 137 }
 138
 139 void KStandardItemListView::applyDefaultStyleOption(int iconSize,
 140                                                     int padding,
 141                                                     int horizontalMargin,
 142                                                     int verticalMargin)
 143 {
 144     KItemListStyleOption option = styleOption();
 145
 146     if (option.iconSize < 0) {
 147         option.iconSize = iconSize;
 148     }
 149     if (option.padding < 0) {
 150         option.padding = padding;
 151     }
 152     if (option.horizontalMargin < 0) {
 153         option.horizontalMargin = horizontalMargin;
 154     }
 155     if (option.verticalMargin < 0) {
 156         option.verticalMargin = verticalMargin;
 157     }
 158
 159     setStyleOption(option);
 160 }
 161
 162 void KStandardItemListView::updateLayoutOfVisibleItems()
 163 {
 164     if (model()) {
 165         const auto widgets = visibleItemListWidgets();
 166         for (KItemListWidget* widget : widgets) {
 167             initializeItemListWidget(widget);
 168         }
 169     }
 170 }
 171