]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/kitemviews/kfileitemlistview.cpp
Cleanup and minor fixes for column-handling
[dolphin.git] / src / kitemviews / kfileitemlistview.cpp
index a7217d30c344cf1ab968bccd076109d13ca788a7..a0650b665660a6ccd3a37a67ef45dd2c5ade086b 100644 (file)
 
 #include "kfileitemlistview.h"
 
-#include "kitemlistgroupheader.h"
+#include "kfileitemlistgroupheader.h"
 #include "kfileitemmodelrolesupdater.h"
 #include "kfileitemlistwidget.h"
 #include "kfileitemmodel.h"
+#include "kpixmapmodifier_p.h"
 #include <KLocale>
 #include <KStringHandler>
 
 #include <KDebug>
+#include <KIcon>
 
+#include <QPainter>
 #include <QTextLine>
 #include <QTimer>
 
-#define KFILEITEMLISTVIEW_DEBUG
+// #define KFILEITEMLISTVIEW_DEBUG
 
 namespace {
     const int ShortInterval = 50;
@@ -46,9 +49,11 @@ KFileItemListView::KFileItemListView(QGraphicsWidget* parent) :
     m_updateIconSizeTimer(0),
     m_minimumRolesWidths()
 {
+    setAcceptDrops(true);
+
     setScrollOrientation(Qt::Vertical);
     setWidgetCreator(new KItemListWidgetCreator<KFileItemListWidget>());
-    setGroupHeaderCreator(new KItemListGroupHeaderCreator<KItemListGroupHeader>());
+    setGroupHeaderCreator(new KItemListGroupHeaderCreator<KFileItemListGroupHeader>());
 
     m_updateVisibleIndexRangeTimer = new QTimer(this);
     m_updateVisibleIndexRangeTimer->setSingleShot(true);
@@ -60,13 +65,18 @@ KFileItemListView::KFileItemListView(QGraphicsWidget* parent) :
     m_updateIconSizeTimer->setInterval(ShortInterval);
     connect(m_updateIconSizeTimer, SIGNAL(timeout()), this, SLOT(updateIconSize()));
 
+    setVisibleRoles(QList<QByteArray>() << "name");
+
     updateMinimumRolesWidths();
 }
 
 KFileItemListView::~KFileItemListView()
 {
-    delete widgetCreator();
+    // The group headers are children of the widgets created by
+    // widgetCreator(). So it is mandatory to delete the group headers
+    // first.
     delete groupHeaderCreator();
+    delete widgetCreator();
 
     delete m_modelRolesUpdater;
     m_modelRolesUpdater = 0;
@@ -87,7 +97,14 @@ bool KFileItemListView::previewsShown() const
 void KFileItemListView::setItemLayout(Layout layout)
 {
     if (m_itemLayout != layout) {
+        const bool updateRoles = (m_itemLayout == DetailsLayout || layout == DetailsLayout);
         m_itemLayout = layout;
+        if (updateRoles) {
+            // The details-layout requires some invisible roles that
+            // must be added to the model if the new layout is "details".
+            // If the old layout was "details" the roles will get removed.
+            applyRolesToModel();
+        }
         updateLayoutOfVisibleItems();
     }
 }
@@ -97,6 +114,18 @@ KFileItemListView::Layout KFileItemListView::itemLayout() const
     return m_itemLayout;
 }
 
+void KFileItemListView::setEnabledPlugins(const QStringList& list)
+{
+    if (m_modelRolesUpdater) {
+        m_modelRolesUpdater->setEnabledPlugins(list);
+    }
+}
+
+QStringList KFileItemListView::enabledPlugins() const
+{
+    return m_modelRolesUpdater ? m_modelRolesUpdater->enabledPlugins() : QStringList();
+}
+
 QSizeF KFileItemListView::itemSizeHint(int index) const
 {
     const QHash<QByteArray, QVariant> values = model()->data(index);
@@ -107,7 +136,7 @@ QSizeF KFileItemListView::itemSizeHint(int index) const
     case IconsLayout: {
         const QString text = KStringHandler::preProcessWrap(values["name"].toString());
 
-        const qreal maxWidth = itemSize().width() - 2 * option.margin;
+        const qreal maxWidth = itemSize().width() - 2 * option.padding;
         int textLinesCount = 0;
         QTextLine line;
 
@@ -130,7 +159,7 @@ QSizeF KFileItemListView::itemSizeHint(int index) const
 
         const qreal height = textLinesCount * option.fontMetrics.height() +
                              option.iconSize +
-                             option.margin * 4;
+                             option.padding * 3;
         return QSizeF(itemSize().width(), height);
     }
 
@@ -138,23 +167,21 @@ QSizeF KFileItemListView::itemSizeHint(int index) const
         // For each row exactly one role is shown. Calculate the maximum required width that is necessary
         // to show all roles without horizontal clipping.
         qreal maximumRequiredWidth = 0.0;
-        QHashIterator<QByteArray, int> it(visibleRoles());
-        while (it.hasNext()) {
-            it.next();
-            const QByteArray& role = it.key();
-            const QString text = values[role].toString();
+
+        foreach (const QByteArray& role, visibleRoles()) {
+            const QString text = KFileItemListWidget::roleText(role, values);
             const qreal requiredWidth = option.fontMetrics.width(text);
             maximumRequiredWidth = qMax(maximumRequiredWidth, requiredWidth);
         }
 
-        const qreal width = option.margin * 4 + option.iconSize + maximumRequiredWidth;
-        const qreal height = option.margin * 2 + qMax(option.iconSize, (1 + additionalRolesCount) * option.fontMetrics.height());
+        const qreal width = option.padding * 4 + option.iconSize + maximumRequiredWidth;
+        const qreal height = option.padding * 2 + qMax(option.iconSize, (1 + additionalRolesCount) * option.fontMetrics.height());
         return QSizeF(width, height);
     }
 
     case DetailsLayout: {
         // The width will be determined dynamically by KFileItemListView::visibleRoleSizes()
-        const qreal height = option.margin * 2 + qMax(option.iconSize, option.fontMetrics.height());
+        const qreal height = option.padding * 2 + qMax(option.iconSize, option.fontMetrics.height());
         return QSizeF(-1, height);
     }
 
@@ -166,42 +193,123 @@ QSizeF KFileItemListView::itemSizeHint(int index) const
     return QSize();
 }
 
-QHash<QByteArray, QSizeF> KFileItemListView::visibleRoleSizes() const
+QHash<QByteArray, qreal> KFileItemListView::preferredColumnWidths(const KItemRangeList& itemRanges) const
 {
     QElapsedTimer timer;
     timer.start();
 
-    QHash<QByteArray, QSizeF> sizes;
+    QHash<QByteArray, qreal> widths;
+
+    int calculatedItemCount = 0;
+    bool maxTimeExceeded = false;
+    foreach (const KItemRange& itemRange, itemRanges) {
+        const int startIndex = itemRange.index;
+        const int endIndex = startIndex + itemRange.count - 1;
+
+        for (int i = startIndex; i <= endIndex; ++i) {
+            foreach (const QByteArray& visibleRole, visibleRoles()) {
+                qreal maxWidth = widths.value(visibleRole, 0);
+                const QSizeF itemSize = visibleRoleSizeHint(i, visibleRole);
+                maxWidth = qMax(itemSize.width(), maxWidth);
+                widths.insert(visibleRole, maxWidth);
+            }
+
+            if (calculatedItemCount > 100 && timer.elapsed() > 200) {
+                // When having several thousands of items calculating the sizes can get
+                // very expensive. We accept a possibly too small role-size in favour
+                // of having no blocking user interface.
+                #ifdef KFILEITEMLISTVIEW_DEBUG
+                    kDebug() << "Timer exceeded, stopped after" << calculatedItemCount << "items";
+                #endif
+                maxTimeExceeded = true;
+                break;
+            }
+            ++calculatedItemCount;
+        }
+        if (maxTimeExceeded) {
+            break;
+        }
+    }
+
+#ifdef KFILEITEMLISTVIEW_DEBUG
+    int rangesItemCount = 0;
+    foreach (const KItemRange& itemRange, itemRanges) {
+        rangesItemCount += itemRange.count;
+    }
+    kDebug() << "[TIME] Calculated dynamic item size for " << rangesItemCount << "items:" << timer.elapsed();
+#endif
+    return widths;
+}
+
+QPixmap KFileItemListView::createDragPixmap(const QSet<int>& indexes) const
+{
+    if (!model()) {
+        return QPixmap();
+    }
+
+    const int itemCount = indexes.count();
+    Q_ASSERT(itemCount > 0);
+
+    // If more than one item is dragged, align the items inside a
+    // rectangular grid. The maximum grid size is limited to 5 x 5 items.
+    int xCount;
+    int size;
+    if (itemCount > 16) {
+        xCount = 5;
+        size = KIconLoader::SizeSmall;
+    } else if (itemCount > 9) {
+        xCount = 4;
+        size = KIconLoader::SizeSmallMedium;
+    } else {
+        xCount = 3;
+        size = KIconLoader::SizeMedium;
+    }
+
+    if (itemCount < xCount) {
+        xCount = itemCount;
+    }
 
-    const int itemCount = model()->count();
-    for (int i = 0; i < itemCount; ++i) {
-        QHashIterator<QByteArray, int> it(visibleRoles());
-        while (it.hasNext()) {
-            it.next();
-            const QByteArray& visibleRole = it.key();
+    int yCount = itemCount / xCount;
+    if (itemCount % xCount != 0) {
+        ++yCount;
+    }
+    if (yCount > xCount) {
+        yCount = xCount;
+    }
+
+    // Draw the selected items into the grid cells.
+    QPixmap dragPixmap(xCount * size + xCount, yCount * size + yCount);
+    dragPixmap.fill(Qt::transparent);
+
+    QPainter painter(&dragPixmap);
+    int x = 0;
+    int y = 0;
+    QSetIterator<int> it(indexes);
+    while (it.hasNext()) {
+        const int index = it.next();
+
+        QPixmap pixmap = model()->data(index).value("iconPixmap").value<QPixmap>();
+        if (pixmap.isNull()) {
+            KIcon icon(model()->data(index).value("iconName").toString());
+            pixmap = icon.pixmap(size, size);
+        } else {
+            KPixmapModifier::scale(pixmap, QSize(size, size));
+        }
 
-            QSizeF maxSize = sizes.value(visibleRole, QSizeF(0, 0));
+        painter.drawPixmap(x, y, pixmap);
 
-            const QSizeF itemSize = visibleRoleSizeHint(i, visibleRole);
-            maxSize = maxSize.expandedTo(itemSize);
-            sizes.insert(visibleRole, maxSize);
+        x += size + 1;
+        if (x >= dragPixmap.width()) {
+            x = 0;
+            y += size + 1;
         }
 
-        if (i > 100 && timer.elapsed() > 200) {
-            // When having several thousands of items calculating the sizes can get
-            // very expensive. We accept a possibly too small role-size in favour
-            // of having no blocking user interface.
-            #ifdef KFILEITEMLISTVIEW_DEBUG
-                kDebug() << "Timer exceeded, stopped after" << i << "items";
-            #endif
+        if (y >= dragPixmap.height()) {
             break;
         }
     }
 
-#ifdef KFILEITEMLISTVIEW_DEBUG
-    kDebug() << "[TIME] Calculated dynamic item size for " << itemCount << "items:" << timer.elapsed();
-#endif
-    return sizes;
+    return dragPixmap;
 }
 
 void KFileItemListView::initializeItemListWidget(KItemListWidget* item)
@@ -214,6 +322,23 @@ void KFileItemListView::initializeItemListWidget(KItemListWidget* item)
     case DetailsLayout: fileItemListWidget->setLayout(KFileItemListWidget::DetailsLayout); break;
     default:            Q_ASSERT(false); break;
     }
+
+    fileItemListWidget->setSupportsItemExpanding(supportsItemExpanding());
+}
+
+bool KFileItemListView::itemSizeHintUpdateRequired(const QSet<QByteArray>& changedRoles) const
+{
+    // Even if the icons have a different size they are always aligned within
+    // the area defined by KItemStyleOption.iconSize and hence result in no
+    // change of the item-size.
+    const bool containsIconName = changedRoles.contains("iconName");
+    const bool containsIconPixmap = changedRoles.contains("iconPixmap");
+    const int count = changedRoles.count();
+
+    const bool iconChanged = (containsIconName && containsIconPixmap && count == 2) ||
+                             (containsIconName && count == 1) ||
+                             (containsIconPixmap && count == 1);
+    return !iconChanged;
 }
 
 void KFileItemListView::onModelChanged(KItemModelBase* current, KItemModelBase* previous)
@@ -221,13 +346,11 @@ void KFileItemListView::onModelChanged(KItemModelBase* current, KItemModelBase*
     Q_UNUSED(previous);
     Q_ASSERT(qobject_cast<KFileItemModel*>(current));
 
-    if (m_modelRolesUpdater) {
-        delete m_modelRolesUpdater;
-    }
-
+    delete m_modelRolesUpdater;
     m_modelRolesUpdater = new KFileItemModelRolesUpdater(static_cast<KFileItemModel*>(current), this);
-    const int size = styleOption().iconSize;
-    m_modelRolesUpdater->setIconSize(QSize(size, size));
+    m_modelRolesUpdater->setIconSize(availableIconSize());
+
+    applyRolesToModel();
 }
 
 void KFileItemListView::onScrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous)
@@ -244,36 +367,18 @@ void KFileItemListView::onItemSizeChanged(const QSizeF& current, const QSizeF& p
     triggerVisibleIndexRangeUpdate();
 }
 
-void KFileItemListView::onOffsetChanged(qreal current, qreal previous)
+void KFileItemListView::onScrollOffsetChanged(qreal current, qreal previous)
 {
     Q_UNUSED(current);
     Q_UNUSED(previous);
     triggerVisibleIndexRangeUpdate();
 }
 
-void KFileItemListView::onVisibleRolesChanged(const QHash<QByteArray, int>& current, const QHash<QByteArray, int>& previous)
+void KFileItemListView::onVisibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous)
 {
+    Q_UNUSED(current);
     Q_UNUSED(previous);
-
-    Q_ASSERT(qobject_cast<KFileItemModel*>(model()));
-    KFileItemModel* fileItemModel = static_cast<KFileItemModel*>(model());
-
-    // KFileItemModel does not distinct between "visible" and "invisible" roles.
-    // Add all roles that are mandatory for having a working KFileItemListView:
-    QSet<QByteArray> keys = current.keys().toSet();
-    QSet<QByteArray> roles = keys;
-    roles.insert("iconPixmap");
-    roles.insert("iconName");
-    roles.insert("name"); // TODO: just don't allow to disable it
-    roles.insert("isDir");
-    if (m_itemLayout == DetailsLayout) {
-        roles.insert("isExpanded");
-        roles.insert("expansionLevel");
-    }
-
-    fileItemModel->setRoles(roles);
-
-    m_modelRolesUpdater->setRoles(keys);
+    applyRolesToModel();
 }
 
 void KFileItemListView::onStyleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous)
