src/kitemviews/kfileitemlistview.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2011 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 "kfileitemlistview.h"
  21
  22 #include "kfileitemlistgroupheader.h"
  23 #include "kfileitemmodelrolesupdater.h"
  24 #include "kfileitemlistwidget.h"
  25 #include "kfileitemmodel.h"
  26 #include "kpixmapmodifier_p.h"
  27 #include <KLocale>
  28 #include <KStringHandler>
  29
  30 #include <KDebug>
  31 #include <KIcon>
  32
  33 #include <QPainter>
  34 #include <QTextLine>
  35 #include <QTimer>
  36
  37 // #define KFILEITEMLISTVIEW_DEBUG
  38
  39 namespace {
  40     const int ShortInterval = 50;
  41     const int LongInterval = 300;
  42 }
  43
  44 KFileItemListView::KFileItemListView(QGraphicsWidget* parent) :
  45     KItemListView(parent),
  46     m_itemLayout(IconsLayout),
  47     m_modelRolesUpdater(0),
  48     m_updateVisibleIndexRangeTimer(0),
  49     m_updateIconSizeTimer(0),
  50     m_minimumRolesWidths()
  51 {
  52     setAcceptDrops(true);
  53
  54     setScrollOrientation(Qt::Vertical);
  55     setWidgetCreator(new KItemListWidgetCreator<KFileItemListWidget>());
  56     setGroupHeaderCreator(new KItemListGroupHeaderCreator<KFileItemListGroupHeader>());
  57
  58     m_updateVisibleIndexRangeTimer = new QTimer(this);
  59     m_updateVisibleIndexRangeTimer->setSingleShot(true);
  60     m_updateVisibleIndexRangeTimer->setInterval(ShortInterval);
  61     connect(m_updateVisibleIndexRangeTimer, SIGNAL(timeout()), this, SLOT(updateVisibleIndexRange()));
  62
  63     m_updateIconSizeTimer = new QTimer(this);
  64     m_updateIconSizeTimer->setSingleShot(true);
  65     m_updateIconSizeTimer->setInterval(ShortInterval);
  66     connect(m_updateIconSizeTimer, SIGNAL(timeout()), this, SLOT(updateIconSize()));
  67
  68     setVisibleRoles(QList<QByteArray>() << "name");
  69
  70     updateMinimumRolesWidths();
  71 }
  72
  73 KFileItemListView::~KFileItemListView()
  74 {
  75     // The group headers are children of the widgets created by
  76     // widgetCreator(). So it is mandatory to delete the group headers
  77     // first.
  78     delete groupHeaderCreator();
  79     delete widgetCreator();
  80
  81     delete m_modelRolesUpdater;
  82     m_modelRolesUpdater = 0;
  83 }
  84
  85 void KFileItemListView::setPreviewsShown(bool show)
  86 {
  87     if (m_modelRolesUpdater) {
  88         m_modelRolesUpdater->setPreviewShown(show);
  89     }
  90 }
  91
  92 bool KFileItemListView::previewsShown() const
  93 {
  94     return m_modelRolesUpdater->isPreviewShown();
  95 }
  96
  97 void KFileItemListView::setItemLayout(Layout layout)
  98 {
  99     if (m_itemLayout != layout) {
 100         const bool updateRoles = (m_itemLayout == DetailsLayout || layout == DetailsLayout);
 101         m_itemLayout = layout;
 102         if (updateRoles) {
 103             // The details-layout requires some invisible roles that
 104             // must be added to the model if the new layout is "details".
 105             // If the old layout was "details" the roles will get removed.
 106             applyRolesToModel();
 107         }
 108         updateLayoutOfVisibleItems();
 109
 110         setSupportsItemExpanding(m_itemLayout == DetailsLayout);
 111     }
 112 }
 113
 114 KFileItemListView::Layout KFileItemListView::itemLayout() const
 115 {
 116     return m_itemLayout;
 117 }
 118
 119 void KFileItemListView::setEnabledPlugins(const QStringList& list)
 120 {
 121     if (m_modelRolesUpdater) {
 122         m_modelRolesUpdater->setEnabledPlugins(list);
 123     }
 124 }
 125
 126 QStringList KFileItemListView::enabledPlugins() const
 127 {
 128     return m_modelRolesUpdater ? m_modelRolesUpdater->enabledPlugins() : QStringList();
 129 }
 130
 131 QSizeF KFileItemListView::itemSizeHint(int index) const
 132 {
 133     const QHash<QByteArray, QVariant> values = model()->data(index);
 134     const KItemListStyleOption& option = styleOption();
 135     const int additionalRolesCount = qMax(visibleRoles().count() - 1, 0);
 136
 137     switch (m_itemLayout) {
 138     case IconsLayout: {
 139         const QString text = KStringHandler::preProcessWrap(values["name"].toString());
 140
 141         const qreal maxWidth = itemSize().width() - 2 * option.padding;
 142         int textLinesCount = 0;
 143         QTextLine line;
 144
 145         // Calculate the number of lines required for wrapping the name
 146         QTextOption textOption(Qt::AlignHCenter);
 147         textOption.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere);
 148
 149         QTextLayout layout(text, option.font);
 150         layout.setTextOption(textOption);
 151         layout.beginLayout();
 152         while ((line = layout.createLine()).isValid()) {
 153             line.setLineWidth(maxWidth);
 154             line.naturalTextWidth();
 155             ++textLinesCount;
 156         }
 157         layout.endLayout();
 158
 159         // Add one line for each additional information
 160         textLinesCount += additionalRolesCount;
 161
 162         const qreal height = textLinesCount * option.fontMetrics.height() +
 163                              option.iconSize +
 164                              option.padding * 3;
 165         return QSizeF(itemSize().width(), height);
 166     }
 167
 168     case CompactLayout: {
 169         // For each row exactly one role is shown. Calculate the maximum required width that is necessary
 170         // to show all roles without horizontal clipping.
 171         qreal maximumRequiredWidth = 0.0;
 172
 173         foreach (const QByteArray& role, visibleRoles()) {
 174             const QString text = KFileItemListWidget::roleText(role, values);
 175             const qreal requiredWidth = option.fontMetrics.width(text);
 176             maximumRequiredWidth = qMax(maximumRequiredWidth, requiredWidth);
 177         }
 178
 179         const qreal width = option.padding * 4 + option.iconSize + maximumRequiredWidth;
 180         const qreal height = option.padding * 2 + qMax(option.iconSize, (1 + additionalRolesCount) * option.fontMetrics.height());
 181         return QSizeF(width, height);
 182     }
 183
 184     case DetailsLayout: {
 185         // The width will be determined dynamically by KFileItemListView::visibleRoleSizes()
 186         const qreal height = option.padding * 2 + qMax(option.iconSize, option.fontMetrics.height());
 187         return QSizeF(-1, height);
 188     }
 189
 190     default:
 191         Q_ASSERT(false);
 192         break;
 193     }
 194
 195     return QSize();
 196 }
 197
 198 QHash<QByteArray, QSizeF> KFileItemListView::visibleRolesSizes(const KItemRangeList& itemRanges) const
 199 {
 200     QElapsedTimer timer;
 201     timer.start();
 202
 203     QHash<QByteArray, QSizeF> sizes;
 204
 205     int calculatedItemCount = 0;
 206     bool maxTimeExceeded = false;
 207     foreach (const KItemRange& itemRange, itemRanges) {
 208         const int startIndex = itemRange.index;
 209         const int endIndex = startIndex + itemRange.count - 1;
 210
 211         for (int i = startIndex; i <= endIndex; ++i) {
 212             foreach (const QByteArray& visibleRole, visibleRoles()) {
 213                 QSizeF maxSize = sizes.value(visibleRole, QSizeF(0, 0));
 214                 const QSizeF itemSize = visibleRoleSizeHint(i, visibleRole);
 215                 maxSize = maxSize.expandedTo(itemSize);
 216                 sizes.insert(visibleRole, maxSize);
 217             }
 218
 219             if (calculatedItemCount > 100 && timer.elapsed() > 200) {
 220                 // When having several thousands of items calculating the sizes can get
 221                 // very expensive. We accept a possibly too small role-size in favour
 222                 // of having no blocking user interface.
 223                 #ifdef KFILEITEMLISTVIEW_DEBUG
 224                     kDebug() << "Timer exceeded, stopped after" << calculatedItemCount << "items";
 225                 #endif
 226                 maxTimeExceeded = true;
 227                 break;
 228             }
 229             ++calculatedItemCount;
 230         }
 231         if (maxTimeExceeded) {
 232             break;
 233         }
 234     }
 235
 236 #ifdef KFILEITEMLISTVIEW_DEBUG
 237     int rangesItemCount = 0;
 238     foreach (const KItemRange& itemRange, itemRanges) {
 239         rangesItemCount += itemRange.count;
 240     }
 241     kDebug() << "[TIME] Calculated dynamic item size for " << rangesItemCount << "items:" << timer.elapsed();
 242 #endif
 243     return sizes;
 244 }
 245
 246 QPixmap KFileItemListView::createDragPixmap(const QSet<int>& indexes) const
 247 {
 248     if (!model()) {
 249         return QPixmap();
 250     }
 251
 252     const int itemCount = indexes.count();
 253     Q_ASSERT(itemCount > 0);
 254
 255     // If more than one item is dragged, align the items inside a
 256     // rectangular grid. The maximum grid size is limited to 5 x 5 items.
 257     int xCount;
 258     int size;
 259     if (itemCount > 16) {
 260         xCount = 5;
 261         size = KIconLoader::SizeSmall;
 262     } else if (itemCount > 9) {
 263         xCount = 4;
 264         size = KIconLoader::SizeSmallMedium;
 265     } else {
 266         xCount = 3;
 267         size = KIconLoader::SizeMedium;
 268     }
 269
 270     if (itemCount < xCount) {
 271         xCount = itemCount;
 272     }
 273
 274     int yCount = itemCount / xCount;
 275     if (itemCount % xCount != 0) {
 276         ++yCount;
 277     }
 278     if (yCount > xCount) {
 279         yCount = xCount;
 280     }
 281
 282     // Draw the selected items into the grid cells.
 283     QPixmap dragPixmap(xCount * size + xCount, yCount * size + yCount);
 284     dragPixmap.fill(Qt::transparent);
 285
 286     QPainter painter(&dragPixmap);
 287     int x = 0;
 288     int y = 0;
 289     QSetIterator<int> it(indexes);
 290     while (it.hasNext()) {
 291         const int index = it.next();
 292
 293         QPixmap pixmap = model()->data(index).value("iconPixmap").value<QPixmap>();
 294         if (pixmap.isNull()) {
 295             KIcon icon(model()->data(index).value("iconName").toString());
 296             pixmap = icon.pixmap(size, size);
 297         } else {
 298             KPixmapModifier::scale(pixmap, QSize(size, size));
 299         }
 300
 301         painter.drawPixmap(x, y, pixmap);
 302
 303         x += size + 1;
 304         if (x >= dragPixmap.width()) {
 305             x = 0;
 306             y += size + 1;
 307         }
 308
 309         if (y >= dragPixmap.height()) {
 310             break;
 311         }
 312     }
 313
 314     return dragPixmap;
 315 }
 316
 317 void KFileItemListView::initializeItemListWidget(KItemListWidget* item)
 318 {
 319     KFileItemListWidget* fileItemListWidget = static_cast<KFileItemListWidget*>(item);
 320
 321     switch (m_itemLayout) {
 322     case IconsLayout:   fileItemListWidget->setLayout(KFileItemListWidget::IconsLayout); break;
 323     case CompactLayout: fileItemListWidget->setLayout(KFileItemListWidget::CompactLayout); break;
 324     case DetailsLayout: fileItemListWidget->setLayout(KFileItemListWidget::DetailsLayout); break;
 325     default:            Q_ASSERT(false); break;
 326     }
 327 }
 328
 329 bool KFileItemListView::itemSizeHintUpdateRequired(const QSet<QByteArray>& changedRoles) const
 330 {
 331     // Even if the icons have a different size they are always aligned within
 332     // the area defined by KItemStyleOption.iconSize and hence result in no
 333     // change of the item-size.
 334     const bool containsIconName = changedRoles.contains("iconName");
 335     const bool containsIconPixmap = changedRoles.contains("iconPixmap");
 336     const int count = changedRoles.count();
 337
 338     const bool iconChanged = (containsIconName && containsIconPixmap && count == 2) ||
 339                              (containsIconName && count == 1) ||
 340                              (containsIconPixmap && count == 1);
 341     return !iconChanged;
 342 }
 343
 344 void KFileItemListView::onModelChanged(KItemModelBase* current, KItemModelBase* previous)
 345 {
 346     Q_UNUSED(previous);
 347     Q_ASSERT(qobject_cast<KFileItemModel*>(current));
 348
 349     delete m_modelRolesUpdater;
 350     m_modelRolesUpdater = new KFileItemModelRolesUpdater(static_cast<KFileItemModel*>(current), this);
 351     m_modelRolesUpdater->setIconSize(availableIconSize());
 352
 353     applyRolesToModel();
 354 }
 355
 356 void KFileItemListView::onScrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous)
 357 {
 358     Q_UNUSED(current);
 359     Q_UNUSED(previous);
 360     updateLayoutOfVisibleItems();
 361 }
 362
 363 void KFileItemListView::onItemSizeChanged(const QSizeF& current, const QSizeF& previous)
 364 {
 365     Q_UNUSED(current);
 366     Q_UNUSED(previous);
 367     triggerVisibleIndexRangeUpdate();
 368 }
 369
 370 void KFileItemListView::onScrollOffsetChanged(qreal current, qreal previous)
 371 {
 372     Q_UNUSED(current);
 373     Q_UNUSED(previous);
 374     triggerVisibleIndexRangeUpdate();
 375 }
 376
 377 void KFileItemListView::onVisibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous)
 378 {
 379     Q_UNUSED(current);
 380     Q_UNUSED(previous);
 381     applyRolesToModel();
 382 }
 383
 384 void KFileItemListView::onStyleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous)
 385 {
 386     Q_UNUSED(current);
 387     Q_UNUSED(previous);
 388     triggerIconSizeUpdate();
 389 }
 390
 391 void KFileItemListView::onTransactionBegin()
 392 {
 393     m_modelRolesUpdater->setPaused(true);
 394 }
 395
 396 void KFileItemListView::onTransactionEnd()
 397 {
 398     // Only unpause the model-roles-updater if no timer is active. If one
 399     // timer is still active the model-roles-updater will be unpaused later as
 400     // soon as the timer has been exceeded.
 401     const bool timerActive = m_updateVisibleIndexRangeTimer->isActive() ||
 402                              m_updateIconSizeTimer->isActive();
 403     if (!timerActive) {
 404         m_modelRolesUpdater->setPaused(false);
 405     }
 406 }
 407
 408 void KFileItemListView::resizeEvent(QGraphicsSceneResizeEvent* event)
 409 {
 410     KItemListView::resizeEvent(event);
 411     triggerVisibleIndexRangeUpdate();
 412 }
 413
 414 void KFileItemListView::slotItemsRemoved(const KItemRangeList& itemRanges)
 415 {
 416     KItemListView::slotItemsRemoved(itemRanges);
 417     updateTimersInterval();
 418 }
 419
 420 void KFileItemListView::slotSortRoleChanged(const QByteArray& current, const QByteArray& previous)
 421 {
 422     const QByteArray sortRole = model()->sortRole();
 423     if (!visibleRoles().contains(sortRole)) {
 424         applyRolesToModel();
 425     }
 426
 427     KItemListView::slotSortRoleChanged(current, previous);
 428 }
 429
 430 void KFileItemListView::triggerVisibleIndexRangeUpdate()
 431 {
 432     if (!model()) {
 433         return;
 434     }
 435     m_modelRolesUpdater->setPaused(true);
 436     m_updateVisibleIndexRangeTimer->start();
 437 }
 438
 439 void KFileItemListView::updateVisibleIndexRange()
 440 {
 441     if (!m_modelRolesUpdater) {
 442         return;
 443     }
 444
 445     const int index = firstVisibleIndex();
 446     const int count = lastVisibleIndex() - index + 1;
 447     m_modelRolesUpdater->setVisibleIndexRange(index, count);
 448
 449     if (m_updateIconSizeTimer->isActive()) {
 450         // If the icon-size update is pending do an immediate update
 451         // of the icon-size before unpausing m_modelRolesUpdater. This prevents
 452         // an unnecessary expensive recreation of all previews afterwards.
 453         m_updateIconSizeTimer->stop();
 454         m_modelRolesUpdater->setIconSize(availableIconSize());
 455     }
 456
 457     m_modelRolesUpdater->setPaused(isTransactionActive());
 458     updateTimersInterval();
 459 }
 460
 461 void KFileItemListView::triggerIconSizeUpdate()
 462 {
 463     if (!model()) {
 464         return;
 465     }
 466     m_modelRolesUpdater->setPaused(true);
 467     m_updateIconSizeTimer->start();
 468 }
 469
 470 void KFileItemListView::updateIconSize()
 471 {
 472     if (!m_modelRolesUpdater) {
 473         return;
 474     }
 475
 476     m_modelRolesUpdater->setIconSize(availableIconSize());
 477
 478     if (m_updateVisibleIndexRangeTimer->isActive()) {
 479         // If the visibility-index-range update is pending do an immediate update
 480         // of the range before unpausing m_modelRolesUpdater. This prevents
 481         // an unnecessary expensive recreation of all previews afterwards.
 482         m_updateVisibleIndexRangeTimer->stop();
 483         const int index = firstVisibleIndex();
 484         const int count = lastVisibleIndex() - index + 1;
 485         m_modelRolesUpdater->setVisibleIndexRange(index, count);
 486     }
 487
 488     m_modelRolesUpdater->setPaused(isTransactionActive());
 489     updateTimersInterval();
 490 }
 491
 492 QSizeF KFileItemListView::visibleRoleSizeHint(int index, const QByteArray& role) const
 493 {
 494     const KItemListStyleOption& option = styleOption();
 495
 496     qreal width = m_minimumRolesWidths.value(role, 0);
 497     const qreal height = option.padding * 2 + option.fontMetrics.height();
 498
 499     const QHash<QByteArray, QVariant> values = model()->data(index);
 500     const QString text = KFileItemListWidget::roleText(role, values);
 501     if (!text.isEmpty()) {
 502         const qreal columnPadding = option.padding * 3;
 503         width = qMax(width, qreal(2 * columnPadding + option.fontMetrics.width(text)));
 504     }
 505
 506     if (role == "name") {
 507         // Increase the width by the expansion-toggle and the current expansion level
 508         const int expandedParentsCount = values.value("expandedParentsCount", 0).toInt();
 509         width += option.padding + expandedParentsCount * itemSize().height() + KIconLoader::SizeSmall;
 510
 511         // Increase the width by the required space for the icon
 512         width += option.padding * 2 + option.iconSize;
 513     }
 514
 515     return QSizeF(width, height);
 516 }
 517
 518 void KFileItemListView::updateLayoutOfVisibleItems()
 519 {
 520     if (!model()) {
 521         return;
 522     }
 523
 524     foreach (KItemListWidget* widget, visibleItemListWidgets()) {
 525         initializeItemListWidget(widget);
 526     }
 527     triggerVisibleIndexRangeUpdate();
 528 }
 529
 530 void KFileItemListView::updateTimersInterval()
 531 {
 532     if (!model()) {
 533         return;
 534     }
 535
 536     // The ShortInterval is used for cases like switching the directory: If the
 537     // model is empty and filled later the creation of the previews should be done
 538     // as soon as possible. The LongInterval is used when the model already contains
 539     // items and assures that operations like zooming don't result in too many temporary
 540     // recreations of the previews.
 541
 542     const int interval = (model()->count() <= 0) ? ShortInterval : LongInterval;
 543     m_updateVisibleIndexRangeTimer->setInterval(interval);
 544     m_updateIconSizeTimer->setInterval(interval);
 545 }
 546
 547 void KFileItemListView::updateMinimumRolesWidths()
 548 {
 549     m_minimumRolesWidths.clear();
 550
 551     const KItemListStyleOption& option = styleOption();
 552     const QString sizeText = QLatin1String("888888") + i18nc("@item:intable", "items");
 553     m_minimumRolesWidths.insert("size", option.fontMetrics.width(sizeText));
 554 }
 555
 556 void KFileItemListView::applyRolesToModel()
 557 {
 558     if (!model()) {
 559         return;
 560     }
 561
 562     Q_ASSERT(qobject_cast<KFileItemModel*>(model()));
 563     KFileItemModel* fileItemModel = static_cast<KFileItemModel*>(model());
 564
 565     // KFileItemModel does not distinct between "visible" and "invisible" roles.
 566     // Add all roles that are mandatory for having a working KFileItemListView:
 567     QSet<QByteArray> roles = visibleRoles().toSet();
 568     roles.insert("iconPixmap");
 569     roles.insert("iconName");
 570     roles.insert("name");
 571     roles.insert("isDir");
 572     if (m_itemLayout == DetailsLayout) {
 573         roles.insert("isExpanded");
 574         roles.insert("isExpandable");
 575         roles.insert("expandedParentsCount");
 576     }
 577
 578     // Assure that the role that is used for sorting will be determined
 579     roles.insert(fileItemModel->sortRole());
 580
 581     fileItemModel->setRoles(roles);
 582     m_modelRolesUpdater->setRoles(roles);
 583 }
 584
 585 QSize KFileItemListView::availableIconSize() const
 586 {
 587     const KItemListStyleOption& option = styleOption();
 588     const int iconSize = option.iconSize;
 589     if (m_itemLayout == IconsLayout) {
 590         const int maxIconWidth = itemSize().width() - 2 * option.padding;
 591         return QSize(maxIconWidth, iconSize);
 592     }
 593
 594     return QSize(iconSize, iconSize);
 595 }
 596
 597 #include "kfileitemlistview.moc"