src/kitemviews/kitemlistview.cpp

   1 /*
   2  * SPDX-FileCopyrightText: 2011 Peter Penz <peter.penz19@gmail.com>
   3  *
   4  * Based on the Itemviews NG project from Trolltech Labs
   5  *
   6  * SPDX-License-Identifier: GPL-2.0-or-later
   7  */
   8
   9 #include "kitemlistview.h"
  10
  11 #include "dolphindebug.h"
  12 #include "kitemlistcontainer.h"
  13 #include "kitemlistcontroller.h"
  14 #include "kitemlistheader.h"
  15 #include "kitemlistselectionmanager.h"
  16 #include "kitemlistviewaccessible.h"
  17 #include "kstandarditemlistwidget.h"
  18
  19 #include "private/kitemlistheaderwidget.h"
  20 #include "private/kitemlistrubberband.h"
  21 #include "private/kitemlistsizehintresolver.h"
  22 #include "private/kitemlistviewlayouter.h"
  23
  24 #include <QElapsedTimer>
  25 #include <QGraphicsSceneMouseEvent>
  26 #include <QGraphicsView>
  27 #include <QPropertyAnimation>
  28 #include <QStyleOptionRubberBand>
  29 #include <QTimer>
  30 #include <QVariantAnimation>
  31
  32 namespace
  33 {
  34 // Time in ms until reaching the autoscroll margin triggers
  35 // an initial autoscrolling
  36 const int InitialAutoScrollDelay = 700;
  37
  38 // Delay in ms for triggering the next autoscroll
  39 const int RepeatingAutoScrollDelay = 1000 / 60;
  40
  41 // Copied from the Kirigami.Units.shortDuration
  42 const int RubberFadeSpeed = 150;
  43
  44 const char *RubberPropertyName = "_kitemviews_rubberBandPosition";
  45 }
  46
  47 #ifndef QT_NO_ACCESSIBILITY
  48 QAccessibleInterface *accessibleInterfaceFactory(const QString &key, QObject *object)
  49 {
  50     Q_UNUSED(key)
  51
  52     if (KItemListContainer *container = qobject_cast<KItemListContainer *>(object)) {
  53         return new KItemListContainerAccessible(container);
  54     } else if (KItemListView *view = qobject_cast<KItemListView *>(object)) {
  55         return new KItemListViewAccessible(view);
  56     }
  57
  58     return nullptr;
  59 }
  60 #endif
  61
  62 KItemListView::KItemListView(QGraphicsWidget *parent)
  63     : QGraphicsWidget(parent)
  64     , m_enabledSelectionToggles(false)
  65     , m_grouped(false)
  66     , m_highlightEntireRow(false)
  67     , m_alternateBackgrounds(false)
  68     , m_supportsItemExpanding(false)
  69     , m_editingRole(false)
  70     , m_activeTransactions(0)
  71     , m_endTransactionAnimationHint(Animation)
  72     , m_itemSize()
  73     , m_controller(nullptr)
  74     , m_model(nullptr)
  75     , m_visibleRoles()
  76     , m_widgetCreator(nullptr)
  77     , m_groupHeaderCreator(nullptr)
  78     , m_styleOption()
  79     , m_visibleItems()
  80     , m_visibleGroups()
  81     , m_visibleCells()
  82     , m_scrollBarExtent(0)
  83     , m_layouter(nullptr)
  84     , m_animation(nullptr)
  85     , m_oldScrollOffset(0)
  86     , m_oldMaximumScrollOffset(0)
  87     , m_oldItemOffset(0)
  88     , m_oldMaximumItemOffset(0)
  89     , m_skipAutoScrollForRubberBand(false)
  90     , m_rubberBand(nullptr)
  91     , m_tapAndHoldIndicator(nullptr)
  92     , m_mousePos()
  93     , m_autoScrollIncrement(0)
  94     , m_autoScrollTimer(nullptr)
  95     , m_header(nullptr)
  96     , m_headerWidget(nullptr)
  97     , m_indicatorAnimation(nullptr)
  98     , m_dropIndicator()
  99     , m_sizeHintResolver(nullptr)
 100 {
 101     setAcceptHoverEvents(true);
 102     setAcceptTouchEvents(true);
 103
 104     m_sizeHintResolver = new KItemListSizeHintResolver(this);
 105
 106     m_layouter = new KItemListViewLayouter(m_sizeHintResolver, this);
 107
 108     m_animation = new KItemListViewAnimation(this);
 109     connect(m_animation, &KItemListViewAnimation::finished, this, &KItemListView::slotAnimationFinished);
 110
 111     m_rubberBand = new KItemListRubberBand(this);
 112     connect(m_rubberBand, &KItemListRubberBand::activationChanged, this, &KItemListView::slotRubberBandActivationChanged);
 113
 114     m_tapAndHoldIndicator = new KItemListRubberBand(this);
 115     m_indicatorAnimation = new QPropertyAnimation(m_tapAndHoldIndicator, "endPosition", this);
 116     connect(m_tapAndHoldIndicator, &KItemListRubberBand::activationChanged, this, [this](bool active) {
 117         if (active) {
 118             m_indicatorAnimation->setDuration(150);
 119             m_indicatorAnimation->setStartValue(QPointF(1, 1));
 120             m_indicatorAnimation->setEndValue(QPointF(40, 40));
 121             m_indicatorAnimation->start();
 122         }
 123         update();
 124     });
 125     connect(m_tapAndHoldIndicator, &KItemListRubberBand::endPositionChanged, this, [this]() {
 126         if (m_tapAndHoldIndicator->isActive()) {
 127             update();
 128         }
 129     });
 130
 131     m_headerWidget = new KItemListHeaderWidget(this);
 132     m_headerWidget->setVisible(false);
 133
 134     m_header = new KItemListHeader(this);
 135
 136 #ifndef QT_NO_ACCESSIBILITY
 137     QAccessible::installFactory(accessibleInterfaceFactory);
 138 #endif
 139 }
 140
 141 KItemListView::~KItemListView()
 142 {
 143     // The group headers are children of the widgets created by
 144     // widgetCreator(). So it is mandatory to delete the group headers
 145     // first.
 146     delete m_groupHeaderCreator;
 147     m_groupHeaderCreator = nullptr;
 148
 149     delete m_widgetCreator;
 150     m_widgetCreator = nullptr;
 151
 152     delete m_sizeHintResolver;
 153     m_sizeHintResolver = nullptr;
 154 }
 155
 156 void KItemListView::setScrollOffset(qreal offset)
 157 {
 158     if (offset < 0) {
 159         offset = 0;
 160     }
 161
 162     const qreal previousOffset = m_layouter->scrollOffset();
 163     if (offset == previousOffset) {
 164         return;
 165     }
 166
 167     m_layouter->setScrollOffset(offset);
 168     m_animation->setScrollOffset(offset);
 169
 170     // Don't check whether the m_layoutTimer is active: Changing the
 171     // scroll offset must always trigger a synchronous layout, otherwise
 172     // the smooth-scrolling might get jerky.
 173     doLayout(NoAnimation);
 174     onScrollOffsetChanged(offset, previousOffset);
 175 }
 176
 177 qreal KItemListView::scrollOffset() const
 178 {
 179     return m_layouter->scrollOffset();
 180 }
 181
 182 qreal KItemListView::maximumScrollOffset() const
 183 {
 184     return m_layouter->maximumScrollOffset();
 185 }
 186
 187 void KItemListView::setItemOffset(qreal offset)
 188 {
 189     if (m_layouter->itemOffset() == offset) {
 190         return;
 191     }
 192
 193     m_layouter->setItemOffset(offset);
 194     if (m_headerWidget->isVisible()) {
 195         m_headerWidget->setOffset(offset);
 196     }
 197
 198     // Don't check whether the m_layoutTimer is active: Changing the
 199     // item offset must always trigger a synchronous layout, otherwise
 200     // the smooth-scrolling might get jerky.
 201     doLayout(NoAnimation);
 202 }
 203
 204 qreal KItemListView::itemOffset() const
 205 {
 206     return m_layouter->itemOffset();
 207 }
 208
 209 qreal KItemListView::maximumItemOffset() const
 210 {
 211     return m_layouter->maximumItemOffset();
 212 }
 213
 214 int KItemListView::maximumVisibleItems() const
 215 {
 216     return m_layouter->maximumVisibleItems();
 217 }
 218
 219 void KItemListView::setVisibleRoles(const QList<QByteArray> &roles)
 220 {
 221     const QList<QByteArray> previousRoles = m_visibleRoles;
 222     m_visibleRoles = roles;
 223     onVisibleRolesChanged(roles, previousRoles);
 224
 225     m_sizeHintResolver->clearCache();
 226     m_layouter->markAsDirty();
 227
 228     if (m_itemSize.isEmpty()) {
 229         m_headerWidget->setColumns(roles);
 230         updatePreferredColumnWidths();
 231         if (!m_headerWidget->automaticColumnResizing()) {
 232             // The column-width of new roles are still 0. Apply the preferred
 233             // column-width as default with.
 234             for (const QByteArray &role : qAsConst(m_visibleRoles)) {
 235                 if (m_headerWidget->columnWidth(role) == 0) {
 236                     const qreal width = m_headerWidget->preferredColumnWidth(role);
 237                     m_headerWidget->setColumnWidth(role, width);
 238                 }
 239             }
 240
 241             applyColumnWidthsFromHeader();
 242         }
 243     }
 244
 245     const bool alternateBackgroundsChanged =
 246         m_itemSize.isEmpty() && ((roles.count() > 1 && previousRoles.count() <= 1) || (roles.count() <= 1 && previousRoles.count() > 1));
 247
 248     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
 249     while (it.hasNext()) {
 250         it.next();
 251         KItemListWidget *widget = it.value();
 252         widget->setVisibleRoles(roles);
 253         if (alternateBackgroundsChanged) {
 254             updateAlternateBackgroundForWidget(widget);
 255         }
 256     }
 257
 258     doLayout(NoAnimation);
 259 }
 260
 261 QList<QByteArray> KItemListView::visibleRoles() const
 262 {
 263     return m_visibleRoles;
 264 }
 265
 266 void KItemListView::setAutoScroll(bool enabled)
 267 {
 268     if (enabled && !m_autoScrollTimer) {
 269         m_autoScrollTimer = new QTimer(this);
 270         m_autoScrollTimer->setSingleShot(true);
 271         connect(m_autoScrollTimer, &QTimer::timeout, this, &KItemListView::triggerAutoScrolling);
 272         m_autoScrollTimer->start(InitialAutoScrollDelay);
 273     } else if (!enabled && m_autoScrollTimer) {
 274         delete m_autoScrollTimer;
 275         m_autoScrollTimer = nullptr;
 276     }
 277 }
 278
 279 bool KItemListView::autoScroll() const
 280 {
 281     return m_autoScrollTimer != nullptr;
 282 }
 283
 284 void KItemListView::setEnabledSelectionToggles(bool enabled)
 285 {
 286     if (m_enabledSelectionToggles != enabled) {
 287         m_enabledSelectionToggles = enabled;
 288
 289         QHashIterator<int, KItemListWidget *> it(m_visibleItems);
 290         while (it.hasNext()) {
 291             it.next();
 292             it.value()->setEnabledSelectionToggle(enabled);
 293         }
 294     }
 295 }
 296
 297 bool KItemListView::enabledSelectionToggles() const
 298 {
 299     return m_enabledSelectionToggles;
 300 }
 301
 302 KItemListController *KItemListView::controller() const
 303 {
 304     return m_controller;
 305 }
 306
 307 KItemModelBase *KItemListView::model() const
 308 {
 309     return m_model;
 310 }
 311
 312 void KItemListView::setWidgetCreator(KItemListWidgetCreatorBase *widgetCreator)
 313 {
 314     delete m_widgetCreator;
 315     m_widgetCreator = widgetCreator;
 316 }
 317
 318 KItemListWidgetCreatorBase *KItemListView::widgetCreator() const
 319 {
 320     if (!m_widgetCreator) {
 321         m_widgetCreator = defaultWidgetCreator();
 322     }
 323     return m_widgetCreator;
 324 }
 325
 326 void KItemListView::setGroupHeaderCreator(KItemListGroupHeaderCreatorBase *groupHeaderCreator)
 327 {
 328     delete m_groupHeaderCreator;
 329     m_groupHeaderCreator = groupHeaderCreator;
 330 }
 331
 332 KItemListGroupHeaderCreatorBase *KItemListView::groupHeaderCreator() const
 333 {
 334     if (!m_groupHeaderCreator) {
 335         m_groupHeaderCreator = defaultGroupHeaderCreator();
 336     }
 337     return m_groupHeaderCreator;
 338 }
 339
 340 QSizeF KItemListView::itemSize() const
 341 {
 342     return m_itemSize;
 343 }
 344
 345 const KItemListStyleOption &KItemListView::styleOption() const
 346 {
 347     return m_styleOption;
 348 }
 349
 350 void KItemListView::setGeometry(const QRectF &rect)
 351 {
 352     QGraphicsWidget::setGeometry(rect);
 353
 354     if (!m_model) {
 355         return;
 356     }
 357
 358     const QSizeF newSize = rect.size();
 359     if (m_itemSize.isEmpty()) {
 360         m_headerWidget->resize(rect.width(), m_headerWidget->size().height());
 361         if (m_headerWidget->automaticColumnResizing()) {
 362             applyAutomaticColumnWidths();
 363         } else {
 364             const qreal requiredWidth = columnWidthsSum();
 365             const QSizeF dynamicItemSize(qMax(newSize.width(), requiredWidth), m_itemSize.height());
 366             m_layouter->setItemSize(dynamicItemSize);
 367         }
 368     }
 369
 370     m_layouter->setSize(newSize);
 371     // We don't animate the moving of the items here because
 372     // it would look like the items are slow to find their position.
 373     doLayout(NoAnimation);
 374 }
 375
 376 qreal KItemListView::verticalPageStep() const
 377 {
 378     qreal headerHeight = 0;
 379     if (m_headerWidget->isVisible()) {
 380         headerHeight = m_headerWidget->size().height();
 381     }
 382     return size().height() - headerHeight;
 383 }
 384
 385 std::optional<int> KItemListView::itemAt(const QPointF &pos) const
 386 {
 387     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
 388     while (it.hasNext()) {
 389         it.next();
 390
 391         const KItemListWidget *widget = it.value();
 392         const QPointF mappedPos = widget->mapFromItem(this, pos);
 393         if (widget->contains(mappedPos) || widget->selectionRect().contains(mappedPos)) {
 394             return it.key();
 395         }
 396     }
 397
 398     return std::nullopt;
 399 }
 400
 401 bool KItemListView::isAboveSelectionToggle(int index, const QPointF &pos) const
 402 {
 403     if (!m_enabledSelectionToggles) {
 404         return false;
 405     }
 406
 407     const KItemListWidget *widget = m_visibleItems.value(index);
 408     if (widget) {
 409         const QRectF selectionToggleRect = widget->selectionToggleRect();
 410         if (!selectionToggleRect.isEmpty()) {
 411             const QPointF mappedPos = widget->mapFromItem(this, pos);
 412             return selectionToggleRect.contains(mappedPos);
 413         }
 414     }
 415     return false;
 416 }
 417
 418 bool KItemListView::isAboveExpansionToggle(int index, const QPointF &pos) const
 419 {
 420     const KItemListWidget *widget = m_visibleItems.value(index);
 421     if (widget) {
 422         const QRectF expansionToggleRect = widget->expansionToggleRect();
 423         if (!expansionToggleRect.isEmpty()) {
 424             const QPointF mappedPos = widget->mapFromItem(this, pos);
 425             return expansionToggleRect.contains(mappedPos);
 426         }
 427     }
 428     return false;
 429 }
 430
 431 bool KItemListView::isAboveText(int index, const QPointF &pos) const
 432 {
 433     const KItemListWidget *widget = m_visibleItems.value(index);
 434     if (widget) {
 435         const QRectF &textRect = widget->textRect();
 436         if (!textRect.isEmpty()) {
 437             const QPointF mappedPos = widget->mapFromItem(this, pos);
 438             return textRect.contains(mappedPos);
 439         }
 440     }
 441     return false;
 442 }
 443
 444 int KItemListView::firstVisibleIndex() const
 445 {
 446     return m_layouter->firstVisibleIndex();
 447 }
 448
 449 int KItemListView::lastVisibleIndex() const
 450 {
 451     return m_layouter->lastVisibleIndex();
 452 }
 453
 454 void KItemListView::calculateItemSizeHints(QVector<std::pair<qreal, bool>> &logicalHeightHints, qreal &logicalWidthHint) const
 455 {
 456     widgetCreator()->calculateItemSizeHints(logicalHeightHints, logicalWidthHint, this);
 457 }
 458
 459 void KItemListView::setSupportsItemExpanding(bool supportsExpanding)
 460 {
 461     if (m_supportsItemExpanding != supportsExpanding) {
 462         m_supportsItemExpanding = supportsExpanding;
 463         updateSiblingsInformation();
 464         onSupportsItemExpandingChanged(supportsExpanding);
 465     }
 466 }
 467
 468 bool KItemListView::supportsItemExpanding() const
 469 {
 470     return m_supportsItemExpanding;
 471 }
 472
 473 void KItemListView::setHighlightEntireRow(bool highlightEntireRow)
 474 {
 475     if (m_highlightEntireRow != highlightEntireRow) {
 476         m_highlightEntireRow = highlightEntireRow;
 477         onHighlightEntireRowChanged(highlightEntireRow);
 478     }
 479 }
 480
 481 bool KItemListView::highlightEntireRow() const
 482 {
 483     return m_highlightEntireRow;
 484 }
 485
 486 void KItemListView::setAlternateBackgrounds(bool alternate)
 487 {
 488     if (m_alternateBackgrounds != alternate) {
 489         m_alternateBackgrounds = alternate;
 490         updateAlternateBackgrounds();
 491     }
 492 }
 493
 494 bool KItemListView::alternateBackgrounds() const
 495 {
 496     return m_alternateBackgrounds;
 497 }
 498
 499 QRectF KItemListView::itemRect(int index) const
 500 {
 501     return m_layouter->itemRect(index);
 502 }
 503
 504 QRectF KItemListView::itemContextRect(int index) const
 505 {
 506     QRectF contextRect;
 507
 508     const KItemListWidget *widget = m_visibleItems.value(index);
 509     if (widget) {
 510         contextRect = widget->iconRect() | widget->textRect();
 511         contextRect.translate(itemRect(index).topLeft());
 512     }
 513
 514     return contextRect;
 515 }
 516
 517 bool KItemListView::isElided(int index) const
 518 {
 519     return m_sizeHintResolver->isElided(index);
 520 }
 521
 522 void KItemListView::scrollToItem(int index)
 523 {
 524     QRectF viewGeometry = geometry();
 525     if (m_headerWidget->isVisible()) {
 526         const qreal headerHeight = m_headerWidget->size().height();
 527         viewGeometry.adjust(0, headerHeight, 0, 0);
 528     }
 529     QRectF currentRect = itemRect(index);
 530
 531     // Fix for Bug 311099 - View the underscore when using Ctrl + PagDown
 532     currentRect.adjust(-m_styleOption.horizontalMargin, -m_styleOption.verticalMargin, m_styleOption.horizontalMargin, m_styleOption.verticalMargin);
 533
 534     if (!viewGeometry.contains(currentRect)) {
 535         qreal newOffset = scrollOffset();
 536         if (scrollOrientation() == Qt::Vertical) {
 537             if (currentRect.top() < viewGeometry.top()) {
 538                 newOffset += currentRect.top() - viewGeometry.top();
 539             } else if (currentRect.bottom() > viewGeometry.bottom()) {
 540                 newOffset += currentRect.bottom() - viewGeometry.bottom();
 541             }
 542         } else {
 543             if (currentRect.left() < viewGeometry.left()) {
 544                 newOffset += currentRect.left() - viewGeometry.left();
 545             } else if (currentRect.right() > viewGeometry.right()) {
 546                 newOffset += currentRect.right() - viewGeometry.right();
 547             }
 548         }
 549
 550         if (newOffset != scrollOffset()) {
 551             Q_EMIT scrollTo(newOffset);
 552             return;
 553         }
 554     }
 555
 556     Q_EMIT scrollingStopped();
 557 }
 558
 559 void KItemListView::beginTransaction()
 560 {
 561     ++m_activeTransactions;
 562     if (m_activeTransactions == 1) {
 563         onTransactionBegin();
 564     }
 565 }
 566
 567 void KItemListView::endTransaction()
 568 {
 569     --m_activeTransactions;
 570     if (m_activeTransactions < 0) {
 571         m_activeTransactions = 0;
 572         qCWarning(DolphinDebug) << "Mismatch between beginTransaction()/endTransaction()";
 573     }
 574
 575     if (m_activeTransactions == 0) {
 576         onTransactionEnd();
 577         doLayout(m_endTransactionAnimationHint);
 578         m_endTransactionAnimationHint = Animation;
 579     }
 580 }
 581
 582 bool KItemListView::isTransactionActive() const
 583 {
 584     return m_activeTransactions > 0;
 585 }
 586
 587 void KItemListView::setHeaderVisible(bool visible)
 588 {
 589     if (visible && !m_headerWidget->isVisible()) {
 590         QStyleOptionHeader option;
 591         const QSize headerSize = style()->sizeFromContents(QStyle::CT_HeaderSection, &option, QSize());
 592
 593         m_headerWidget->setPos(0, 0);
 594         m_headerWidget->resize(size().width(), headerSize.height());
 595         m_headerWidget->setModel(m_model);
 596         m_headerWidget->setColumns(m_visibleRoles);
 597         m_headerWidget->setZValue(1);
 598
 599         connect(m_headerWidget, &KItemListHeaderWidget::columnWidthChanged, this, &KItemListView::slotHeaderColumnWidthChanged);
 600         connect(m_headerWidget, &KItemListHeaderWidget::sidePaddingChanged, this, &KItemListView::slotSidePaddingChanged);
 601         connect(m_headerWidget, &KItemListHeaderWidget::columnMoved, this, &KItemListView::slotHeaderColumnMoved);
 602         connect(m_headerWidget, &KItemListHeaderWidget::sortOrderChanged, this, &KItemListView::sortOrderChanged);
 603         connect(m_headerWidget, &KItemListHeaderWidget::sortRoleChanged, this, &KItemListView::sortRoleChanged);
 604         connect(m_headerWidget, &KItemListHeaderWidget::columnHovered, this, &KItemListView::columnHovered);
 605         connect(m_headerWidget, &KItemListHeaderWidget::columnUnHovered, this, &KItemListView::columnUnHovered);
 606
 607         m_layouter->setHeaderHeight(headerSize.height());
 608         m_headerWidget->setVisible(true);
 609     } else if (!visible && m_headerWidget->isVisible()) {
 610         disconnect(m_headerWidget, &KItemListHeaderWidget::columnWidthChanged, this, &KItemListView::slotHeaderColumnWidthChanged);
 611         disconnect(m_headerWidget, &KItemListHeaderWidget::sidePaddingChanged, this, &KItemListView::slotSidePaddingChanged);
 612         disconnect(m_headerWidget, &KItemListHeaderWidget::columnMoved, this, &KItemListView::slotHeaderColumnMoved);
 613         disconnect(m_headerWidget, &KItemListHeaderWidget::sortOrderChanged, this, &KItemListView::sortOrderChanged);
 614         disconnect(m_headerWidget, &KItemListHeaderWidget::sortRoleChanged, this, &KItemListView::sortRoleChanged);
 615         disconnect(m_headerWidget, &KItemListHeaderWidget::columnHovered, this, &KItemListView::columnHovered);
 616         disconnect(m_headerWidget, &KItemListHeaderWidget::columnUnHovered, this, &KItemListView::columnUnHovered);
 617
 618         m_layouter->setHeaderHeight(0);
 619         m_headerWidget->setVisible(false);
 620     }
 621 }
 622
 623 bool KItemListView::isHeaderVisible() const
 624 {
 625     return m_headerWidget->isVisible();
 626 }
 627
 628 KItemListHeader *KItemListView::header() const
 629 {
 630     return m_header;
 631 }
 632
 633 QPixmap KItemListView::createDragPixmap(const KItemSet &indexes) const
 634 {
 635     QPixmap pixmap;
 636
 637     if (indexes.count() == 1) {
 638         KItemListWidget *item = m_visibleItems.value(indexes.first());
 639         QGraphicsView *graphicsView = scene()->views()[0];
 640         if (item && graphicsView) {
 641             pixmap = item->createDragPixmap(nullptr, graphicsView);
 642         }
 643     } else {
 644         // TODO: Not implemented yet. Probably extend the interface
 645         // from KItemListWidget::createDragPixmap() to return a pixmap
 646         // that can be used for multiple indexes.
 647     }
 648
 649     return pixmap;
 650 }
 651
 652 void KItemListView::editRole(int index, const QByteArray &role)
 653 {
 654     KStandardItemListWidget *widget = qobject_cast<KStandardItemListWidget *>(m_visibleItems.value(index));
 655     if (!widget || m_editingRole) {
 656         return;
 657     }
 658
 659     m_editingRole = true;
 660     widget->setEditedRole(role);
 661
 662     connect(widget, &KItemListWidget::roleEditingCanceled, this, &KItemListView::slotRoleEditingCanceled);
 663     connect(widget, &KItemListWidget::roleEditingFinished, this, &KItemListView::slotRoleEditingFinished);
 664
 665     connect(this, &KItemListView::scrollOffsetChanged, widget, &KStandardItemListWidget::finishRoleEditing);
 666 }
 667
 668 void KItemListView::paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
 669 {
 670     QGraphicsWidget::paint(painter, option, widget);
 671
 672     for (auto animation : qAsConst(m_rubberBandAnimations)) {
 673         QRectF rubberBandRect = animation->property(RubberPropertyName).toRectF();
 674
 675         const QPointF topLeft = rubberBandRect.topLeft();
 676         if (scrollOrientation() == Qt::Vertical) {
 677             rubberBandRect.moveTo(topLeft.x(), topLeft.y() - scrollOffset());
 678         } else {
 679             rubberBandRect.moveTo(topLeft.x() - scrollOffset(), topLeft.y());
 680         }
 681
 682         QStyleOptionRubberBand opt;
 683         initStyleOption(&opt);
 684         opt.shape = QRubberBand::Rectangle;
 685         opt.opaque = false;
 686         opt.rect = rubberBandRect.toRect();
 687
 688         painter->save();
 689
 690         painter->setOpacity(animation->currentValue().toReal());
 691         style()->drawControl(QStyle::CE_RubberBand, &opt, painter);
 692
 693         painter->restore();
 694     }
 695
 696     if (m_rubberBand->isActive()) {
 697         QRectF rubberBandRect = QRectF(m_rubberBand->startPosition(), m_rubberBand->endPosition()).normalized();
 698
 699         const QPointF topLeft = rubberBandRect.topLeft();
 700         if (scrollOrientation() == Qt::Vertical) {
 701             rubberBandRect.moveTo(topLeft.x(), topLeft.y() - scrollOffset());
 702         } else {
 703             rubberBandRect.moveTo(topLeft.x() - scrollOffset(), topLeft.y());
 704         }
 705
 706         QStyleOptionRubberBand opt;
 707         initStyleOption(&opt);
 708         opt.shape = QRubberBand::Rectangle;
 709         opt.opaque = false;
 710         opt.rect = rubberBandRect.toRect();
 711         style()->drawControl(QStyle::CE_RubberBand, &opt, painter);
 712     }
 713
 714     if (m_tapAndHoldIndicator->isActive()) {
 715         const QPointF indicatorSize = m_tapAndHoldIndicator->endPosition();
 716         const QRectF rubberBandRect =
 717             QRectF(m_tapAndHoldIndicator->startPosition() - indicatorSize, (m_tapAndHoldIndicator->startPosition()) + indicatorSize).normalized();
 718         QStyleOptionRubberBand opt;
 719         initStyleOption(&opt);
 720         opt.shape = QRubberBand::Rectangle;
 721         opt.opaque = false;
 722         opt.rect = rubberBandRect.toRect();
 723         style()->drawControl(QStyle::CE_RubberBand, &opt, painter);
 724     }
 725
 726     if (!m_dropIndicator.isEmpty()) {
 727         const QRectF r = m_dropIndicator.toRect();
 728
 729         QColor color = palette().brush(QPalette::Normal, QPalette::Text).color();
 730         painter->setPen(color);
 731
 732         // TODO: The following implementation works only for a vertical scroll-orientation
 733         // and assumes a height of the m_draggingInsertIndicator of 1.
 734         Q_ASSERT(r.height() == 1);
 735         painter->drawLine(r.left() + 1, r.top(), r.right() - 1, r.top());
 736
 737         color.setAlpha(128);
 738         painter->setPen(color);
 739         painter->drawRect(r.left(), r.top() - 1, r.width() - 1, 2);
 740     }
 741 }
 742
 743 QVariant KItemListView::itemChange(GraphicsItemChange change, const QVariant &value)
 744 {
 745     if (change == QGraphicsItem::ItemSceneHasChanged && scene()) {
 746         if (!scene()->views().isEmpty()) {
 747             m_styleOption.palette = scene()->views().at(0)->palette();
 748         }
 749     }
 750     return QGraphicsItem::itemChange(change, value);
 751 }
 752
 753 void KItemListView::setItemSize(const QSizeF &size)
 754 {
 755     const QSizeF previousSize = m_itemSize;
 756     if (size == previousSize) {
 757         return;
 758     }
 759
 760     // Skip animations when the number of rows or columns
 761     // are changed in the grid layout. Although the animation
 762     // engine can handle this usecase, it looks obtrusive.
 763     const bool animate = !changesItemGridLayout(m_layouter->size(), size, m_layouter->itemMargin());
 764
 765     const bool alternateBackgroundsChanged = m_alternateBackgrounds && ((m_itemSize.isEmpty() && !size.isEmpty()) || (!m_itemSize.isEmpty() && size.isEmpty()));
 766
 767     m_itemSize = size;
 768
 769     if (alternateBackgroundsChanged) {
 770         // For an empty item size alternate backgrounds are drawn if more than
 771         // one role is shown. Assure that the backgrounds for visible items are
 772         // updated when changing the size in this context.
 773         updateAlternateBackgrounds();
 774     }
 775
 776     if (size.isEmpty()) {
 777         if (m_headerWidget->automaticColumnResizing()) {
 778             updatePreferredColumnWidths();
 779         } else {
 780             // Only apply the changed height and respect the header widths
 781             // set by the user
 782             const qreal currentWidth = m_layouter->itemSize().width();
 783             const QSizeF newSize(currentWidth, size.height());
 784             m_layouter->setItemSize(newSize);
 785         }
 786     } else {
 787         m_layouter->setItemSize(size);
 788     }
 789
 790     m_sizeHintResolver->clearCache();
 791     doLayout(animate ? Animation : NoAnimation);
 792     onItemSizeChanged(size, previousSize);
 793 }
 794
 795 void KItemListView::setStyleOption(const KItemListStyleOption &option)
 796 {
 797     if (m_styleOption == option) {
 798         return;
 799     }
 800
 801     const KItemListStyleOption previousOption = m_styleOption;
 802     m_styleOption = option;
 803
 804     bool animate = true;
 805     const QSizeF margin(option.horizontalMargin, option.verticalMargin);
 806     if (margin != m_layouter->itemMargin()) {
 807         // Skip animations when the number of rows or columns
 808         // are changed in the grid layout. Although the animation
 809         // engine can handle this usecase, it looks obtrusive.
 810         animate = !changesItemGridLayout(m_layouter->size(), m_layouter->itemSize(), margin);
 811         m_layouter->setItemMargin(margin);
 812     }
 813
 814     if (m_grouped) {
 815         updateGroupHeaderHeight();
 816     }
 817
 818     if (animate && (previousOption.maxTextLines != option.maxTextLines || previousOption.maxTextWidth != option.maxTextWidth)) {
 819         // Animating a change of the maximum text size just results in expensive
 820         // temporary eliding and clipping operations and does not look good visually.
 821         animate = false;
 822     }
 823
 824     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
 825     while (it.hasNext()) {
 826         it.next();
 827         it.value()->setStyleOption(option);
 828     }
 829
 830     m_sizeHintResolver->clearCache();
 831     m_layouter->markAsDirty();
 832     doLayout(animate ? Animation : NoAnimation);
 833
 834     if (m_itemSize.isEmpty()) {
 835         updatePreferredColumnWidths();
 836     }
 837
 838     onStyleOptionChanged(option, previousOption);
 839 }
 840
 841 void KItemListView::setScrollOrientation(Qt::Orientation orientation)
 842 {
 843     const Qt::Orientation previousOrientation = m_layouter->scrollOrientation();
 844     if (orientation == previousOrientation) {
 845         return;
 846     }
 847
 848     m_layouter->setScrollOrientation(orientation);
 849     m_animation->setScrollOrientation(orientation);
 850     m_sizeHintResolver->clearCache();
 851
 852     if (m_grouped) {
 853         QMutableHashIterator<KItemListWidget *, KItemListGroupHeader *> it(m_visibleGroups);
 854         while (it.hasNext()) {
 855             it.next();
 856             it.value()->setScrollOrientation(orientation);
 857         }
 858         updateGroupHeaderHeight();
 859     }
 860
 861     doLayout(NoAnimation);
 862
 863     onScrollOrientationChanged(orientation, previousOrientation);
 864     Q_EMIT scrollOrientationChanged(orientation, previousOrientation);
 865 }
 866
 867 Qt::Orientation KItemListView::scrollOrientation() const
 868 {
 869     return m_layouter->scrollOrientation();
 870 }
 871
 872 KItemListWidgetCreatorBase *KItemListView::defaultWidgetCreator() const
 873 {
 874     return nullptr;
 875 }
 876
 877 KItemListGroupHeaderCreatorBase *KItemListView::defaultGroupHeaderCreator() const
 878 {
 879     return nullptr;
 880 }
 881
 882 void KItemListView::initializeItemListWidget(KItemListWidget *item)
 883 {
 884     Q_UNUSED(item)
 885 }
 886
 887 bool KItemListView::itemSizeHintUpdateRequired(const QSet<QByteArray> &changedRoles) const
 888 {
 889     Q_UNUSED(changedRoles)
 890     return true;
 891 }
 892
 893 void KItemListView::onControllerChanged(KItemListController *current, KItemListController *previous)
 894 {
 895     Q_UNUSED(current)
 896     Q_UNUSED(previous)
 897 }
 898
 899 void KItemListView::onModelChanged(KItemModelBase *current, KItemModelBase *previous)
 900 {
 901     Q_UNUSED(current)
 902     Q_UNUSED(previous)
 903 }
 904
 905 void KItemListView::onScrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous)
 906 {
 907     Q_UNUSED(current)
 908     Q_UNUSED(previous)
 909 }
 910
 911 void KItemListView::onItemSizeChanged(const QSizeF &current, const QSizeF &previous)
 912 {
 913     Q_UNUSED(current)
 914     Q_UNUSED(previous)
 915 }
 916
 917 void KItemListView::onScrollOffsetChanged(qreal current, qreal previous)
 918 {
 919     Q_UNUSED(current)
 920     Q_UNUSED(previous)
 921 }
 922
 923 void KItemListView::onVisibleRolesChanged(const QList<QByteArray> &current, const QList<QByteArray> &previous)
 924 {
 925     Q_UNUSED(current)
 926     Q_UNUSED(previous)
 927 }
 928
 929 void KItemListView::onStyleOptionChanged(const KItemListStyleOption &current, const KItemListStyleOption &previous)
 930 {
 931     Q_UNUSED(current)
 932     Q_UNUSED(previous)
 933 }
 934
 935 void KItemListView::onHighlightEntireRowChanged(bool highlightEntireRow)
 936 {
 937     Q_UNUSED(highlightEntireRow)
 938 }
 939
 940 void KItemListView::onSupportsItemExpandingChanged(bool supportsExpanding)
 941 {
 942     Q_UNUSED(supportsExpanding)
 943 }
 944
 945 void KItemListView::onTransactionBegin()
 946 {
 947 }
 948
 949 void KItemListView::onTransactionEnd()
 950 {
 951 }
 952
 953 bool KItemListView::event(QEvent *event)
 954 {
 955     switch (event->type()) {
 956     case QEvent::PaletteChange:
 957         updatePalette();
 958         break;
 959
 960     case QEvent::FontChange:
 961         updateFont();
 962         break;
 963
 964     default:
 965         // Forward all other events to the controller and handle them there
 966         if (!m_editingRole && m_controller && m_controller->processEvent(event, transform())) {
 967             event->accept();
 968             return true;
 969         }
 970     }
 971
 972     return QGraphicsWidget::event(event);
 973 }
 974
 975 void KItemListView::mousePressEvent(QGraphicsSceneMouseEvent *event)
 976 {
 977     m_mousePos = transform().map(event->pos());
 978     event->accept();
 979 }
 980
 981 void KItemListView::mouseMoveEvent(QGraphicsSceneMouseEvent *event)
 982 {
 983     QGraphicsWidget::mouseMoveEvent(event);
 984
 985     m_mousePos = transform().map(event->pos());
 986     if (m_autoScrollTimer && !m_autoScrollTimer->isActive()) {
 987         m_autoScrollTimer->start(InitialAutoScrollDelay);
 988     }
 989 }
 990
 991 void KItemListView::dragEnterEvent(QGraphicsSceneDragDropEvent *event)
 992 {
 993     event->setAccepted(true);
 994     setAutoScroll(true);
 995 }
 996
 997 void KItemListView::dragMoveEvent(QGraphicsSceneDragDropEvent *event)
 998 {
 999     QGraphicsWidget::dragMoveEvent(event);
1000
1001     m_mousePos = transform().map(event->pos());
1002     if (m_autoScrollTimer && !m_autoScrollTimer->isActive()) {
1003         m_autoScrollTimer->start(InitialAutoScrollDelay);
1004     }
1005 }
1006
1007 void KItemListView::dragLeaveEvent(QGraphicsSceneDragDropEvent *event)
1008 {
1009     QGraphicsWidget::dragLeaveEvent(event);
1010     setAutoScroll(false);
1011 }
1012
1013 void KItemListView::dropEvent(QGraphicsSceneDragDropEvent *event)
1014 {
1015     QGraphicsWidget::dropEvent(event);
1016     setAutoScroll(false);
1017 }
1018
1019 QList<KItemListWidget *> KItemListView::visibleItemListWidgets() const
1020 {
1021     return m_visibleItems.values();
1022 }
1023
1024 void KItemListView::updateFont()
1025 {
1026     if (scene() && !scene()->views().isEmpty()) {
1027         KItemListStyleOption option = styleOption();
1028         option.font = scene()->views().first()->font();
1029         option.fontMetrics = QFontMetrics(option.font);
1030
1031         setStyleOption(option);
1032     }
1033 }
1034
1035 void KItemListView::updatePalette()
1036 {
1037     KItemListStyleOption option = styleOption();
1038     option.palette = palette();
1039     setStyleOption(option);
1040 }
1041
1042 void KItemListView::slotItemsInserted(const KItemRangeList &itemRanges)
1043 {
1044     if (m_itemSize.isEmpty()) {
1045         updatePreferredColumnWidths(itemRanges);
1046     }
1047
1048     const bool hasMultipleRanges = (itemRanges.count() > 1);
1049     if (hasMultipleRanges) {
1050         beginTransaction();
1051     }
1052
1053     m_layouter->markAsDirty();
1054
1055     m_sizeHintResolver->itemsInserted(itemRanges);
1056
1057     int previouslyInsertedCount = 0;
1058     for (const KItemRange &range : itemRanges) {
1059         // range.index is related to the model before anything has been inserted.
1060         // As in each loop the current item-range gets inserted the index must
1061         // be increased by the already previously inserted items.
1062         const int index = range.index + previouslyInsertedCount;
1063         const int count = range.count;
1064         if (index < 0 || count <= 0) {
1065             qCWarning(DolphinDebug) << "Invalid item range (index:" << index << ", count:" << count << ")";
1066             continue;
1067         }
1068         previouslyInsertedCount += count;
1069
1070         // Determine which visible items must be moved
1071         QList<int> itemsToMove;
1072         QHashIterator<int, KItemListWidget *> it(m_visibleItems);
1073         while (it.hasNext()) {
1074             it.next();
1075             const int visibleItemIndex = it.key();
1076             if (visibleItemIndex >= index) {
1077                 itemsToMove.append(visibleItemIndex);
1078             }
1079         }
1080
1081         // Update the indexes of all KItemListWidget instances that are located
1082         // after the inserted items. It is important to adjust the indexes in the order
1083         // from the highest index to the lowest index to prevent overlaps when setting the new index.
1084         std::sort(itemsToMove.begin(), itemsToMove.end());
1085         for (int i = itemsToMove.count() - 1; i >= 0; --i) {
1086             KItemListWidget *widget = m_visibleItems.value(itemsToMove[i]);
1087             Q_ASSERT(widget);
1088             const int newIndex = widget->index() + count;
1089             if (hasMultipleRanges) {
1090                 setWidgetIndex(widget, newIndex);
1091             } else {
1092                 // Try to animate the moving of the item
1093                 moveWidgetToIndex(widget, newIndex);
1094             }
1095         }
1096
1097         if (m_model->count() == count && m_activeTransactions == 0) {
1098             // Check whether a scrollbar is required to show the inserted items. In this case
1099             // the size of the layouter will be decreased before calling doLayout(): This prevents
1100             // an unnecessary temporary animation due to the geometry change of the inserted scrollbar.
1101             const bool verticalScrollOrientation = (scrollOrientation() == Qt::Vertical);
1102             const bool decreaseLayouterSize = (verticalScrollOrientation && maximumScrollOffset() > size().height())
1103                 || (!verticalScrollOrientation && maximumScrollOffset() > size().width());
1104             if (decreaseLayouterSize) {
1105                 const int scrollBarExtent = style()->pixelMetric(QStyle::PM_ScrollBarExtent);
1106
1107                 int scrollbarSpacing = 0;
1108                 if (style()->styleHint(QStyle::SH_ScrollView_FrameOnlyAroundContents)) {
1109                     scrollbarSpacing = style()->pixelMetric(QStyle::PM_ScrollView_ScrollBarSpacing);
1110                 }
1111
1112                 QSizeF layouterSize = m_layouter->size();
1113                 if (verticalScrollOrientation) {
1114                     layouterSize.rwidth() -= scrollBarExtent + scrollbarSpacing;
1115                 } else {
1116                     layouterSize.rheight() -= scrollBarExtent + scrollbarSpacing;
1117                 }
1118                 m_layouter->setSize(layouterSize);
1119             }
1120         }
1121
1122         if (!hasMultipleRanges) {
1123             doLayout(animateChangedItemCount(count) ? Animation : NoAnimation, index, count);
1124             updateSiblingsInformation();
1125         }
1126     }
1127
1128     if (m_controller) {
1129         m_controller->selectionManager()->itemsInserted(itemRanges);
1130     }
1131
1132     if (hasMultipleRanges) {
1133         m_endTransactionAnimationHint = NoAnimation;
1134         endTransaction();
1135
1136         updateSiblingsInformation();
1137     }
1138
1139     if (m_grouped && (hasMultipleRanges || itemRanges.first().count < m_model->count())) {
1140         // In case if items of the same group have been inserted before an item that
1141         // currently represents the first item of the group, the group header of
1142         // this item must be removed.
1143         updateVisibleGroupHeaders();
1144     }
1145
1146     if (useAlternateBackgrounds()) {
1147         updateAlternateBackgrounds();
1148     }
1149 }
1150
1151 void KItemListView::slotItemsRemoved(const KItemRangeList &itemRanges)
1152 {
1153     if (m_itemSize.isEmpty()) {
1154         // Don't pass the item-range: The preferred column-widths of
1155         // all items must be adjusted when removing items.
1156         updatePreferredColumnWidths();
1157     }
1158
1159     const bool hasMultipleRanges = (itemRanges.count() > 1);
1160     if (hasMultipleRanges) {
1161         beginTransaction();
1162     }
1163
1164     m_layouter->markAsDirty();
1165
1166     m_sizeHintResolver->itemsRemoved(itemRanges);
1167
1168     for (int i = itemRanges.count() - 1; i >= 0; --i) {
1169         const KItemRange &range = itemRanges[i];
1170         const int index = range.index;
1171         const int count = range.count;
1172         if (index < 0 || count <= 0) {
1173             qCWarning(DolphinDebug) << "Invalid item range (index:" << index << ", count:" << count << ")";
1174             continue;
1175         }
1176
1177         const int firstRemovedIndex = index;
1178         const int lastRemovedIndex = index + count - 1;
1179
1180         // Remember which items have to be moved because they are behind the removed range.
1181         QVector<int> itemsToMove;
1182
1183         // Remove all KItemListWidget instances that got deleted
1184         // Iterate over a const copy because the container is mutated within the loop
1185         // directly and in `recycleWidget()` (https://bugs.kde.org/show_bug.cgi?id=428374)
1186         const auto visibleItems = m_visibleItems;
1187         for (KItemListWidget *widget : visibleItems) {
1188             const int i = widget->index();
1189             if (i < firstRemovedIndex) {
1190                 continue;
1191             } else if (i > lastRemovedIndex) {
1192                 itemsToMove.append(i);
1193                 continue;
1194             }
1195
1196             m_animation->stop(widget);
1197             // Stopping the animation might lead to recycling the widget if
1198             // it is invisible (see slotAnimationFinished()).
1199             // Check again whether it is still visible:
1200             if (!m_visibleItems.contains(i)) {
1201                 continue;
1202             }
1203
1204             if (m_model->count() == 0 || hasMultipleRanges || !animateChangedItemCount(count)) {
1205                 // Remove the widget without animation
1206                 recycleWidget(widget);
1207             } else {
1208                 // Animate the removing of the items. Special case: When removing an item there
1209                 // is no valid model index available anymore. For the
1210                 // remove-animation the item gets removed from m_visibleItems but the widget
1211                 // will stay alive until the animation has been finished and will
1212                 // be recycled (deleted) in KItemListView::slotAnimationFinished().
1213                 m_visibleItems.remove(i);
1214                 widget->setIndex(-1);
1215                 m_animation->start(widget, KItemListViewAnimation::DeleteAnimation);
1216             }
1217         }
1218
1219         // Update the indexes of all KItemListWidget instances that are located
1220         // after the deleted items. It is important to update them in ascending
1221         // order to prevent overlaps when setting the new index.
1222         std::sort(itemsToMove.begin(), itemsToMove.end());
1223         for (int i : qAsConst(itemsToMove)) {
1224             KItemListWidget *widget = m_visibleItems.value(i);
1225             Q_ASSERT(widget);
1226             const int newIndex = i - count;
1227             if (hasMultipleRanges) {
1228                 setWidgetIndex(widget, newIndex);
1229             } else {
1230                 // Try to animate the moving of the item
1231                 moveWidgetToIndex(widget, newIndex);
1232             }
1233         }
1234
1235         if (!hasMultipleRanges) {
1236             // The decrease-layout-size optimization in KItemListView::slotItemsInserted()
1237             // assumes an updated geometry. If items are removed during an active transaction,
1238             // the transaction will be temporary deactivated so that doLayout() triggers a
1239             // geometry update if necessary.
1240             const int activeTransactions = m_activeTransactions;
1241             m_activeTransactions = 0;
1242             doLayout(animateChangedItemCount(count) ? Animation : NoAnimation, index, -count);
1243             m_activeTransactions = activeTransactions;
1244             updateSiblingsInformation();
1245         }
1246     }
1247
1248     if (m_controller) {
1249         m_controller->selectionManager()->itemsRemoved(itemRanges);
1250     }
1251
1252     if (hasMultipleRanges) {
1253         m_endTransactionAnimationHint = NoAnimation;
1254         endTransaction();
1255         updateSiblingsInformation();
1256     }
1257
1258     if (m_grouped && (hasMultipleRanges || m_model->count() > 0)) {
1259         // In case if the first item of a group has been removed, the group header
1260         // must be applied to the next visible item.
1261         updateVisibleGroupHeaders();
1262     }
1263
1264     if (useAlternateBackgrounds()) {
1265         updateAlternateBackgrounds();
1266     }
1267 }
1268
1269 void KItemListView::slotItemsMoved(const KItemRange &itemRange, const QList<int> &movedToIndexes)
1270 {
1271     m_sizeHintResolver->itemsMoved(itemRange, movedToIndexes);
1272     m_layouter->markAsDirty();
1273
1274     if (m_controller) {
1275         m_controller->selectionManager()->itemsMoved(itemRange, movedToIndexes);
1276     }
1277
1278     const int firstVisibleMovedIndex = qMax(firstVisibleIndex(), itemRange.index);
1279     const int lastVisibleMovedIndex = qMin(lastVisibleIndex(), itemRange.index + itemRange.count - 1);
1280
1281     for (int index = firstVisibleMovedIndex; index <= lastVisibleMovedIndex; ++index) {
1282         KItemListWidget *widget = m_visibleItems.value(index);
1283         if (widget) {
1284             updateWidgetProperties(widget, index);
1285             initializeItemListWidget(widget);
1286         }
1287     }
1288
1289     doLayout(NoAnimation);
1290     updateSiblingsInformation();
1291 }
1292
1293 void KItemListView::slotItemsChanged(const KItemRangeList &itemRanges, const QSet<QByteArray> &roles)
1294 {
1295     const bool updateSizeHints = itemSizeHintUpdateRequired(roles);
1296     if (updateSizeHints && m_itemSize.isEmpty()) {
1297         updatePreferredColumnWidths(itemRanges);
1298     }
1299
1300     for (const KItemRange &itemRange : itemRanges) {
1301         const int index = itemRange.index;
1302         const int count = itemRange.count;
1303
1304         if (updateSizeHints) {
1305             m_sizeHintResolver->itemsChanged(index, count, roles);
1306             m_layouter->markAsDirty();
1307         }
1308
1309         // Apply the changed roles to the visible item-widgets
1310         const int lastIndex = index + count - 1;
1311         for (int i = index; i <= lastIndex; ++i) {
1312             KItemListWidget *widget = m_visibleItems.value(i);
1313             if (widget) {
1314                 widget->setData(m_model->data(i), roles);
1315             }
1316         }
1317
1318         if (m_grouped && roles.contains(m_model->sortRole())) {
1319             // The sort-role has been changed which might result
1320             // in modified group headers
1321             updateVisibleGroupHeaders();
1322             doLayout(NoAnimation);
1323         }
1324
1325         QAccessibleTableModelChangeEvent ev(this, QAccessibleTableModelChangeEvent::DataChanged);
1326         ev.setFirstRow(itemRange.index);
1327         ev.setLastRow(itemRange.index + itemRange.count);
1328         QAccessible::updateAccessibility(&ev);
1329     }
1330
1331     doLayout(NoAnimation);
1332 }
1333
1334 void KItemListView::slotGroupsChanged()
1335 {
1336     updateVisibleGroupHeaders();
1337     doLayout(NoAnimation);
1338     updateSiblingsInformation();
1339 }
1340
1341 void KItemListView::slotGroupedSortingChanged(bool current)
1342 {
1343     m_grouped = current;
1344     m_layouter->markAsDirty();
1345
1346     if (m_grouped) {
1347         updateGroupHeaderHeight();
1348     } else {
1349         // Clear all visible headers. Note that the QHashIterator takes a copy of
1350         // m_visibleGroups. Therefore, it remains valid even if items are removed
1351         // from m_visibleGroups in recycleGroupHeaderForWidget().
1352         QHashIterator<KItemListWidget *, KItemListGroupHeader *> it(m_visibleGroups);
1353         while (it.hasNext()) {
1354             it.next();
1355             recycleGroupHeaderForWidget(it.key());
1356         }
1357         Q_ASSERT(m_visibleGroups.isEmpty());
1358     }
1359
1360     if (useAlternateBackgrounds()) {
1361         // Changing the group mode requires to update the alternate backgrounds
1362         // as with the enabled group mode the altering is done on base of the first
1363         // group item.
1364         updateAlternateBackgrounds();
1365     }
1366     updateSiblingsInformation();
1367     doLayout(NoAnimation);
1368 }
1369
1370 void KItemListView::slotSortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous)
1371 {
1372     Q_UNUSED(current)
1373     Q_UNUSED(previous)
1374     if (m_grouped) {
1375         updateVisibleGroupHeaders();
1376         doLayout(NoAnimation);
1377     }
1378 }
1379
1380 void KItemListView::slotSortRoleChanged(const QByteArray &current, const QByteArray &previous)
1381 {
1382     Q_UNUSED(current)
1383     Q_UNUSED(previous)
1384     if (m_grouped) {
1385         updateVisibleGroupHeaders();
1386         doLayout(NoAnimation);
1387     }
1388 }
1389
1390 void KItemListView::slotCurrentChanged(int current, int previous)
1391 {
1392     Q_UNUSED(previous)
1393
1394     // In SingleSelection mode (e.g., in the Places Panel), the current item is
1395     // always the selected item. It is not necessary to highlight the current item then.
1396     if (m_controller->selectionBehavior() != KItemListController::SingleSelection) {
1397         KItemListWidget *previousWidget = m_visibleItems.value(previous, nullptr);
1398         if (previousWidget) {
1399             previousWidget->setCurrent(false);
1400         }
1401
1402         KItemListWidget *currentWidget = m_visibleItems.value(current, nullptr);
1403         if (currentWidget) {
1404             currentWidget->setCurrent(true);
1405         }
1406     }
1407
1408     QAccessibleEvent ev(this, QAccessible::Focus);
1409     ev.setChild(current);
1410     QAccessible::updateAccessibility(&ev);
1411 }
1412
1413 void KItemListView::slotSelectionChanged(const KItemSet &current, const KItemSet &previous)
1414 {
1415     Q_UNUSED(previous)
1416
1417     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
1418     while (it.hasNext()) {
1419         it.next();
1420         const int index = it.key();
1421         KItemListWidget *widget = it.value();
1422         widget->setSelected(current.contains(index));
1423     }
1424 }
1425
1426 void KItemListView::slotAnimationFinished(QGraphicsWidget *widget, KItemListViewAnimation::AnimationType type)
1427 {
1428     KItemListWidget *itemListWidget = qobject_cast<KItemListWidget *>(widget);
1429     Q_ASSERT(itemListWidget);
1430
1431     if (type == KItemListViewAnimation::DeleteAnimation) {
1432         // As we recycle the widget in this case it is important to assure that no
1433         // other animation has been started. This is a convention in KItemListView and
1434         // not a requirement defined by KItemListViewAnimation.
1435         Q_ASSERT(!m_animation->isStarted(itemListWidget));
1436
1437         // All KItemListWidgets that are animated by the DeleteAnimation are not maintained
1438         // by m_visibleWidgets and must be deleted manually after the animation has
1439         // been finished.
1440         recycleGroupHeaderForWidget(itemListWidget);
1441         widgetCreator()->recycle(itemListWidget);
1442     } else {
1443         const int index = itemListWidget->index();
1444         const bool invisible = (index < m_layouter->firstVisibleIndex()) || (index > m_layouter->lastVisibleIndex());
1445         if (invisible && !m_animation->isStarted(itemListWidget)) {
1446             recycleWidget(itemListWidget);
1447         }
1448     }
1449 }
1450
1451 void KItemListView::slotRubberBandPosChanged()
1452 {
1453     update();
1454 }
1455
1456 void KItemListView::slotRubberBandActivationChanged(bool active)
1457 {
1458     if (active) {
1459         connect(m_rubberBand, &KItemListRubberBand::startPositionChanged, this, &KItemListView::slotRubberBandPosChanged);
1460         connect(m_rubberBand, &KItemListRubberBand::endPositionChanged, this, &KItemListView::slotRubberBandPosChanged);
1461         m_skipAutoScrollForRubberBand = true;
1462     } else {
1463         QRectF rubberBandRect = QRectF(m_rubberBand->startPosition(), m_rubberBand->endPosition()).normalized();
1464
1465         auto animation = new QVariantAnimation(this);
1466         animation->setStartValue(1.0);
1467         animation->setEndValue(0.0);
1468         animation->setDuration(RubberFadeSpeed);
1469         animation->setProperty(RubberPropertyName, rubberBandRect);
1470
1471         QEasingCurve curve;
1472         curve.setType(QEasingCurve::BezierSpline);
1473         curve.addCubicBezierSegment(QPointF(0.4, 0.0), QPointF(1.0, 1.0), QPointF(1.0, 1.0));
1474         animation->setEasingCurve(curve);
1475
1476         connect(animation, &QVariantAnimation::valueChanged, this, [=](const QVariant &) {
1477             update();
1478         });
1479         connect(animation, &QVariantAnimation::finished, this, [=]() {
1480             m_rubberBandAnimations.removeAll(animation);
1481             delete animation;
1482         });
1483         animation->start();
1484         m_rubberBandAnimations << animation;
1485
1486         disconnect(m_rubberBand, &KItemListRubberBand::startPositionChanged, this, &KItemListView::slotRubberBandPosChanged);
1487         disconnect(m_rubberBand, &KItemListRubberBand::endPositionChanged, this, &KItemListView::slotRubberBandPosChanged);
1488         m_skipAutoScrollForRubberBand = false;
1489     }
1490
1491     update();
1492 }
1493
1494 void KItemListView::slotHeaderColumnWidthChanged(const QByteArray &role, qreal currentWidth, qreal previousWidth)
1495 {
1496     Q_UNUSED(role)
1497     Q_UNUSED(currentWidth)
1498     Q_UNUSED(previousWidth)
1499
1500     m_headerWidget->setAutomaticColumnResizing(false);
1501     applyColumnWidthsFromHeader();
1502     doLayout(NoAnimation);
1503 }
1504
1505 void KItemListView::slotSidePaddingChanged(qreal width)
1506 {
1507     Q_UNUSED(width)
1508     if (m_headerWidget->automaticColumnResizing()) {
1509         applyAutomaticColumnWidths();
1510     }
1511     applyColumnWidthsFromHeader();
1512     doLayout(NoAnimation);
1513 }
1514
1515 void KItemListView::slotHeaderColumnMoved(const QByteArray &role, int currentIndex, int previousIndex)
1516 {
1517     Q_ASSERT(m_visibleRoles[previousIndex] == role);
1518
1519     const QList<QByteArray> previous = m_visibleRoles;
1520
1521     QList<QByteArray> current = m_visibleRoles;
1522     current.removeAt(previousIndex);
1523     current.insert(currentIndex, role);
1524
1525     setVisibleRoles(current);
1526
1527     Q_EMIT visibleRolesChanged(current, previous);
1528 }
1529
1530 void KItemListView::triggerAutoScrolling()
1531 {
1532     if (!m_autoScrollTimer) {
1533         return;
1534     }
1535
1536     int pos = 0;
1537     int visibleSize = 0;
1538     if (scrollOrientation() == Qt::Vertical) {
1539         pos = m_mousePos.y();
1540         visibleSize = size().height();
1541     } else {
1542         pos = m_mousePos.x();
1543         visibleSize = size().width();
1544     }
1545
1546     if (m_autoScrollTimer->interval() == InitialAutoScrollDelay) {
1547         m_autoScrollIncrement = 0;
1548     }
1549
1550     m_autoScrollIncrement = calculateAutoScrollingIncrement(pos, visibleSize, m_autoScrollIncrement);
1551     if (m_autoScrollIncrement == 0) {
1552         // The mouse position is not above an autoscroll margin (the autoscroll timer
1553         // will be restarted in mouseMoveEvent())
1554         m_autoScrollTimer->stop();
1555         return;
1556     }
1557
1558     if (m_rubberBand->isActive() && m_skipAutoScrollForRubberBand) {
1559         // If a rubberband selection is ongoing the autoscrolling may only get triggered
1560         // if the direction of the rubberband is similar to the autoscroll direction. This
1561         // prevents that starting to create a rubberband within the autoscroll margins starts
1562         // an autoscrolling.
1563
1564         const qreal minDiff = 4; // Ignore any autoscrolling if the rubberband is very small
1565         const qreal diff = (scrollOrientation() == Qt::Vertical) ? m_rubberBand->endPosition().y() - m_rubberBand->startPosition().y()
1566                                                                  : m_rubberBand->endPosition().x() - m_rubberBand->startPosition().x();
1567         if (qAbs(diff) < minDiff || (m_autoScrollIncrement < 0 && diff > 0) || (m_autoScrollIncrement > 0 && diff < 0)) {
1568             // The rubberband direction is different from the scroll direction (e.g. the rubberband has
1569             // been moved up although the autoscroll direction might be down)
1570             m_autoScrollTimer->stop();
1571             return;
1572         }
1573     }
1574
1575     // As soon as the autoscrolling has been triggered at least once despite having an active rubberband,
1576     // the autoscrolling may not get skipped anymore until a new rubberband is created
1577     m_skipAutoScrollForRubberBand = false;
1578
1579     const qreal maxVisibleOffset = qMax(qreal(0), maximumScrollOffset() - visibleSize);
1580     const qreal newScrollOffset = qMin(scrollOffset() + m_autoScrollIncrement, maxVisibleOffset);
1581     setScrollOffset(newScrollOffset);
1582
1583     // Trigger the autoscroll timer which will periodically call
1584     // triggerAutoScrolling()
1585     m_autoScrollTimer->start(RepeatingAutoScrollDelay);
1586 }
1587
1588 void KItemListView::slotGeometryOfGroupHeaderParentChanged()
1589 {
1590     KItemListWidget *widget = qobject_cast<KItemListWidget *>(sender());
1591     Q_ASSERT(widget);
1592     KItemListGroupHeader *groupHeader = m_visibleGroups.value(widget);
1593     Q_ASSERT(groupHeader);
1594     updateGroupHeaderLayout(widget);
1595 }
1596
1597 void KItemListView::slotRoleEditingCanceled(int index, const QByteArray &role, const QVariant &value)
1598 {
1599     disconnectRoleEditingSignals(index);
1600
1601     m_editingRole = false;
1602     Q_EMIT roleEditingCanceled(index, role, value);
1603 }
1604
1605 void KItemListView::slotRoleEditingFinished(int index, const QByteArray &role, const QVariant &value)
1606 {
1607     disconnectRoleEditingSignals(index);
1608
1609     m_editingRole = false;
1610     Q_EMIT roleEditingFinished(index, role, value);
1611 }
1612
1613 void KItemListView::setController(KItemListController *controller)
1614 {
1615     if (m_controller != controller) {
1616         KItemListController *previous = m_controller;
1617         if (previous) {
1618             KItemListSelectionManager *selectionManager = previous->selectionManager();
1619             disconnect(selectionManager, &KItemListSelectionManager::currentChanged, this, &KItemListView::slotCurrentChanged);
1620             disconnect(selectionManager, &KItemListSelectionManager::selectionChanged, this, &KItemListView::slotSelectionChanged);
1621         }
1622
1623         m_controller = controller;
1624
1625         if (controller) {
1626             KItemListSelectionManager *selectionManager = controller->selectionManager();
1627             connect(selectionManager, &KItemListSelectionManager::currentChanged, this, &KItemListView::slotCurrentChanged);
1628             connect(selectionManager, &KItemListSelectionManager::selectionChanged, this, &KItemListView::slotSelectionChanged);
1629         }
1630
1631         onControllerChanged(controller, previous);
1632     }
1633 }
1634
1635 void KItemListView::setModel(KItemModelBase *model)
1636 {
1637     if (m_model == model) {
1638         return;
1639     }
1640
1641     KItemModelBase *previous = m_model;
1642
1643     if (m_model) {
1644         disconnect(m_model, &KItemModelBase::itemsChanged, this, &KItemListView::slotItemsChanged);
1645         disconnect(m_model, &KItemModelBase::itemsInserted, this, &KItemListView::slotItemsInserted);
1646         disconnect(m_model, &KItemModelBase::itemsRemoved, this, &KItemListView::slotItemsRemoved);
1647         disconnect(m_model, &KItemModelBase::itemsMoved, this, &KItemListView::slotItemsMoved);
1648         disconnect(m_model, &KItemModelBase::groupsChanged, this, &KItemListView::slotGroupsChanged);
1649         disconnect(m_model, &KItemModelBase::groupedSortingChanged, this, &KItemListView::slotGroupedSortingChanged);
1650         disconnect(m_model, &KItemModelBase::sortOrderChanged, this, &KItemListView::slotSortOrderChanged);
1651         disconnect(m_model, &KItemModelBase::sortRoleChanged, this, &KItemListView::slotSortRoleChanged);
1652
1653         m_sizeHintResolver->itemsRemoved(KItemRangeList() << KItemRange(0, m_model->count()));
1654     }
1655
1656     m_model = model;
1657     m_layouter->setModel(model);
1658     m_grouped = model->groupedSorting();
1659
1660     if (m_model) {
1661         connect(m_model, &KItemModelBase::itemsChanged, this, &KItemListView::slotItemsChanged);
1662         connect(m_model, &KItemModelBase::itemsInserted, this, &KItemListView::slotItemsInserted);
1663         connect(m_model, &KItemModelBase::itemsRemoved, this, &KItemListView::slotItemsRemoved);
1664         connect(m_model, &KItemModelBase::itemsMoved, this, &KItemListView::slotItemsMoved);
1665         connect(m_model, &KItemModelBase::groupsChanged, this, &KItemListView::slotGroupsChanged);
1666         connect(m_model, &KItemModelBase::groupedSortingChanged, this, &KItemListView::slotGroupedSortingChanged);
1667         connect(m_model, &KItemModelBase::sortOrderChanged, this, &KItemListView::slotSortOrderChanged);
1668         connect(m_model, &KItemModelBase::sortRoleChanged, this, &KItemListView::slotSortRoleChanged);
1669
1670         const int itemCount = m_model->count();
1671         if (itemCount > 0) {
1672             slotItemsInserted(KItemRangeList() << KItemRange(0, itemCount));
1673         }
1674     }
1675
1676     onModelChanged(model, previous);
1677 }
1678
1679 KItemListRubberBand *KItemListView::rubberBand() const
1680 {
1681     return m_rubberBand;
1682 }
1683
1684 void KItemListView::doLayout(LayoutAnimationHint hint, int changedIndex, int changedCount)
1685 {
1686     if (m_activeTransactions > 0) {
1687         if (hint == NoAnimation) {
1688             // As soon as at least one property change should be done without animation,
1689             // the whole transaction will be marked as not animated.
1690             m_endTransactionAnimationHint = NoAnimation;
1691         }
1692         return;
1693     }
1694
1695     if (!m_model || m_model->count() < 0) {
1696         return;
1697     }
1698
1699     int firstVisibleIndex = m_layouter->firstVisibleIndex();
1700     if (firstVisibleIndex < 0) {
1701         emitOffsetChanges();
1702         return;
1703     }
1704
1705     // Do a sanity check of the scroll-offset property: When properties of the itemlist-view have been changed
1706     // it might be possible that the maximum offset got changed too. Assure that the full visible range
1707     // is still shown if the maximum offset got decreased.
1708     const qreal visibleOffsetRange = (scrollOrientation() == Qt::Horizontal) ? size().width() : size().height();
1709     const qreal maxOffsetToShowFullRange = maximumScrollOffset() - visibleOffsetRange;
1710     if (scrollOffset() > maxOffsetToShowFullRange) {
1711         m_layouter->setScrollOffset(qMax(qreal(0), maxOffsetToShowFullRange));
1712         firstVisibleIndex = m_layouter->firstVisibleIndex();
1713     }
1714
1715     const int lastVisibleIndex = m_layouter->lastVisibleIndex();
1716
1717     int firstSibblingIndex = -1;
1718     int lastSibblingIndex = -1;
1719     const bool supportsExpanding = supportsItemExpanding();
1720
1721     QList<int> reusableItems = recycleInvisibleItems(firstVisibleIndex, lastVisibleIndex, hint);
1722
1723     // Assure that for each visible item a KItemListWidget is available. KItemListWidget
1724     // instances from invisible items are reused. If no reusable items are
1725     // found then new KItemListWidget instances get created.
1726     const bool animate = (hint == Animation);
1727     for (int i = firstVisibleIndex; i <= lastVisibleIndex; ++i) {
1728         bool applyNewPos = true;
1729
1730         const QRectF itemBounds = m_layouter->itemRect(i);
1731         const QPointF newPos = itemBounds.topLeft();
1732         KItemListWidget *widget = m_visibleItems.value(i);
1733         if (!widget) {
1734             if (!reusableItems.isEmpty()) {
1735                 // Reuse a KItemListWidget instance from an invisible item
1736                 const int oldIndex = reusableItems.takeLast();
1737                 widget = m_visibleItems.value(oldIndex);
1738                 setWidgetIndex(widget, i);
1739                 updateWidgetProperties(widget, i);
1740                 initializeItemListWidget(widget);
1741             } else {
1742                 // No reusable KItemListWidget instance is available, create a new one
1743                 widget = createWidget(i);
1744             }
1745             widget->resize(itemBounds.size());
1746
1747             if (animate && changedCount < 0) {
1748                 // Items have been deleted.
1749                 if (i >= changedIndex) {
1750                     // The item is located behind the removed range. Move the
1751                     // created item to the imaginary old position outside the
1752                     // view. It will get animated to the new position later.
1753                     const int previousIndex = i - changedCount;
1754                     const QRectF itemRect = m_layouter->itemRect(previousIndex);
1755                     if (itemRect.isEmpty()) {
1756                         const QPointF invisibleOldPos = (scrollOrientation() == Qt::Vertical) ? QPointF(0, size().height()) : QPointF(size().width(), 0);
1757                         widget->setPos(invisibleOldPos);
1758                     } else {
1759                         widget->setPos(itemRect.topLeft());
1760                     }
1761                     applyNewPos = false;
1762                 }
1763             }
1764
1765             if (supportsExpanding && changedCount == 0) {
1766                 if (firstSibblingIndex < 0) {
1767                     firstSibblingIndex = i;
1768                 }
1769                 lastSibblingIndex = i;
1770             }
1771         }
1772
1773         if (animate) {
1774             if (m_animation->isStarted(widget, KItemListViewAnimation::MovingAnimation)) {
1775                 m_animation->start(widget, KItemListViewAnimation::MovingAnimation, newPos);
1776                 applyNewPos = false;
1777             }
1778
1779             const bool itemsRemoved = (changedCount < 0);
1780             const bool itemsInserted = (changedCount > 0);
1781             if (itemsRemoved && (i >= changedIndex)) {
1782                 // The item is located after the removed items. Animate the moving of the position.
1783                 applyNewPos = !moveWidget(widget, newPos);
1784             } else if (itemsInserted && i >= changedIndex) {
1785                 // The item is located after the first inserted item
1786                 if (i <= changedIndex + changedCount - 1) {
1787                     // The item is an inserted item. Animate the appearing of the item.
1788                     // For performance reasons no animation is done when changedCount is equal
1789                     // to all available items.
1790                     if (changedCount < m_model->count()) {
1791                         m_animation->start(widget, KItemListViewAnimation::CreateAnimation);
1792                     }
1793                 } else if (!m_animation->isStarted(widget, KItemListViewAnimation::CreateAnimation)) {
1794                     // The item was already there before, so animate the moving of the position.
1795                     // No moving animation is done if the item is animated by a create animation: This
1796                     // prevents a "move animation mess" when inserting several ranges in parallel.
1797                     applyNewPos = !moveWidget(widget, newPos);
1798                 }
1799             }
1800         } else {
1801             m_animation->stop(widget);
1802         }
1803
1804         if (applyNewPos) {
1805             widget->setPos(newPos);
1806         }
1807
1808         Q_ASSERT(widget->index() == i);
1809         widget->setVisible(true);
1810
1811         bool animateIconResizing = animate;
1812
1813         if (widget->size() != itemBounds.size()) {
1814             // Resize the widget for the item to the changed size.
1815             if (animate) {
1816                 // If a dynamic item size is used then no animation is done in the direction
1817                 // of the dynamic size.
1818                 if (m_itemSize.width() <= 0) {
1819                     // The width is dynamic, apply the new width without animation.
1820                     widget->resize(itemBounds.width(), widget->size().height());
1821                 } else if (m_itemSize.height() <= 0) {
1822                     // The height is dynamic, apply the new height without animation.
1823                     widget->resize(widget->size().width(), itemBounds.height());
1824                 }
1825                 m_animation->start(widget, KItemListViewAnimation::ResizeAnimation, itemBounds.size());
1826             } else {
1827                 widget->resize(itemBounds.size());
1828             }
1829         } else {
1830             animateIconResizing = false;
1831         }
1832
1833         const int newIconSize = widget->styleOption().iconSize;
1834         if (widget->iconSize() != newIconSize) {
1835             if (animateIconResizing) {
1836                 m_animation->start(widget, KItemListViewAnimation::IconResizeAnimation, newIconSize);
1837             } else {
1838                 widget->setIconSize(newIconSize);
1839             }
1840         }
1841
1842         // Updating the cell-information must be done as last step: The decision whether the
1843         // moving-animation should be started at all is based on the previous cell-information.
1844         const Cell cell(m_layouter->itemColumn(i), m_layouter->itemRow(i));
1845         m_visibleCells.insert(i, cell);
1846     }
1847
1848     // Delete invisible KItemListWidget instances that have not been reused
1849     for (int index : qAsConst(reusableItems)) {
1850         recycleWidget(m_visibleItems.value(index));
1851     }
1852
1853     if (supportsExpanding && firstSibblingIndex >= 0) {
1854         Q_ASSERT(lastSibblingIndex >= 0);
1855         updateSiblingsInformation(firstSibblingIndex, lastSibblingIndex);
1856     }
1857
1858     if (m_grouped) {
1859         // Update the layout of all visible group headers
1860         QHashIterator<KItemListWidget *, KItemListGroupHeader *> it(m_visibleGroups);
1861         while (it.hasNext()) {
1862             it.next();
1863             updateGroupHeaderLayout(it.key());
1864         }
1865     }
1866
1867     emitOffsetChanges();
1868 }
1869
1870 QList<int> KItemListView::recycleInvisibleItems(int firstVisibleIndex, int lastVisibleIndex, LayoutAnimationHint hint)
1871 {
1872     // Determine all items that are completely invisible and might be
1873     // reused for items that just got (at least partly) visible. If the
1874     // animation hint is set to 'Animation' items that do e.g. an animated
1875     // moving of their position are not marked as invisible: This assures
1876     // that a scrolling inside the view can be done without breaking an animation.
1877
1878     QList<int> items;
1879
1880     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
1881     while (it.hasNext()) {
1882         it.next();
1883
1884         KItemListWidget *widget = it.value();
1885         const int index = widget->index();
1886         const bool invisible = (index < firstVisibleIndex) || (index > lastVisibleIndex);
1887
1888         if (invisible) {
1889             if (m_animation->isStarted(widget)) {
1890                 if (hint == NoAnimation) {
1891                     // Stopping the animation will call KItemListView::slotAnimationFinished()
1892                     // and the widget will be recycled if necessary there.
1893                     m_animation->stop(widget);
1894                 }
1895             } else {
1896                 widget->setVisible(false);
1897                 items.append(index);
1898
1899                 if (m_grouped) {
1900                     recycleGroupHeaderForWidget(widget);
1901                 }
1902             }
1903         }
1904     }
1905
1906     return items;
1907 }
1908
1909 bool KItemListView::moveWidget(KItemListWidget *widget, const QPointF &newPos)
1910 {
1911     if (widget->pos() == newPos) {
1912         return false;
1913     }
1914
1915     bool startMovingAnim = false;
1916
1917     if (m_itemSize.isEmpty()) {
1918         // The items are not aligned in a grid but either as columns or rows.
1919         startMovingAnim = true;
1920     } else {
1921         // When having a grid the moving-animation should only be started, if it is done within
1922         // one row in the vertical scroll-orientation or one column in the horizontal scroll-orientation.
1923         // Otherwise instead of a moving-animation a create-animation on the new position will be used
1924         // instead. This is done to prevent overlapping (and confusing) moving-animations.
1925         const int index = widget->index();
1926         const Cell cell = m_visibleCells.value(index);
1927         if (cell.column >= 0 && cell.row >= 0) {
1928             if (scrollOrientation() == Qt::Vertical) {
1929                 startMovingAnim = (cell.row == m_layouter->itemRow(index));
1930             } else {
1931                 startMovingAnim = (cell.column == m_layouter->itemColumn(index));
1932             }
1933         }
1934     }
1935
1936     if (startMovingAnim) {
1937         m_animation->start(widget, KItemListViewAnimation::MovingAnimation, newPos);
1938         return true;
1939     }
1940
1941     m_animation->stop(widget);
1942     m_animation->start(widget, KItemListViewAnimation::CreateAnimation);
1943     return false;
1944 }
1945
1946 void KItemListView::emitOffsetChanges()
1947 {
1948     const qreal newScrollOffset = m_layouter->scrollOffset();
1949     if (m_oldScrollOffset != newScrollOffset) {
1950         Q_EMIT scrollOffsetChanged(newScrollOffset, m_oldScrollOffset);
1951         m_oldScrollOffset = newScrollOffset;
1952     }
1953
1954     const qreal newMaximumScrollOffset = m_layouter->maximumScrollOffset();
1955     if (m_oldMaximumScrollOffset != newMaximumScrollOffset) {
1956         Q_EMIT maximumScrollOffsetChanged(newMaximumScrollOffset, m_oldMaximumScrollOffset);
1957         m_oldMaximumScrollOffset = newMaximumScrollOffset;
1958     }
1959
1960     const qreal newItemOffset = m_layouter->itemOffset();
1961     if (m_oldItemOffset != newItemOffset) {
1962         Q_EMIT itemOffsetChanged(newItemOffset, m_oldItemOffset);
1963         m_oldItemOffset = newItemOffset;
1964     }
1965
1966     const qreal newMaximumItemOffset = m_layouter->maximumItemOffset();
1967     if (m_oldMaximumItemOffset != newMaximumItemOffset) {
1968         Q_EMIT maximumItemOffsetChanged(newMaximumItemOffset, m_oldMaximumItemOffset);
1969         m_oldMaximumItemOffset = newMaximumItemOffset;
1970     }
1971 }
1972
1973 KItemListWidget *KItemListView::createWidget(int index)
1974 {
1975     KItemListWidget *widget = widgetCreator()->create(this);
1976     widget->setFlag(QGraphicsItem::ItemStacksBehindParent);
1977
1978     m_visibleItems.insert(index, widget);
1979     m_visibleCells.insert(index, Cell());
1980     updateWidgetProperties(widget, index);
1981     initializeItemListWidget(widget);
1982     return widget;
1983 }
1984
1985 void KItemListView::recycleWidget(KItemListWidget *widget)
1986 {
1987     if (m_grouped) {
1988         recycleGroupHeaderForWidget(widget);
1989     }
1990
1991     const int index = widget->index();
1992     m_visibleItems.remove(index);
1993     m_visibleCells.remove(index);
1994
1995     widgetCreator()->recycle(widget);
1996 }
1997
1998 void KItemListView::setWidgetIndex(KItemListWidget *widget, int index)
1999 {
2000     const int oldIndex = widget->index();
2001     m_visibleItems.remove(oldIndex);
2002     m_visibleCells.remove(oldIndex);
2003
2004     m_visibleItems.insert(index, widget);
2005     m_visibleCells.insert(index, Cell());
2006
2007     widget->setIndex(index);
2008 }
2009
2010 void KItemListView::moveWidgetToIndex(KItemListWidget *widget, int index)
2011 {
2012     const int oldIndex = widget->index();
2013     const Cell oldCell = m_visibleCells.value(oldIndex);
2014
2015     setWidgetIndex(widget, index);
2016
2017     const Cell newCell(m_layouter->itemColumn(index), m_layouter->itemRow(index));
2018     const bool vertical = (scrollOrientation() == Qt::Vertical);
2019     const bool updateCell = (vertical && oldCell.row == newCell.row) || (!vertical && oldCell.column == newCell.column);
2020     if (updateCell) {
2021         m_visibleCells.insert(index, newCell);
2022     }
2023 }
2024
2025 void KItemListView::setLayouterSize(const QSizeF &size, SizeType sizeType)
2026 {
2027     switch (sizeType) {
2028     case LayouterSize:
2029         m_layouter->setSize(size);
2030         break;
2031     case ItemSize:
2032         m_layouter->setItemSize(size);
2033         break;
2034     default:
2035         break;
2036     }
2037 }
2038
2039 void KItemListView::updateWidgetProperties(KItemListWidget *widget, int index)
2040 {
2041     widget->setVisibleRoles(m_visibleRoles);
2042     updateWidgetColumnWidths(widget);
2043     widget->setStyleOption(m_styleOption);
2044
2045     const KItemListSelectionManager *selectionManager = m_controller->selectionManager();
2046
2047     // In SingleSelection mode (e.g., in the Places Panel), the current item is
2048     // always the selected item. It is not necessary to highlight the current item then.
2049     if (m_controller->selectionBehavior() != KItemListController::SingleSelection) {
2050         widget->setCurrent(index == selectionManager->currentItem());
2051     }
2052     widget->setSelected(selectionManager->isSelected(index));
2053     widget->setHovered(false);
2054     widget->setEnabledSelectionToggle(enabledSelectionToggles());
2055     widget->setIndex(index);
2056     widget->setData(m_model->data(index));
2057     widget->setSiblingsInformation(QBitArray());
2058     updateAlternateBackgroundForWidget(widget);
2059
2060     if (m_grouped) {
2061         updateGroupHeaderForWidget(widget);
2062     }
2063 }
2064
2065 void KItemListView::updateGroupHeaderForWidget(KItemListWidget *widget)
2066 {
2067     Q_ASSERT(m_grouped);
2068
2069     const int index = widget->index();
2070     if (!m_layouter->isFirstGroupItem(index)) {
2071         // The widget does not represent the first item of a group
2072         // and hence requires no header
2073         recycleGroupHeaderForWidget(widget);
2074         return;
2075     }
2076
2077     const QList<QPair<int, QVariant>> groups = model()->groups();
2078     if (groups.isEmpty() || !groupHeaderCreator()) {
2079         return;
2080     }
2081
2082     KItemListGroupHeader *groupHeader = m_visibleGroups.value(widget);
2083     if (!groupHeader) {
2084         groupHeader = groupHeaderCreator()->create(this);
2085         groupHeader->setParentItem(widget);
2086         m_visibleGroups.insert(widget, groupHeader);
2087         connect(widget, &KItemListWidget::geometryChanged, this, &KItemListView::slotGeometryOfGroupHeaderParentChanged);
2088     }
2089     Q_ASSERT(groupHeader->parentItem() == widget);
2090
2091     const int groupIndex = groupIndexForItem(index);
2092     Q_ASSERT(groupIndex >= 0);
2093     groupHeader->setData(groups.at(groupIndex).second);
2094     groupHeader->setRole(model()->sortRole());
2095     groupHeader->setStyleOption(m_styleOption);
2096     groupHeader->setScrollOrientation(scrollOrientation());
2097     groupHeader->setItemIndex(index);
2098
2099     groupHeader->show();
2100 }
2101
2102 void KItemListView::updateGroupHeaderLayout(KItemListWidget *widget)
2103 {
2104     KItemListGroupHeader *groupHeader = m_visibleGroups.value(widget);
2105     Q_ASSERT(groupHeader);
2106
2107     const int index = widget->index();
2108     const QRectF groupHeaderRect = m_layouter->groupHeaderRect(index);
2109     const QRectF itemRect = m_layouter->itemRect(index);
2110
2111     // The group-header is a child of the itemlist widget. Translate the
2112     // group header position to the relative position.
2113     if (scrollOrientation() == Qt::Vertical) {
2114         // In the vertical scroll orientation the group header should always span
2115         // the whole width no matter which temporary position the parent widget
2116         // has. In this case the x-position and width will be adjusted manually.
2117         const qreal x = -widget->x() - itemOffset();
2118         const qreal width = maximumItemOffset();
2119         groupHeader->setPos(x, -groupHeaderRect.height());
2120         groupHeader->resize(width, groupHeaderRect.size().height());
2121     } else {
2122         groupHeader->setPos(groupHeaderRect.x() - itemRect.x(), -widget->y());
2123         groupHeader->resize(groupHeaderRect.size());
2124     }
2125 }
2126
2127 void KItemListView::recycleGroupHeaderForWidget(KItemListWidget *widget)
2128 {
2129     KItemListGroupHeader *header = m_visibleGroups.value(widget);
2130     if (header) {
2131         header->setParentItem(nullptr);
2132         groupHeaderCreator()->recycle(header);
2133         m_visibleGroups.remove(widget);
2134         disconnect(widget, &KItemListWidget::geometryChanged, this, &KItemListView::slotGeometryOfGroupHeaderParentChanged);
2135     }
2136 }
2137
2138 void KItemListView::updateVisibleGroupHeaders()
2139 {
2140     Q_ASSERT(m_grouped);
2141     m_layouter->markAsDirty();
2142
2143     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
2144     while (it.hasNext()) {
2145         it.next();
2146         updateGroupHeaderForWidget(it.value());
2147     }
2148 }
2149
2150 int KItemListView::groupIndexForItem(int index) const
2151 {
2152     Q_ASSERT(m_grouped);
2153
2154     const QList<QPair<int, QVariant>> groups = model()->groups();
2155     if (groups.isEmpty()) {
2156         return -1;
2157     }
2158
2159     int min = 0;
2160     int max = groups.count() - 1;
2161     int mid = 0;
2162     do {
2163         mid = (min + max) / 2;
2164         if (index > groups[mid].first) {
2165             min = mid + 1;
2166         } else {
2167             max = mid - 1;
2168         }
2169     } while (groups[mid].first != index && min <= max);
2170
2171     if (min > max) {
2172         while (groups[mid].first > index && mid > 0) {
2173             --mid;
2174         }
2175     }
2176
2177     return mid;
2178 }
2179
2180 void KItemListView::updateAlternateBackgrounds()
2181 {
2182     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
2183     while (it.hasNext()) {
2184         it.next();
2185         updateAlternateBackgroundForWidget(it.value());
2186     }
2187 }
2188
2189 void KItemListView::updateAlternateBackgroundForWidget(KItemListWidget *widget)
2190 {
2191     bool enabled = useAlternateBackgrounds();
2192     if (enabled) {
2193         const int index = widget->index();
2194         enabled = (index & 0x1) > 0;
2195         if (m_grouped) {
2196             const int groupIndex = groupIndexForItem(index);
2197             if (groupIndex >= 0) {
2198                 const QList<QPair<int, QVariant>> groups = model()->groups();
2199                 const int indexOfFirstGroupItem = groups[groupIndex].first;
2200                 const int relativeIndex = index - indexOfFirstGroupItem;
2201                 enabled = (relativeIndex & 0x1) > 0;
2202             }
2203         }
2204     }
2205     widget->setAlternateBackground(enabled);
2206 }
2207
2208 bool KItemListView::useAlternateBackgrounds() const
2209 {
2210     return m_alternateBackgrounds && m_itemSize.isEmpty();
2211 }
2212
2213 QHash<QByteArray, qreal> KItemListView::preferredColumnWidths(const KItemRangeList &itemRanges) const
2214 {
2215     QElapsedTimer timer;
2216     timer.start();
2217
2218     QHash<QByteArray, qreal> widths;
2219
2220     // Calculate the minimum width for each column that is required
2221     // to show the headline unclipped.
2222     const QFontMetricsF fontMetrics(m_headerWidget->font());
2223     const int gripMargin = m_headerWidget->style()->pixelMetric(QStyle::PM_HeaderGripMargin);
2224     const int headerMargin = m_headerWidget->style()->pixelMetric(QStyle::PM_HeaderMargin);
2225     for (const QByteArray &visibleRole : qAsConst(m_visibleRoles)) {
2226         const QString headerText = m_model->roleDescription(visibleRole);
2227         const qreal headerWidth = fontMetrics.horizontalAdvance(headerText) + gripMargin + headerMargin * 2;
2228         widths.insert(visibleRole, headerWidth);
2229     }
2230
2231     // Calculate the preferred column widths for each item and ignore values
2232     // smaller than the width for showing the headline unclipped.
2233     const KItemListWidgetCreatorBase *creator = widgetCreator();
2234     int calculatedItemCount = 0;
2235     bool maxTimeExceeded = false;
2236     for (const KItemRange &itemRange : itemRanges) {
2237         const int startIndex = itemRange.index;
2238         const int endIndex = startIndex + itemRange.count - 1;
2239
2240         for (int i = startIndex; i <= endIndex; ++i) {
2241             for (const QByteArray &visibleRole : qAsConst(m_visibleRoles)) {
2242                 qreal maxWidth = widths.value(visibleRole, 0);
2243                 const qreal width = creator->preferredRoleColumnWidth(visibleRole, i, this);
2244                 maxWidth = qMax(width, maxWidth);
2245                 widths.insert(visibleRole, maxWidth);
2246             }
2247
2248             if (calculatedItemCount > 100 && timer.elapsed() > 200) {
2249                 // When having several thousands of items calculating the sizes can get
2250                 // very expensive. We accept a possibly too small role-size in favour
2251                 // of having no blocking user interface.
2252                 maxTimeExceeded = true;
2253                 break;
2254             }
2255             ++calculatedItemCount;
2256         }
2257         if (maxTimeExceeded) {
2258             break;
2259         }
2260     }
2261
2262     return widths;
2263 }
2264
2265 void KItemListView::applyColumnWidthsFromHeader()
2266 {
2267     // Apply the new size to the layouter
2268     const qreal requiredWidth = columnWidthsSum() + m_headerWidget->sidePadding();
2269     const QSizeF dynamicItemSize(qMax(size().width(), requiredWidth), m_itemSize.height());
2270     m_layouter->setItemSize(dynamicItemSize);
2271
2272     // Update the role sizes for all visible widgets
2273     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
2274     while (it.hasNext()) {
2275         it.next();
2276         updateWidgetColumnWidths(it.value());
2277     }
2278 }
2279
2280 void KItemListView::updateWidgetColumnWidths(KItemListWidget *widget)
2281 {
2282     for (const QByteArray &role : qAsConst(m_visibleRoles)) {
2283         widget->setColumnWidth(role, m_headerWidget->columnWidth(role));
2284     }
2285     widget->setSidePadding(m_headerWidget->sidePadding());
2286 }
2287
2288 void KItemListView::updatePreferredColumnWidths(const KItemRangeList &itemRanges)
2289 {
2290     Q_ASSERT(m_itemSize.isEmpty());
2291     const int itemCount = m_model->count();
2292     int rangesItemCount = 0;
2293     for (const KItemRange &range : itemRanges) {
2294         rangesItemCount += range.count;
2295     }
2296
2297     if (itemCount == rangesItemCount) {
2298         const QHash<QByteArray, qreal> preferredWidths = preferredColumnWidths(itemRanges);
2299         for (const QByteArray &role : qAsConst(m_visibleRoles)) {
2300             m_headerWidget->setPreferredColumnWidth(role, preferredWidths.value(role));
2301         }
2302     } else {
2303         // Only a sub range of the roles need to be determined.
2304         // The chances are good that the widths of the sub ranges
2305         // already fit into the available widths and hence no
2306         // expensive update might be required.
2307         bool changed = false;
2308
2309         const QHash<QByteArray, qreal> updatedWidths = preferredColumnWidths(itemRanges);
2310         QHashIterator<QByteArray, qreal> it(updatedWidths);
2311         while (it.hasNext()) {
2312             it.next();
2313             const QByteArray &role = it.key();
2314             const qreal updatedWidth = it.value();
2315             const qreal currentWidth = m_headerWidget->preferredColumnWidth(role);
2316             if (updatedWidth > currentWidth) {
2317                 m_headerWidget->setPreferredColumnWidth(role, updatedWidth);
2318                 changed = true;
2319             }
2320         }
2321
2322         if (!changed) {
2323             // All the updated sizes are smaller than the current sizes and no change
2324             // of the stretched roles-widths is required
2325             return;
2326         }
2327     }
2328
2329     if (m_headerWidget->automaticColumnResizing()) {
2330         applyAutomaticColumnWidths();
2331     }
2332 }
2333
2334 void KItemListView::updatePreferredColumnWidths()
2335 {
2336     if (m_model) {
2337         updatePreferredColumnWidths(KItemRangeList() << KItemRange(0, m_model->count()));
2338     }
2339 }
2340
2341 void KItemListView::applyAutomaticColumnWidths()
2342 {
2343     Q_ASSERT(m_itemSize.isEmpty());
2344     Q_ASSERT(m_headerWidget->automaticColumnResizing());
2345     if (m_visibleRoles.isEmpty()) {
2346         return;
2347     }
2348
2349     // Calculate the maximum size of an item by considering the
2350     // visible role sizes and apply them to the layouter. If the
2351     // size does not use the available view-size the size of the
2352     // first role will get stretched.
2353
2354     for (const QByteArray &role : qAsConst(m_visibleRoles)) {
2355         const qreal preferredWidth = m_headerWidget->preferredColumnWidth(role);
2356         m_headerWidget->setColumnWidth(role, preferredWidth);
2357     }
2358
2359     const QByteArray firstRole = m_visibleRoles.first();
2360     qreal firstColumnWidth = m_headerWidget->columnWidth(firstRole);
2361     QSizeF dynamicItemSize = m_itemSize;
2362
2363     qreal requiredWidth = columnWidthsSum() + m_headerWidget->sidePadding()
2364         + m_headerWidget->sidePadding(); // Adding the padding a second time so we have the same padding symmetrically on both sides of the view.
2365     // This improves UX, looks better and increases the chances of users figuring out that the padding area can be used for deselecting and dropping files.
2366     const qreal availableWidth = size().width();
2367     if (requiredWidth < availableWidth) {
2368         // Stretch the first column to use the whole remaining width
2369         firstColumnWidth += availableWidth - requiredWidth;
2370         m_headerWidget->setColumnWidth(firstRole, firstColumnWidth);
2371     } else if (requiredWidth > availableWidth && m_visibleRoles.count() > 1) {
2372         // Shrink the first column to be able to show as much other
2373         // columns as possible
2374         qreal shrinkedFirstColumnWidth = firstColumnWidth - requiredWidth + availableWidth;
2375
2376         // TODO: A proper calculation of the minimum width depends on the implementation
2377         // of KItemListWidget. Probably a kind of minimum size-hint should be introduced
2378         // later.
2379         const qreal minWidth = qMin(firstColumnWidth, qreal(m_styleOption.iconSize * 2 + 200));
2380         if (shrinkedFirstColumnWidth < minWidth) {
2381             shrinkedFirstColumnWidth = minWidth;
2382         }
2383
2384         m_headerWidget->setColumnWidth(firstRole, shrinkedFirstColumnWidth);
2385         requiredWidth -= firstColumnWidth - shrinkedFirstColumnWidth;
2386     }
2387
2388     dynamicItemSize.rwidth() = qMax(requiredWidth, availableWidth);
2389
2390     m_layouter->setItemSize(dynamicItemSize);
2391
2392     // Update the role sizes for all visible widgets
2393     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
2394     while (it.hasNext()) {
2395         it.next();
2396         updateWidgetColumnWidths(it.value());
2397     }
2398 }
2399
2400 qreal KItemListView::columnWidthsSum() const
2401 {
2402     qreal widthsSum = 0;
2403     for (const QByteArray &role : qAsConst(m_visibleRoles)) {
2404         widthsSum += m_headerWidget->columnWidth(role);
2405     }
2406     return widthsSum;
2407 }
2408
2409 QRectF KItemListView::headerBoundaries() const
2410 {
2411     return m_headerWidget->isVisible() ? m_headerWidget->geometry() : QRectF();
2412 }
2413
2414 bool KItemListView::changesItemGridLayout(const QSizeF &newGridSize, const QSizeF &newItemSize, const QSizeF &newItemMargin) const
2415 {
2416     if (newItemSize.isEmpty() || newGridSize.isEmpty()) {
2417         return false;
2418     }
2419
2420     if (m_layouter->scrollOrientation() == Qt::Vertical) {
2421         const qreal itemWidth = m_layouter->itemSize().width();
2422         if (itemWidth > 0) {
2423             const int newColumnCount = itemsPerSize(newGridSize.width(), newItemSize.width(), newItemMargin.width());
2424             if (m_model->count() > newColumnCount) {
2425                 const int oldColumnCount = itemsPerSize(m_layouter->size().width(), itemWidth, m_layouter->itemMargin().width());
2426                 return oldColumnCount != newColumnCount;
2427             }
2428         }
2429     } else {
2430         const qreal itemHeight = m_layouter->itemSize().height();
2431         if (itemHeight > 0) {
2432             const int newRowCount = itemsPerSize(newGridSize.height(), newItemSize.height(), newItemMargin.height());
2433             if (m_model->count() > newRowCount) {
2434                 const int oldRowCount = itemsPerSize(m_layouter->size().height(), itemHeight, m_layouter->itemMargin().height());
2435                 return oldRowCount != newRowCount;
2436             }
2437         }
2438     }
2439
2440     return false;
2441 }
2442
2443 bool KItemListView::animateChangedItemCount(int changedItemCount) const
2444 {
2445     if (m_itemSize.isEmpty()) {
2446         // We have only columns or only rows, but no grid: An animation is usually
2447         // welcome when inserting or removing items.
2448         return !supportsItemExpanding();
2449     }
2450
2451     if (m_layouter->size().isEmpty() || m_layouter->itemSize().isEmpty()) {
2452         return false;
2453     }
2454
2455     const int maximum = (scrollOrientation() == Qt::Vertical) ? m_layouter->size().width() / m_layouter->itemSize().width()
2456                                                               : m_layouter->size().height() / m_layouter->itemSize().height();
2457     // Only animate if up to 2/3 of a row or column are inserted or removed
2458     return changedItemCount <= maximum * 2 / 3;
2459 }
2460
2461 bool KItemListView::scrollBarRequired(const QSizeF &size) const
2462 {
2463     const QSizeF oldSize = m_layouter->size();
2464
2465     m_layouter->setSize(size);
2466     const qreal maxOffset = m_layouter->maximumScrollOffset();
2467     m_layouter->setSize(oldSize);
2468
2469     return m_layouter->scrollOrientation() == Qt::Vertical ? maxOffset > size.height() : maxOffset > size.width();
2470 }
2471
2472 int KItemListView::showDropIndicator(const QPointF &pos)
2473 {
2474     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
2475     while (it.hasNext()) {
2476         it.next();
2477         const KItemListWidget *widget = it.value();
2478
2479         const QPointF mappedPos = widget->mapFromItem(this, pos);
2480         const QRectF rect = itemRect(widget->index());
2481         if (mappedPos.y() >= 0 && mappedPos.y() <= rect.height()) {
2482             if (m_model->supportsDropping(widget->index())) {
2483                 // Keep 30% of the rectangle as the gap instead of always having a fixed gap
2484                 const int gap = qMax(qreal(4.0), qreal(0.3) * rect.height());
2485                 if (mappedPos.y() >= gap && mappedPos.y() <= rect.height() - gap) {
2486                     return -1;
2487                 }
2488             }
2489
2490             const bool isAboveItem = (mappedPos.y() < rect.height() / 2);
2491             const qreal y = isAboveItem ? rect.top() : rect.bottom();
2492
2493             const QRectF draggingInsertIndicator(rect.left(), y, rect.width(), 1);
2494             if (m_dropIndicator != draggingInsertIndicator) {
2495                 m_dropIndicator = draggingInsertIndicator;
2496                 update();
2497             }
2498
2499             int index = widget->index();
2500             if (!isAboveItem) {
2501                 ++index;
2502             }
2503             return index;
2504         }
2505     }
2506
2507     const QRectF firstItemRect = itemRect(firstVisibleIndex());
2508     return (pos.y() <= firstItemRect.top()) ? 0 : -1;
2509 }
2510
2511 void KItemListView::hideDropIndicator()
2512 {
2513     if (!m_dropIndicator.isNull()) {
2514         m_dropIndicator = QRectF();
2515         update();
2516     }
2517 }
2518
2519 void KItemListView::updateGroupHeaderHeight()
2520 {
2521     qreal groupHeaderHeight = m_styleOption.fontMetrics.height();
2522     qreal groupHeaderMargin = 0;
2523
2524     if (scrollOrientation() == Qt::Horizontal) {
2525         // The vertical margin above and below the header should be
2526         // equal to the horizontal margin, not the vertical margin
2527         // from m_styleOption.
2528         groupHeaderHeight += 2 * m_styleOption.horizontalMargin;
2529         groupHeaderMargin = m_styleOption.horizontalMargin;
2530     } else if (m_itemSize.isEmpty()) {
2531         groupHeaderHeight += 4 * m_styleOption.padding;
2532         groupHeaderMargin = m_styleOption.iconSize / 2;
2533     } else {
2534         groupHeaderHeight += 2 * m_styleOption.padding + m_styleOption.verticalMargin;
2535         groupHeaderMargin = m_styleOption.iconSize / 4;
2536     }
2537     m_layouter->setGroupHeaderHeight(groupHeaderHeight);
2538     m_layouter->setGroupHeaderMargin(groupHeaderMargin);
2539
2540     updateVisibleGroupHeaders();
2541 }
2542
2543 void KItemListView::updateSiblingsInformation(int firstIndex, int lastIndex)
2544 {
2545     if (!supportsItemExpanding() || !m_model) {
2546         return;
2547     }
2548
2549     if (firstIndex < 0 || lastIndex < 0) {
2550         firstIndex = m_layouter->firstVisibleIndex();
2551         lastIndex = m_layouter->lastVisibleIndex();
2552     } else {
2553         const bool isRangeVisible = (firstIndex <= m_layouter->lastVisibleIndex() && lastIndex >= m_layouter->firstVisibleIndex());
2554         if (!isRangeVisible) {
2555             return;
2556         }
2557     }
2558
2559     int previousParents = 0;
2560     QBitArray previousSiblings;
2561
2562     // The rootIndex describes the first index where the siblings get
2563     // calculated from. For the calculation the upper most parent item
2564     // is required. For performance reasons it is checked first whether
2565     // the visible items before or after the current range already
2566     // contain a siblings information which can be used as base.
2567     int rootIndex = firstIndex;
2568
2569     KItemListWidget *widget = m_visibleItems.value(firstIndex - 1);
2570     if (!widget) {
2571         // There is no visible widget before the range, check whether there
2572         // is one after the range:
2573         widget = m_visibleItems.value(lastIndex + 1);
2574         if (widget) {
2575             // The sibling information of the widget may only be used if
2576             // all items of the range have the same number of parents.
2577             const int parents = m_model->expandedParentsCount(lastIndex + 1);
2578             for (int i = lastIndex; i >= firstIndex; --i) {
2579                 if (m_model->expandedParentsCount(i) != parents) {
2580                     widget = nullptr;
2581                     break;
2582                 }
2583             }
2584         }
2585     }
2586
2587     if (widget) {
2588         // Performance optimization: Use the sibling information of the visible
2589         // widget beside the given range.
2590         previousSiblings = widget->siblingsInformation();
2591         if (previousSiblings.isEmpty()) {
2592             return;
2593         }
2594         previousParents = previousSiblings.count() - 1;
2595         previousSiblings.truncate(previousParents);
2596     } else {
2597         // Potentially slow path: Go back to the upper most parent of firstIndex
2598         // to be able to calculate the initial value for the siblings.
2599         while (rootIndex > 0 && m_model->expandedParentsCount(rootIndex) > 0) {
2600             --rootIndex;
2601         }
2602     }
2603
2604     Q_ASSERT(previousParents >= 0);
2605     for (int i = rootIndex; i <= lastIndex; ++i) {
2606         // Update the parent-siblings in case if the current item represents
2607         // a child or an upper parent.
2608         const int currentParents = m_model->expandedParentsCount(i);
2609         Q_ASSERT(currentParents >= 0);
2610         if (previousParents < currentParents) {
2611             previousParents = currentParents;
2612             previousSiblings.resize(currentParents);
2613             previousSiblings.setBit(currentParents - 1, hasSiblingSuccessor(i - 1));
2614         } else if (previousParents > currentParents) {
2615             previousParents = currentParents;
2616             previousSiblings.truncate(currentParents);
2617         }
2618
2619         if (i >= firstIndex) {
2620             // The index represents a visible item. Apply the parent-siblings
2621             // and update the sibling of the current item.
2622             KItemListWidget *widget = m_visibleItems.value(i);
2623             if (!widget) {
2624                 continue;
2625             }
2626
2627             QBitArray siblings = previousSiblings;
2628             siblings.resize(siblings.count() + 1);
2629             siblings.setBit(siblings.count() - 1, hasSiblingSuccessor(i));
2630
2631             widget->setSiblingsInformation(siblings);
2632         }
2633     }
2634 }
2635
2636 bool KItemListView::hasSiblingSuccessor(int index) const
2637 {
2638     bool hasSuccessor = false;
2639     const int parentsCount = m_model->expandedParentsCount(index);
2640     int successorIndex = index + 1;
2641
2642     // Search the next sibling
2643     const int itemCount = m_model->count();
2644     while (successorIndex < itemCount) {
2645         const int currentParentsCount = m_model->expandedParentsCount(successorIndex);
2646         if (currentParentsCount == parentsCount) {
2647             hasSuccessor = true;
2648             break;
2649         } else if (currentParentsCount < parentsCount) {
2650             break;
2651         }
2652         ++successorIndex;
2653     }
2654
2655     if (m_grouped && hasSuccessor) {
2656         // If the sibling is part of another group, don't mark it as
2657         // successor as the group header is between the sibling connections.
2658         for (int i = index + 1; i <= successorIndex; ++i) {
2659             if (m_layouter->isFirstGroupItem(i)) {
2660                 hasSuccessor = false;
2661                 break;
2662             }
2663         }
2664     }
2665
2666     return hasSuccessor;
2667 }
2668
2669 void KItemListView::disconnectRoleEditingSignals(int index)
2670 {
2671     KStandardItemListWidget *widget = qobject_cast<KStandardItemListWidget *>(m_visibleItems.value(index));
2672     if (!widget) {
2673         return;
2674     }
2675
2676     disconnect(widget, &KItemListWidget::roleEditingCanceled, this, nullptr);
2677     disconnect(widget, &KItemListWidget::roleEditingFinished, this, nullptr);
2678     disconnect(this, &KItemListView::scrollOffsetChanged, widget, nullptr);
2679 }
2680
2681 int KItemListView::calculateAutoScrollingIncrement(int pos, int range, int oldInc)
2682 {
2683     int inc = 0;
2684
2685     const int minSpeed = 4;
2686     const int maxSpeed = 128;
2687     const int speedLimiter = 96;
2688     const int autoScrollBorder = 64;
2689
2690     // Limit the increment that is allowed to be added in comparison to 'oldInc'.
2691     // This assures that the autoscrolling speed grows gradually.
2692     const int incLimiter = 1;
2693
2694     if (pos < autoScrollBorder) {
2695         inc = -minSpeed + qAbs(pos - autoScrollBorder) * (pos - autoScrollBorder) / speedLimiter;
2696         inc = qMax(inc, -maxSpeed);
2697         inc = qMax(inc, oldInc - incLimiter);
2698     } else if (pos > range - autoScrollBorder) {
2699         inc = minSpeed + qAbs(pos - range + autoScrollBorder) * (pos - range + autoScrollBorder) / speedLimiter;
2700         inc = qMin(inc, maxSpeed);
2701         inc = qMin(inc, oldInc + incLimiter);
2702     }
2703
2704     return inc;
2705 }
2706
2707 int KItemListView::itemsPerSize(qreal size, qreal itemSize, qreal itemMargin)
2708 {
2709     const qreal availableSize = size - itemMargin;
2710     const int count = availableSize / (itemSize + itemMargin);
2711     return count;
2712 }
2713
2714 KItemListCreatorBase::~KItemListCreatorBase()
2715 {
2716     qDeleteAll(m_recycleableWidgets);
2717     qDeleteAll(m_createdWidgets);
2718 }
2719
2720 void KItemListCreatorBase::addCreatedWidget(QGraphicsWidget *widget)
2721 {
2722     m_createdWidgets.insert(widget);
2723 }
2724
2725 void KItemListCreatorBase::pushRecycleableWidget(QGraphicsWidget *widget)
2726 {
2727     Q_ASSERT(m_createdWidgets.contains(widget));
2728     m_createdWidgets.remove(widget);
2729
2730     if (m_recycleableWidgets.count() < 100) {
2731         m_recycleableWidgets.append(widget);
2732         widget->setVisible(false);
2733     } else {
2734         delete widget;
2735     }
2736 }
2737
2738 QGraphicsWidget *KItemListCreatorBase::popRecycleableWidget()
2739 {
2740     if (m_recycleableWidgets.isEmpty()) {
2741         return nullptr;
2742     }
2743
2744     QGraphicsWidget *widget = m_recycleableWidgets.takeLast();
2745     m_createdWidgets.insert(widget);
2746     return widget;
2747 }
2748
2749 KItemListWidgetCreatorBase::~KItemListWidgetCreatorBase()
2750 {
2751 }
2752
2753 void KItemListWidgetCreatorBase::recycle(KItemListWidget *widget)
2754 {
2755     widget->setParentItem(nullptr);
2756     widget->setOpacity(1.0);
2757     pushRecycleableWidget(widget);
2758 }
2759
2760 KItemListGroupHeaderCreatorBase::~KItemListGroupHeaderCreatorBase()
2761 {
2762 }
2763
2764 void KItemListGroupHeaderCreatorBase::recycle(KItemListGroupHeader *header)
2765 {
2766     header->setOpacity(1.0);
2767     pushRecycleableWidget(header);
2768 }
2769
2770 #include "moc_kitemlistview.cpp"