@@ -283,6 +388,13 @@ void KFileItemListView::onStyleOptionChanged(const KItemListStyleOption& current
     triggerIconSizeUpdate();
 }
 
+void KFileItemListView::onSupportsItemExpandingChanged(bool supportsExpanding)
+{
+    Q_UNUSED(supportsExpanding);
+    applyRolesToModel();
+    updateLayoutOfVisibleItems();
+}
+
 void KFileItemListView::onTransactionBegin()
 {
     m_modelRolesUpdater->setPaused(true);
@@ -312,8 +424,21 @@ void KFileItemListView::slotItemsRemoved(const KItemRangeList& itemRanges)
     updateTimersInterval();
 }
 
+void KFileItemListView::slotSortRoleChanged(const QByteArray& current, const QByteArray& previous)
+{
+    const QByteArray sortRole = model()->sortRole();
+    if (!visibleRoles().contains(sortRole)) {
+        applyRolesToModel();
+    }
+
+    KItemListView::slotSortRoleChanged(current, previous);
+}
+
 void KFileItemListView::triggerVisibleIndexRangeUpdate()
 {
+    if (!model()) {
+        return;
+    }
     m_modelRolesUpdater->setPaused(true);
     m_updateVisibleIndexRangeTimer->start();
 }
@@ -333,8 +458,7 @@ void KFileItemListView::updateVisibleIndexRange()
         // of the icon-size before unpausing m_modelRolesUpdater. This prevents
         // an unnecessary expensive recreation of all previews afterwards.
         m_updateIconSizeTimer->stop();
-        const KItemListStyleOption& option = styleOption();
-        m_modelRolesUpdater->setIconSize(QSize(option.iconSize, option.iconSize));
+        m_modelRolesUpdater->setIconSize(availableIconSize());
     }
 
     m_modelRolesUpdater->setPaused(isTransactionActive());
@@ -343,6 +467,9 @@ void KFileItemListView::updateVisibleIndexRange()
 
 void KFileItemListView::triggerIconSizeUpdate()
 {
+    if (!model()) {
+        return;
+    }
     m_modelRolesUpdater->setPaused(true);
     m_updateIconSizeTimer->start();
 }
@@ -353,8 +480,7 @@ void KFileItemListView::updateIconSize()
         return;
     }
 
-    const KItemListStyleOption& option = styleOption();
-    m_modelRolesUpdater->setIconSize(QSize(option.iconSize, option.iconSize));
+    m_modelRolesUpdater->setIconSize(availableIconSize());
 
     if (m_updateVisibleIndexRangeTimer->isActive()) {
         // If the visibility-index-range update is pending do an immediate update
@@ -375,12 +501,22 @@ QSizeF KFileItemListView::visibleRoleSizeHint(int index, const QByteArray& role)
     const KItemListStyleOption& option = styleOption();
 
     qreal width = m_minimumRolesWidths.value(role, 0);
-    const qreal height = option.margin * 2 + option.fontMetrics.height();
+    const qreal height = option.padding * 2 + option.fontMetrics.height();
 
-    const QVariant value = model()->data(index).value(role);
-    const QString text = value.toString();
+    const QHash<QByteArray, QVariant> values = model()->data(index);
+    const QString text = KFileItemListWidget::roleText(role, values);
     if (!text.isEmpty()) {
-        width = qMax(width, qreal(option.margin * 2 + option.fontMetrics.width(text)));
+        const qreal columnPadding = option.padding * 3;
+        width = qMax(width, qreal(2 * columnPadding + option.fontMetrics.width(text)));
+    }
+
+    if (role == "name") {
+        // Increase the width by the expansion-toggle and the current expansion level
+        const int expandedParentsCount = values.value("expandedParentsCount", 0).toInt();
+        width += option.padding + (expandedParentsCount + 1) * itemSize().height() + KIconLoader::SizeSmall;
+
+        // Increase the width by the required space for the icon
+        width += option.padding * 2 + option.iconSize;
     }
 
     return QSizeF(width, height);
@@ -388,6 +524,10 @@ QSizeF KFileItemListView::visibleRoleSizeHint(int index, const QByteArray& role)
 
 void KFileItemListView::updateLayoutOfVisibleItems()
 {
+    if (!model()) {
+        return;
+    }
+
     foreach (KItemListWidget* widget, visibleItemListWidgets()) {
         initializeItemListWidget(widget);
     }
@@ -420,4 +560,45 @@ void KFileItemListView::updateMinimumRolesWidths()
     m_minimumRolesWidths.insert("size", option.fontMetrics.width(sizeText));
 }
 
+void KFileItemListView::applyRolesToModel()
+{
+    if (!model()) {
+        return;
+    }
+
+    Q_ASSERT(qobject_cast<KFileItemModel*>(model()));
+    KFileItemModel* fileItemModel = static_cast<KFileItemModel*>(model());
+
+    // KFileItemModel does not distinct between "visible" and "invisible" roles.
+    // Add all roles that are mandatory for having a working KFileItemListView:
+    QSet<QByteArray> roles = visibleRoles().toSet();
+    roles.insert("iconPixmap");
+    roles.insert("iconName");
+    roles.insert("name");
+    roles.insert("isDir");
+    if (supportsItemExpanding()) {
+        roles.insert("isExpanded");
+        roles.insert("isExpandable");
+        roles.insert("expandedParentsCount");
+    }
+
+    // Assure that the role that is used for sorting will be determined
+    roles.insert(fileItemModel->sortRole());
+
+    fileItemModel->setRoles(roles);
+    m_modelRolesUpdater->setRoles(roles);
+}
+
+QSize KFileItemListView::availableIconSize() const
+{
+    const KItemListStyleOption& option = styleOption();
+    const int iconSize = option.iconSize;
+    if (m_itemLayout == IconsLayout) {
+        const int maxIconWidth = itemSize().width() - 2 * option.padding;
+        return QSize(maxIconWidth, iconSize);
+    }
+
+    return QSize(iconSize, iconSize);
+}
+
 #include "kfileitemlistview.moc"