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     if (scene() && !scene()->views().isEmpty()) {
1038         KItemListStyleOption option = styleOption();
1039         option.palette = scene()->views().first()->palette();
1040
1041         setStyleOption(option);
1042     }
1043 }
1044
1045 void KItemListView::slotItemsInserted(const KItemRangeList &itemRanges)
1046 {
1047     if (m_itemSize.isEmpty()) {
1048         updatePreferredColumnWidths(itemRanges);
1049     }
1050
1051     const bool hasMultipleRanges = (itemRanges.count() > 1);
1052     if (hasMultipleRanges) {
1053         beginTransaction();
1054     }
1055
1056     m_layouter->markAsDirty();
1057
1058     m_sizeHintResolver->itemsInserted(itemRanges);
1059
1060     int previouslyInsertedCount = 0;
1061     for (const KItemRange &range : itemRanges) {
1062         // range.index is related to the model before anything has been inserted.
1063         // As in each loop the current item-range gets inserted the index must
1064         // be increased by the already previously inserted items.
1065         const int index = range.index + previouslyInsertedCount;
1066         const int count = range.count;
1067         if (index < 0 || count <= 0) {
1068             qCWarning(DolphinDebug) << "Invalid item range (index:" << index << ", count:" << count << ")";
1069             continue;
1070         }
1071         previouslyInsertedCount += count;
1072
1073         // Determine which visible items must be moved
1074         QList<int> itemsToMove;
1075         QHashIterator<int, KItemListWidget *> it(m_visibleItems);
1076         while (it.hasNext()) {
1077             it.next();
1078             const int visibleItemIndex = it.key();
1079             if (visibleItemIndex >= index) {
1080                 itemsToMove.append(visibleItemIndex);
1081             }
1082         }
1083
1084         // Update the indexes of all KItemListWidget instances that are located
1085         // after the inserted items. It is important to adjust the indexes in the order
1086         // from the highest index to the lowest index to prevent overlaps when setting the new index.
1087         std::sort(itemsToMove.begin(), itemsToMove.end());
1088         for (int i = itemsToMove.count() - 1; i >= 0; --i) {
1089             KItemListWidget *widget = m_visibleItems.value(itemsToMove[i]);
1090             Q_ASSERT(widget);
1091             const int newIndex = widget->index() + count;
1092             if (hasMultipleRanges) {
1093                 setWidgetIndex(widget, newIndex);
1094             } else {
1095                 // Try to animate the moving of the item
1096                 moveWidgetToIndex(widget, newIndex);
1097             }
1098         }
1099
1100         if (m_model->count() == count && m_activeTransactions == 0) {
1101             // Check whether a scrollbar is required to show the inserted items. In this case
1102             // the size of the layouter will be decreased before calling doLayout(): This prevents
1103             // an unnecessary temporary animation due to the geometry change of the inserted scrollbar.
1104             const bool verticalScrollOrientation = (scrollOrientation() == Qt::Vertical);
1105             const bool decreaseLayouterSize = (verticalScrollOrientation && maximumScrollOffset() > size().height())
1106                 || (!verticalScrollOrientation && maximumScrollOffset() > size().width());
1107             if (decreaseLayouterSize) {
1108                 const int scrollBarExtent = style()->pixelMetric(QStyle::PM_ScrollBarExtent);
1109
1110                 int scrollbarSpacing = 0;
1111                 if (style()->styleHint(QStyle::SH_ScrollView_FrameOnlyAroundContents)) {
1112                     scrollbarSpacing = style()->pixelMetric(QStyle::PM_ScrollView_ScrollBarSpacing);
1113                 }
1114
1115                 QSizeF layouterSize = m_layouter->size();
1116                 if (verticalScrollOrientation) {
1117                     layouterSize.rwidth() -= scrollBarExtent + scrollbarSpacing;
1118                 } else {
1119                     layouterSize.rheight() -= scrollBarExtent + scrollbarSpacing;
1120                 }
1121                 m_layouter->setSize(layouterSize);
1122             }
1123         }
1124
1125         if (!hasMultipleRanges) {
1126             doLayout(animateChangedItemCount(count) ? Animation : NoAnimation, index, count);
1127             updateSiblingsInformation();
1128         }
1129     }
1130
1131     if (m_controller) {
1132         m_controller->selectionManager()->itemsInserted(itemRanges);
1133     }
1134
1135     if (hasMultipleRanges) {
1136         m_endTransactionAnimationHint = NoAnimation;
1137         endTransaction();
1138
1139         updateSiblingsInformation();
1140     }
1141
1142     if (m_grouped && (hasMultipleRanges || itemRanges.first().count < m_model->count())) {
1143         // In case if items of the same group have been inserted before an item that
1144         // currently represents the first item of the group, the group header of
1145         // this item must be removed.
1146         updateVisibleGroupHeaders();
1147     }
1148
1149     if (useAlternateBackgrounds()) {
1150         updateAlternateBackgrounds();
1151     }
1152 }
1153
1154 void KItemListView::slotItemsRemoved(const KItemRangeList &itemRanges)
1155 {
1156     if (m_itemSize.isEmpty()) {
1157         // Don't pass the item-range: The preferred column-widths of
1158         // all items must be adjusted when removing items.
1159         updatePreferredColumnWidths();
1160     }
1161
1162     const bool hasMultipleRanges = (itemRanges.count() > 1);
1163     if (hasMultipleRanges) {
1164         beginTransaction();
1165     }
1166
1167     m_layouter->markAsDirty();
1168
1169     m_sizeHintResolver->itemsRemoved(itemRanges);
1170
1171     for (int i = itemRanges.count() - 1; i >= 0; --i) {
1172         const KItemRange &range = itemRanges[i];
1173         const int index = range.index;
1174         const int count = range.count;
1175         if (index < 0 || count <= 0) {
1176             qCWarning(DolphinDebug) << "Invalid item range (index:" << index << ", count:" << count << ")";
1177             continue;
1178         }
1179
1180         const int firstRemovedIndex = index;
1181         const int lastRemovedIndex = index + count - 1;
1182
1183         // Remember which items have to be moved because they are behind the removed range.
1184         QVector<int> itemsToMove;
1185
1186         // Remove all KItemListWidget instances that got deleted
1187         // Iterate over a const copy because the container is mutated within the loop
1188         // directly and in `recycleWidget()` (https://bugs.kde.org/show_bug.cgi?id=428374)
1189         const auto visibleItems = m_visibleItems;
1190         for (KItemListWidget *widget : visibleItems) {
1191             const int i = widget->index();
1192             if (i < firstRemovedIndex) {
1193                 continue;
1194             } else if (i > lastRemovedIndex) {
1195                 itemsToMove.append(i);
1196                 continue;
1197             }
1198
1199             m_animation->stop(widget);
1200             // Stopping the animation might lead to recycling the widget if
1201             // it is invisible (see slotAnimationFinished()).
1202             // Check again whether it is still visible:
1203             if (!m_visibleItems.contains(i)) {
1204                 continue;
1205             }
1206
1207             if (m_model->count() == 0 || hasMultipleRanges || !animateChangedItemCount(count)) {
1208                 // Remove the widget without animation
1209                 recycleWidget(widget);
1210             } else {
1211                 // Animate the removing of the items. Special case: When removing an item there
1212                 // is no valid model index available anymore. For the
1213                 // remove-animation the item gets removed from m_visibleItems but the widget
1214                 // will stay alive until the animation has been finished and will
1215                 // be recycled (deleted) in KItemListView::slotAnimationFinished().
1216                 m_visibleItems.remove(i);
1217                 widget->setIndex(-1);
1218                 m_animation->start(widget, KItemListViewAnimation::DeleteAnimation);
1219             }
1220         }
1221
1222         // Update the indexes of all KItemListWidget instances that are located
1223         // after the deleted items. It is important to update them in ascending
1224         // order to prevent overlaps when setting the new index.
1225         std::sort(itemsToMove.begin(), itemsToMove.end());
1226         for (int i : qAsConst(itemsToMove)) {
1227             KItemListWidget *widget = m_visibleItems.value(i);
1228             Q_ASSERT(widget);
1229             const int newIndex = i - count;
1230             if (hasMultipleRanges) {
1231                 setWidgetIndex(widget, newIndex);
1232             } else {
1233                 // Try to animate the moving of the item
1234                 moveWidgetToIndex(widget, newIndex);
1235             }
1236         }
1237
1238         if (!hasMultipleRanges) {
1239             // The decrease-layout-size optimization in KItemListView::slotItemsInserted()
1240             // assumes an updated geometry. If items are removed during an active transaction,
1241             // the transaction will be temporary deactivated so that doLayout() triggers a
1242             // geometry update if necessary.
1243             const int activeTransactions = m_activeTransactions;
1244             m_activeTransactions = 0;
1245             doLayout(animateChangedItemCount(count) ? Animation : NoAnimation, index, -count);
1246             m_activeTransactions = activeTransactions;
1247             updateSiblingsInformation();
1248         }
1249     }
1250
1251     if (m_controller) {
1252         m_controller->selectionManager()->itemsRemoved(itemRanges);
1253     }
1254
1255     if (hasMultipleRanges) {
1256         m_endTransactionAnimationHint = NoAnimation;
1257         endTransaction();
1258         updateSiblingsInformation();
1259     }
1260
1261     if (m_grouped && (hasMultipleRanges || m_model->count() > 0)) {
1262         // In case if the first item of a group has been removed, the group header
1263         // must be applied to the next visible item.
1264         updateVisibleGroupHeaders();
1265     }
1266
1267     if (useAlternateBackgrounds()) {
1268         updateAlternateBackgrounds();
1269     }
1270 }
1271
1272 void KItemListView::slotItemsMoved(const KItemRange &itemRange, const QList<int> &movedToIndexes)
1273 {
1274     m_sizeHintResolver->itemsMoved(itemRange, movedToIndexes);
1275     m_layouter->markAsDirty();
1276
1277     if (m_controller) {
1278         m_controller->selectionManager()->itemsMoved(itemRange, movedToIndexes);
1279     }
1280
1281     const int firstVisibleMovedIndex = qMax(firstVisibleIndex(), itemRange.index);
1282     const int lastVisibleMovedIndex = qMin(lastVisibleIndex(), itemRange.index + itemRange.count - 1);
1283
1284     for (int index = firstVisibleMovedIndex; index <= lastVisibleMovedIndex; ++index) {
1285         KItemListWidget *widget = m_visibleItems.value(index);
1286         if (widget) {
1287             updateWidgetProperties(widget, index);
1288             initializeItemListWidget(widget);
1289         }
1290     }
1291
1292     doLayout(NoAnimation);
1293     updateSiblingsInformation();
1294 }
1295
1296 void KItemListView::slotItemsChanged(const KItemRangeList &itemRanges, const QSet<QByteArray> &roles)
1297 {
1298     const bool updateSizeHints = itemSizeHintUpdateRequired(roles);
1299     if (updateSizeHints && m_itemSize.isEmpty()) {
1300         updatePreferredColumnWidths(itemRanges);
1301     }
1302
1303     for (const KItemRange &itemRange : itemRanges) {
1304         const int index = itemRange.index;
1305         const int count = itemRange.count;
1306
1307         if (updateSizeHints) {
1308             m_sizeHintResolver->itemsChanged(index, count, roles);
1309             m_layouter->markAsDirty();
1310         }
1311
1312         // Apply the changed roles to the visible item-widgets
1313         const int lastIndex = index + count - 1;
1314         for (int i = index; i <= lastIndex; ++i) {
1315             KItemListWidget *widget = m_visibleItems.value(i);
1316             if (widget) {
1317                 widget->setData(m_model->data(i), roles);
1318             }
1319         }
1320
1321         if (m_grouped && roles.contains(m_model->sortRole())) {
1322             // The sort-role has been changed which might result
1323             // in modified group headers
1324             updateVisibleGroupHeaders();
1325             doLayout(NoAnimation);
1326         }
1327
1328         QAccessibleTableModelChangeEvent ev(this, QAccessibleTableModelChangeEvent::DataChanged);
1329         ev.setFirstRow(itemRange.index);
1330         ev.setLastRow(itemRange.index + itemRange.count);
1331         QAccessible::updateAccessibility(&ev);
1332     }
1333
1334     doLayout(NoAnimation);
1335 }
1336
1337 void KItemListView::slotGroupsChanged()
1338 {
1339     updateVisibleGroupHeaders();
1340     doLayout(NoAnimation);
1341     updateSiblingsInformation();
1342 }
1343
1344 void KItemListView::slotGroupedSortingChanged(bool current)
1345 {
1346     m_grouped = current;
1347     m_layouter->markAsDirty();
1348
1349     if (m_grouped) {
1350         updateGroupHeaderHeight();
1351     } else {
1352         // Clear all visible headers. Note that the QHashIterator takes a copy of
1353         // m_visibleGroups. Therefore, it remains valid even if items are removed
1354         // from m_visibleGroups in recycleGroupHeaderForWidget().
1355         QHashIterator<KItemListWidget *, KItemListGroupHeader *> it(m_visibleGroups);
1356         while (it.hasNext()) {
1357             it.next();
1358             recycleGroupHeaderForWidget(it.key());
1359         }
1360         Q_ASSERT(m_visibleGroups.isEmpty());
1361     }
1362
1363     if (useAlternateBackgrounds()) {
1364         // Changing the group mode requires to update the alternate backgrounds
1365         // as with the enabled group mode the altering is done on base of the first
1366         // group item.
1367         updateAlternateBackgrounds();
1368     }
1369     updateSiblingsInformation();
1370     doLayout(NoAnimation);
1371 }
1372
1373 void KItemListView::slotSortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous)
1374 {
1375     Q_UNUSED(current)
1376     Q_UNUSED(previous)
1377     if (m_grouped) {
1378         updateVisibleGroupHeaders();
1379         doLayout(NoAnimation);
1380     }
1381 }
1382
1383 void KItemListView::slotSortRoleChanged(const QByteArray &current, const QByteArray &previous)
1384 {
1385     Q_UNUSED(current)
1386     Q_UNUSED(previous)
1387     if (m_grouped) {
1388         updateVisibleGroupHeaders();
1389         doLayout(NoAnimation);
1390     }
1391 }
1392
1393 void KItemListView::slotCurrentChanged(int current, int previous)
1394 {
1395     Q_UNUSED(previous)
1396
1397     // In SingleSelection mode (e.g., in the Places Panel), the current item is
1398     // always the selected item. It is not necessary to highlight the current item then.
1399     if (m_controller->selectionBehavior() != KItemListController::SingleSelection) {
1400         KItemListWidget *previousWidget = m_visibleItems.value(previous, nullptr);
1401         if (previousWidget) {
1402             previousWidget->setCurrent(false);
1403         }
1404
1405         KItemListWidget *currentWidget = m_visibleItems.value(current, nullptr);
1406         if (currentWidget) {
1407             currentWidget->setCurrent(true);
1408         }
1409     }
1410
1411     QAccessibleEvent ev(this, QAccessible::Focus);
1412     ev.setChild(current);
1413     QAccessible::updateAccessibility(&ev);
1414 }
1415
1416 void KItemListView::slotSelectionChanged(const KItemSet &current, const KItemSet &previous)
1417 {
1418     Q_UNUSED(previous)
1419
1420     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
1421     while (it.hasNext()) {
1422         it.next();
1423         const int index = it.key();
1424         KItemListWidget *widget = it.value();
1425         widget->setSelected(current.contains(index));
1426     }
1427 }
1428
1429 void KItemListView::slotAnimationFinished(QGraphicsWidget *widget, KItemListViewAnimation::AnimationType type)
1430 {
1431     KItemListWidget *itemListWidget = qobject_cast<KItemListWidget *>(widget);
1432     Q_ASSERT(itemListWidget);
1433
1434     if (type == KItemListViewAnimation::DeleteAnimation) {
1435         // As we recycle the widget in this case it is important to assure that no
1436         // other animation has been started. This is a convention in KItemListView and
1437         // not a requirement defined by KItemListViewAnimation.
1438         Q_ASSERT(!m_animation->isStarted(itemListWidget));
1439
1440         // All KItemListWidgets that are animated by the DeleteAnimation are not maintained
1441         // by m_visibleWidgets and must be deleted manually after the animation has
1442         // been finished.
1443         recycleGroupHeaderForWidget(itemListWidget);
1444         widgetCreator()->recycle(itemListWidget);
1445     } else {
1446         const int index = itemListWidget->index();
1447         const bool invisible = (index < m_layouter->firstVisibleIndex()) || (index > m_layouter->lastVisibleIndex());
1448         if (invisible && !m_animation->isStarted(itemListWidget)) {
1449             recycleWidget(itemListWidget);
1450         }
1451     }
1452 }
1453
1454 void KItemListView::slotRubberBandPosChanged()
1455 {
1456     update();
1457 }
1458
1459 void KItemListView::slotRubberBandActivationChanged(bool active)
1460 {
1461     if (active) {
1462         connect(m_rubberBand, &KItemListRubberBand::startPositionChanged, this, &KItemListView::slotRubberBandPosChanged);
1463         connect(m_rubberBand, &KItemListRubberBand::endPositionChanged, this, &KItemListView::slotRubberBandPosChanged);
1464         m_skipAutoScrollForRubberBand = true;
1465     } else {
1466         QRectF rubberBandRect = QRectF(m_rubberBand->startPosition(), m_rubberBand->endPosition()).normalized();
1467
1468         auto animation = new QVariantAnimation(this);
1469         animation->setStartValue(1.0);
1470         animation->setEndValue(0.0);
1471         animation->setDuration(RubberFadeSpeed);
1472         animation->setProperty(RubberPropertyName, rubberBandRect);
1473
1474         QEasingCurve curve;
1475         curve.setType(QEasingCurve::BezierSpline);
1476         curve.addCubicBezierSegment(QPointF(0.4, 0.0), QPointF(1.0, 1.0), QPointF(1.0, 1.0));
1477         animation->setEasingCurve(curve);
1478
1479         connect(animation, &QVariantAnimation::valueChanged, this, [=](const QVariant &) {
1480             update();
1481         });
1482         connect(animation, &QVariantAnimation::finished, this, [=]() {
1483             m_rubberBandAnimations.removeAll(animation);
1484             delete animation;
1485         });
1486         animation->start();
1487         m_rubberBandAnimations << animation;
1488
1489         disconnect(m_rubberBand, &KItemListRubberBand::startPositionChanged, this, &KItemListView::slotRubberBandPosChanged);
1490         disconnect(m_rubberBand, &KItemListRubberBand::endPositionChanged, this, &KItemListView::slotRubberBandPosChanged);
1491         m_skipAutoScrollForRubberBand = false;
1492     }
1493
1494     update();
1495 }
1496
1497 void KItemListView::slotHeaderColumnWidthChanged(const QByteArray &role, qreal currentWidth, qreal previousWidth)
1498 {
1499     Q_UNUSED(role)
1500     Q_UNUSED(currentWidth)
1501     Q_UNUSED(previousWidth)
1502
1503     m_headerWidget->setAutomaticColumnResizing(false);
1504     applyColumnWidthsFromHeader();
1505     doLayout(NoAnimation);
1506 }
1507
1508 void KItemListView::slotSidePaddingChanged(qreal width)
1509 {
1510     Q_UNUSED(width)
1511     if (m_headerWidget->automaticColumnResizing()) {
1512         applyAutomaticColumnWidths();
1513     }
1514     applyColumnWidthsFromHeader();
1515     doLayout(NoAnimation);
1516 }
1517
1518 void KItemListView::slotHeaderColumnMoved(const QByteArray &role, int currentIndex, int previousIndex)
1519 {
1520     Q_ASSERT(m_visibleRoles[previousIndex] == role);
1521
1522     const QList<QByteArray> previous = m_visibleRoles;
1523
1524     QList<QByteArray> current = m_visibleRoles;
1525     current.removeAt(previousIndex);
1526     current.insert(currentIndex, role);
1527
1528     setVisibleRoles(current);
1529
1530     Q_EMIT visibleRolesChanged(current, previous);
1531 }
1532
1533 void KItemListView::triggerAutoScrolling()
1534 {
1535     if (!m_autoScrollTimer) {
1536         return;
1537     }
1538
1539     int pos = 0;
1540     int visibleSize = 0;
1541     if (scrollOrientation() == Qt::Vertical) {
1542         pos = m_mousePos.y();
1543         visibleSize = size().height();
1544     } else {
1545         pos = m_mousePos.x();
1546         visibleSize = size().width();
1547     }
1548
1549     if (m_autoScrollTimer->interval() == InitialAutoScrollDelay) {
1550         m_autoScrollIncrement = 0;
1551     }
1552
1553     m_autoScrollIncrement = calculateAutoScrollingIncrement(pos, visibleSize, m_autoScrollIncrement);
1554     if (m_autoScrollIncrement == 0) {
1555         // The mouse position is not above an autoscroll margin (the autoscroll timer
1556         // will be restarted in mouseMoveEvent())
1557         m_autoScrollTimer->stop();
1558         return;
1559     }
1560
1561     if (m_rubberBand->isActive() && m_skipAutoScrollForRubberBand) {
1562         // If a rubberband selection is ongoing the autoscrolling may only get triggered
1563         // if the direction of the rubberband is similar to the autoscroll direction. This
1564         // prevents that starting to create a rubberband within the autoscroll margins starts
1565         // an autoscrolling.
1566
1567         const qreal minDiff = 4; // Ignore any autoscrolling if the rubberband is very small
1568         const qreal diff = (scrollOrientation() == Qt::Vertical) ? m_rubberBand->endPosition().y() - m_rubberBand->startPosition().y()
1569                                                                  : m_rubberBand->endPosition().x() - m_rubberBand->startPosition().x();
1570         if (qAbs(diff) < minDiff || (m_autoScrollIncrement < 0 && diff > 0) || (m_autoScrollIncrement > 0 && diff < 0)) {
1571             // The rubberband direction is different from the scroll direction (e.g. the rubberband has
1572             // been moved up although the autoscroll direction might be down)
1573             m_autoScrollTimer->stop();
1574             return;
1575         }
1576     }
1577
1578     // As soon as the autoscrolling has been triggered at least once despite having an active rubberband,
1579     // the autoscrolling may not get skipped anymore until a new rubberband is created
1580     m_skipAutoScrollForRubberBand = false;
1581
1582     const qreal maxVisibleOffset = qMax(qreal(0), maximumScrollOffset() - visibleSize);
1583     const qreal newScrollOffset = qMin(scrollOffset() + m_autoScrollIncrement, maxVisibleOffset);
1584     setScrollOffset(newScrollOffset);
1585
1586     // Trigger the autoscroll timer which will periodically call
1587     // triggerAutoScrolling()
1588     m_autoScrollTimer->start(RepeatingAutoScrollDelay);
1589 }
1590
1591 void KItemListView::slotGeometryOfGroupHeaderParentChanged()
1592 {
1593     KItemListWidget *widget = qobject_cast<KItemListWidget *>(sender());
1594     Q_ASSERT(widget);
1595     KItemListGroupHeader *groupHeader = m_visibleGroups.value(widget);
1596     Q_ASSERT(groupHeader);
1597     updateGroupHeaderLayout(widget);
1598 }
1599
1600 void KItemListView::slotRoleEditingCanceled(int index, const QByteArray &role, const QVariant &value)
1601 {
1602     disconnectRoleEditingSignals(index);
1603
1604     m_editingRole = false;
1605     Q_EMIT roleEditingCanceled(index, role, value);
1606 }
1607
1608 void KItemListView::slotRoleEditingFinished(int index, const QByteArray &role, const QVariant &value)
1609 {
1610     disconnectRoleEditingSignals(index);
1611
1612     m_editingRole = false;
1613     Q_EMIT roleEditingFinished(index, role, value);
1614 }
1615
1616 void KItemListView::setController(KItemListController *controller)
1617 {
1618     if (m_controller != controller) {
1619         KItemListController *previous = m_controller;
1620         if (previous) {
1621             KItemListSelectionManager *selectionManager = previous->selectionManager();
1622             disconnect(selectionManager, &KItemListSelectionManager::currentChanged, this, &KItemListView::slotCurrentChanged);
1623             disconnect(selectionManager, &KItemListSelectionManager::selectionChanged, this, &KItemListView::slotSelectionChanged);
1624         }
1625
1626         m_controller = controller;
1627
1628         if (controller) {
1629             KItemListSelectionManager *selectionManager = controller->selectionManager();
1630             connect(selectionManager, &KItemListSelectionManager::currentChanged, this, &KItemListView::slotCurrentChanged);
1631             connect(selectionManager, &KItemListSelectionManager::selectionChanged, this, &KItemListView::slotSelectionChanged);
1632         }
1633
1634         onControllerChanged(controller, previous);
1635     }
1636 }
1637
1638 void KItemListView::setModel(KItemModelBase *model)
1639 {
1640     if (m_model == model) {
1641         return;
1642     }
1643
1644     KItemModelBase *previous = m_model;
1645
1646     if (m_model) {
1647         disconnect(m_model, &KItemModelBase::itemsChanged, this, &KItemListView::slotItemsChanged);
1648         disconnect(m_model, &KItemModelBase::itemsInserted, this, &KItemListView::slotItemsInserted);
1649         disconnect(m_model, &KItemModelBase::itemsRemoved, this, &KItemListView::slotItemsRemoved);
1650         disconnect(m_model, &KItemModelBase::itemsMoved, this, &KItemListView::slotItemsMoved);
1651         disconnect(m_model, &KItemModelBase::groupsChanged, this, &KItemListView::slotGroupsChanged);
1652         disconnect(m_model, &KItemModelBase::groupedSortingChanged, this, &KItemListView::slotGroupedSortingChanged);
1653         disconnect(m_model, &KItemModelBase::sortOrderChanged, this, &KItemListView::slotSortOrderChanged);
1654         disconnect(m_model, &KItemModelBase::sortRoleChanged, this, &KItemListView::slotSortRoleChanged);
1655
1656         m_sizeHintResolver->itemsRemoved(KItemRangeList() << KItemRange(0, m_model->count()));
1657     }
1658
1659     m_model = model;
1660     m_layouter->setModel(model);
1661     m_grouped = model->groupedSorting();
1662
1663     if (m_model) {
1664         connect(m_model, &KItemModelBase::itemsChanged, this, &KItemListView::slotItemsChanged);
1665         connect(m_model, &KItemModelBase::itemsInserted, this, &KItemListView::slotItemsInserted);
1666         connect(m_model, &KItemModelBase::itemsRemoved, this, &KItemListView::slotItemsRemoved);
1667         connect(m_model, &KItemModelBase::itemsMoved, this, &KItemListView::slotItemsMoved);
1668         connect(m_model, &KItemModelBase::groupsChanged, this, &KItemListView::slotGroupsChanged);
1669         connect(m_model, &KItemModelBase::groupedSortingChanged, this, &KItemListView::slotGroupedSortingChanged);
1670         connect(m_model, &KItemModelBase::sortOrderChanged, this, &KItemListView::slotSortOrderChanged);
1671         connect(m_model, &KItemModelBase::sortRoleChanged, this, &KItemListView::slotSortRoleChanged);
1672
1673         const int itemCount = m_model->count();
1674         if (itemCount > 0) {
1675             slotItemsInserted(KItemRangeList() << KItemRange(0, itemCount));
1676         }
1677     }
1678
1679     onModelChanged(model, previous);
1680 }
1681
1682 KItemListRubberBand *KItemListView::rubberBand() const
1683 {
1684     return m_rubberBand;
1685 }
1686
1687 void KItemListView::doLayout(LayoutAnimationHint hint, int changedIndex, int changedCount)
1688 {
1689     if (m_activeTransactions > 0) {
1690         if (hint == NoAnimation) {
1691             // As soon as at least one property change should be done without animation,
1692             // the whole transaction will be marked as not animated.
1693             m_endTransactionAnimationHint = NoAnimation;
1694         }
1695         return;
1696     }
1697
1698     if (!m_model || m_model->count() < 0) {
1699         return;
1700     }
1701
1702     int firstVisibleIndex = m_layouter->firstVisibleIndex();
1703     if (firstVisibleIndex < 0) {
1704         emitOffsetChanges();
1705         return;
1706     }
1707
1708     // Do a sanity check of the scroll-offset property: When properties of the itemlist-view have been changed
1709     // it might be possible that the maximum offset got changed too. Assure that the full visible range
1710     // is still shown if the maximum offset got decreased.
1711     const qreal visibleOffsetRange = (scrollOrientation() == Qt::Horizontal) ? size().width() : size().height();
1712     const qreal maxOffsetToShowFullRange = maximumScrollOffset() - visibleOffsetRange;
1713     if (scrollOffset() > maxOffsetToShowFullRange) {
1714         m_layouter->setScrollOffset(qMax(qreal(0), maxOffsetToShowFullRange));
1715         firstVisibleIndex = m_layouter->firstVisibleIndex();
1716     }
1717
1718     const int lastVisibleIndex = m_layouter->lastVisibleIndex();
1719
1720     int firstSibblingIndex = -1;
1721     int lastSibblingIndex = -1;
1722     const bool supportsExpanding = supportsItemExpanding();
1723
1724     QList<int> reusableItems = recycleInvisibleItems(firstVisibleIndex, lastVisibleIndex, hint);
1725
1726     // Assure that for each visible item a KItemListWidget is available. KItemListWidget
1727     // instances from invisible items are reused. If no reusable items are
1728     // found then new KItemListWidget instances get created.
1729     const bool animate = (hint == Animation);
1730     for (int i = firstVisibleIndex; i <= lastVisibleIndex; ++i) {
1731         bool applyNewPos = true;
1732
1733         const QRectF itemBounds = m_layouter->itemRect(i);
1734         const QPointF newPos = itemBounds.topLeft();
1735         KItemListWidget *widget = m_visibleItems.value(i);
1736         if (!widget) {
1737             if (!reusableItems.isEmpty()) {
1738                 // Reuse a KItemListWidget instance from an invisible item
1739                 const int oldIndex = reusableItems.takeLast();
1740                 widget = m_visibleItems.value(oldIndex);
1741                 setWidgetIndex(widget, i);
1742                 updateWidgetProperties(widget, i);
1743                 initializeItemListWidget(widget);
1744             } else {
1745                 // No reusable KItemListWidget instance is available, create a new one
1746                 widget = createWidget(i);
1747             }
1748             widget->resize(itemBounds.size());
1749
1750             if (animate && changedCount < 0) {
1751                 // Items have been deleted.
1752                 if (i >= changedIndex) {
1753                     // The item is located behind the removed range. Move the
1754                     // created item to the imaginary old position outside the
1755                     // view. It will get animated to the new position later.
1756                     const int previousIndex = i - changedCount;
1757                     const QRectF itemRect = m_layouter->itemRect(previousIndex);
1758                     if (itemRect.isEmpty()) {
1759                         const QPointF invisibleOldPos = (scrollOrientation() == Qt::Vertical) ? QPointF(0, size().height()) : QPointF(size().width(), 0);
1760                         widget->setPos(invisibleOldPos);
1761                     } else {
1762                         widget->setPos(itemRect.topLeft());
1763                     }
1764                     applyNewPos = false;
1765                 }
1766             }
1767
1768             if (supportsExpanding && changedCount == 0) {
1769                 if (firstSibblingIndex < 0) {
1770                     firstSibblingIndex = i;
1771                 }
1772                 lastSibblingIndex = i;
1773             }
1774         }
1775
1776         if (animate) {
1777             if (m_animation->isStarted(widget, KItemListViewAnimation::MovingAnimation)) {
1778                 m_animation->start(widget, KItemListViewAnimation::MovingAnimation, newPos);
1779                 applyNewPos = false;
1780             }
1781
1782             const bool itemsRemoved = (changedCount < 0);
1783             const bool itemsInserted = (changedCount > 0);
1784             if (itemsRemoved && (i >= changedIndex)) {
1785                 // The item is located after the removed items. Animate the moving of the position.
1786                 applyNewPos = !moveWidget(widget, newPos);
1787             } else if (itemsInserted && i >= changedIndex) {
1788                 // The item is located after the first inserted item
1789                 if (i <= changedIndex + changedCount - 1) {
1790                     // The item is an inserted item. Animate the appearing of the item.
1791                     // For performance reasons no animation is done when changedCount is equal
1792                     // to all available items.
1793                     if (changedCount < m_model->count()) {
1794                         m_animation->start(widget, KItemListViewAnimation::CreateAnimation);
1795                     }
1796                 } else if (!m_animation->isStarted(widget, KItemListViewAnimation::CreateAnimation)) {
1797                     // The item was already there before, so animate the moving of the position.
1798                     // No moving animation is done if the item is animated by a create animation: This
1799                     // prevents a "move animation mess" when inserting several ranges in parallel.
1800                     applyNewPos = !moveWidget(widget, newPos);
1801                 }
1802             }
1803         } else {
1804             m_animation->stop(widget);
1805         }
1806
1807         if (applyNewPos) {
1808             widget->setPos(newPos);
1809         }
1810
1811         Q_ASSERT(widget->index() == i);
1812         widget->setVisible(true);
1813
1814         bool animateIconResizing = animate;
1815
1816         if (widget->size() != itemBounds.size()) {
1817             // Resize the widget for the item to the changed size.
1818             if (animate) {
1819                 // If a dynamic item size is used then no animation is done in the direction
1820                 // of the dynamic size.
1821                 if (m_itemSize.width() <= 0) {
1822                     // The width is dynamic, apply the new width without animation.
1823                     widget->resize(itemBounds.width(), widget->size().height());
1824                 } else if (m_itemSize.height() <= 0) {
1825                     // The height is dynamic, apply the new height without animation.
1826                     widget->resize(widget->size().width(), itemBounds.height());
1827                 }
1828                 m_animation->start(widget, KItemListViewAnimation::ResizeAnimation, itemBounds.size());
1829             } else {
1830                 widget->resize(itemBounds.size());
1831             }
1832         } else {
1833             animateIconResizing = false;
1834         }
1835
1836         const int newIconSize = widget->styleOption().iconSize;
1837         if (widget->iconSize() != newIconSize) {
1838             if (animateIconResizing) {
1839                 m_animation->start(widget, KItemListViewAnimation::IconResizeAnimation, newIconSize);
1840             } else {
1841                 widget->setIconSize(newIconSize);
1842             }
1843         }
1844
1845         // Updating the cell-information must be done as last step: The decision whether the
1846         // moving-animation should be started at all is based on the previous cell-information.
1847         const Cell cell(m_layouter->itemColumn(i), m_layouter->itemRow(i));
1848         m_visibleCells.insert(i, cell);
1849     }
1850
1851     // Delete invisible KItemListWidget instances that have not been reused
1852     for (int index : qAsConst(reusableItems)) {
1853         recycleWidget(m_visibleItems.value(index));
1854     }
1855
1856     if (supportsExpanding && firstSibblingIndex >= 0) {
1857         Q_ASSERT(lastSibblingIndex >= 0);
1858         updateSiblingsInformation(firstSibblingIndex, lastSibblingIndex);
1859     }
1860
1861     if (m_grouped) {
1862         // Update the layout of all visible group headers
1863         QHashIterator<KItemListWidget *, KItemListGroupHeader *> it(m_visibleGroups);
1864         while (it.hasNext()) {
1865             it.next();
1866             updateGroupHeaderLayout(it.key());
1867         }
1868     }
1869
1870     emitOffsetChanges();
1871 }
1872
1873 QList<int> KItemListView::recycleInvisibleItems(int firstVisibleIndex, int lastVisibleIndex, LayoutAnimationHint hint)
1874 {
1875     // Determine all items that are completely invisible and might be
1876     // reused for items that just got (at least partly) visible. If the
1877     // animation hint is set to 'Animation' items that do e.g. an animated
1878     // moving of their position are not marked as invisible: This assures
1879     // that a scrolling inside the view can be done without breaking an animation.
1880
1881     QList<int> items;
1882
1883     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
1884     while (it.hasNext()) {
1885         it.next();
1886
1887         KItemListWidget *widget = it.value();
1888         const int index = widget->index();
1889         const bool invisible = (index < firstVisibleIndex) || (index > lastVisibleIndex);
1890
1891         if (invisible) {
1892             if (m_animation->isStarted(widget)) {
1893                 if (hint == NoAnimation) {
1894                     // Stopping the animation will call KItemListView::slotAnimationFinished()
1895                     // and the widget will be recycled if necessary there.
1896                     m_animation->stop(widget);
1897                 }
1898             } else {
1899                 widget->setVisible(false);
1900                 items.append(index);
1901
1902                 if (m_grouped) {
1903                     recycleGroupHeaderForWidget(widget);
1904                 }
1905             }
1906         }
1907     }
1908
1909     return items;
1910 }
1911
1912 bool KItemListView::moveWidget(KItemListWidget *widget, const QPointF &newPos)
1913 {
1914     if (widget->pos() == newPos) {
1915         return false;
1916     }
1917
1918     bool startMovingAnim = false;
1919
1920     if (m_itemSize.isEmpty()) {
1921         // The items are not aligned in a grid but either as columns or rows.
1922         startMovingAnim = true;
1923     } else {
1924         // When having a grid the moving-animation should only be started, if it is done within
1925         // one row in the vertical scroll-orientation or one column in the horizontal scroll-orientation.
1926         // Otherwise instead of a moving-animation a create-animation on the new position will be used
1927         // instead. This is done to prevent overlapping (and confusing) moving-animations.
1928         const int index = widget->index();
1929         const Cell cell = m_visibleCells.value(index);
1930         if (cell.column >= 0 && cell.row >= 0) {
1931             if (scrollOrientation() == Qt::Vertical) {
1932                 startMovingAnim = (cell.row == m_layouter->itemRow(index));
1933             } else {
1934                 startMovingAnim = (cell.column == m_layouter->itemColumn(index));
1935             }
1936         }
1937     }
1938
1939     if (startMovingAnim) {
1940         m_animation->start(widget, KItemListViewAnimation::MovingAnimation, newPos);
1941         return true;
1942     }
1943
1944     m_animation->stop(widget);
1945     m_animation->start(widget, KItemListViewAnimation::CreateAnimation);
1946     return false;
1947 }
1948
1949 void KItemListView::emitOffsetChanges()
1950 {
1951     const qreal newScrollOffset = m_layouter->scrollOffset();
1952     if (m_oldScrollOffset != newScrollOffset) {
1953         Q_EMIT scrollOffsetChanged(newScrollOffset, m_oldScrollOffset);
1954         m_oldScrollOffset = newScrollOffset;
1955     }
1956
1957     const qreal newMaximumScrollOffset = m_layouter->maximumScrollOffset();
1958     if (m_oldMaximumScrollOffset != newMaximumScrollOffset) {
1959         Q_EMIT maximumScrollOffsetChanged(newMaximumScrollOffset, m_oldMaximumScrollOffset);
1960         m_oldMaximumScrollOffset = newMaximumScrollOffset;
1961     }
1962
1963     const qreal newItemOffset = m_layouter->itemOffset();
1964     if (m_oldItemOffset != newItemOffset) {
1965         Q_EMIT itemOffsetChanged(newItemOffset, m_oldItemOffset);
1966         m_oldItemOffset = newItemOffset;
1967     }
1968
1969     const qreal newMaximumItemOffset = m_layouter->maximumItemOffset();
1970     if (m_oldMaximumItemOffset != newMaximumItemOffset) {
1971         Q_EMIT maximumItemOffsetChanged(newMaximumItemOffset, m_oldMaximumItemOffset);
1972         m_oldMaximumItemOffset = newMaximumItemOffset;
1973     }
1974 }
1975
1976 KItemListWidget *KItemListView::createWidget(int index)
1977 {
1978     KItemListWidget *widget = widgetCreator()->create(this);
1979     widget->setFlag(QGraphicsItem::ItemStacksBehindParent);
1980
1981     m_visibleItems.insert(index, widget);
1982     m_visibleCells.insert(index, Cell());
1983     updateWidgetProperties(widget, index);
1984     initializeItemListWidget(widget);
1985     return widget;
1986 }
1987
1988 void KItemListView::recycleWidget(KItemListWidget *widget)
1989 {
1990     if (m_grouped) {
1991         recycleGroupHeaderForWidget(widget);
1992     }
1993
1994     const int index = widget->index();
1995     m_visibleItems.remove(index);
1996     m_visibleCells.remove(index);
1997
1998     widgetCreator()->recycle(widget);
1999 }
2000
2001 void KItemListView::setWidgetIndex(KItemListWidget *widget, int index)
2002 {
2003     const int oldIndex = widget->index();
2004     m_visibleItems.remove(oldIndex);
2005     m_visibleCells.remove(oldIndex);
2006
2007     m_visibleItems.insert(index, widget);
2008     m_visibleCells.insert(index, Cell());
2009
2010     widget->setIndex(index);
2011 }
2012
2013 void KItemListView::moveWidgetToIndex(KItemListWidget *widget, int index)
2014 {
2015     const int oldIndex = widget->index();
2016     const Cell oldCell = m_visibleCells.value(oldIndex);
2017
2018     setWidgetIndex(widget, index);
2019
2020     const Cell newCell(m_layouter->itemColumn(index), m_layouter->itemRow(index));
2021     const bool vertical = (scrollOrientation() == Qt::Vertical);
2022     const bool updateCell = (vertical && oldCell.row == newCell.row) || (!vertical && oldCell.column == newCell.column);
2023     if (updateCell) {
2024         m_visibleCells.insert(index, newCell);
2025     }
2026 }
2027
2028 void KItemListView::setLayouterSize(const QSizeF &size, SizeType sizeType)
2029 {
2030     switch (sizeType) {
2031     case LayouterSize:
2032         m_layouter->setSize(size);
2033         break;
2034     case ItemSize:
2035         m_layouter->setItemSize(size);
2036         break;
2037     default:
2038         break;
2039     }
2040 }
2041
2042 void KItemListView::updateWidgetProperties(KItemListWidget *widget, int index)
2043 {
2044     widget->setVisibleRoles(m_visibleRoles);
2045     updateWidgetColumnWidths(widget);
2046     widget->setStyleOption(m_styleOption);
2047
2048     const KItemListSelectionManager *selectionManager = m_controller->selectionManager();
2049
2050     // In SingleSelection mode (e.g., in the Places Panel), the current item is
2051     // always the selected item. It is not necessary to highlight the current item then.
2052     if (m_controller->selectionBehavior() != KItemListController::SingleSelection) {
2053         widget->setCurrent(index == selectionManager->currentItem());
2054     }
2055     widget->setSelected(selectionManager->isSelected(index));
2056     widget->setHovered(false);
2057     widget->setEnabledSelectionToggle(enabledSelectionToggles());
2058     widget->setIndex(index);
2059     widget->setData(m_model->data(index));
2060     widget->setSiblingsInformation(QBitArray());
2061     updateAlternateBackgroundForWidget(widget);
2062
2063     if (m_grouped) {
2064         updateGroupHeaderForWidget(widget);
2065     }
2066 }
2067
2068 void KItemListView::updateGroupHeaderForWidget(KItemListWidget *widget)
2069 {
2070     Q_ASSERT(m_grouped);
2071
2072     const int index = widget->index();
2073     if (!m_layouter->isFirstGroupItem(index)) {
2074         // The widget does not represent the first item of a group
2075         // and hence requires no header
2076         recycleGroupHeaderForWidget(widget);
2077         return;
2078     }
2079
2080     const QList<QPair<int, QVariant>> groups = model()->groups();
2081     if (groups.isEmpty() || !groupHeaderCreator()) {
2082         return;
2083     }
2084
2085     KItemListGroupHeader *groupHeader = m_visibleGroups.value(widget);
2086     if (!groupHeader) {
2087         groupHeader = groupHeaderCreator()->create(this);
2088         groupHeader->setParentItem(widget);
2089         m_visibleGroups.insert(widget, groupHeader);
2090         connect(widget, &KItemListWidget::geometryChanged, this, &KItemListView::slotGeometryOfGroupHeaderParentChanged);
2091     }
2092     Q_ASSERT(groupHeader->parentItem() == widget);
2093
2094     const int groupIndex = groupIndexForItem(index);
2095     Q_ASSERT(groupIndex >= 0);
2096     groupHeader->setData(groups.at(groupIndex).second);
2097     groupHeader->setRole(model()->sortRole());
2098     groupHeader->setStyleOption(m_styleOption);
2099     groupHeader->setScrollOrientation(scrollOrientation());
2100     groupHeader->setItemIndex(index);
2101
2102     groupHeader->show();
2103 }
2104
2105 void KItemListView::updateGroupHeaderLayout(KItemListWidget *widget)
2106 {
2107     KItemListGroupHeader *groupHeader = m_visibleGroups.value(widget);
2108     Q_ASSERT(groupHeader);
2109
2110     const int index = widget->index();
2111     const QRectF groupHeaderRect = m_layouter->groupHeaderRect(index);
2112     const QRectF itemRect = m_layouter->itemRect(index);
2113
2114     // The group-header is a child of the itemlist widget. Translate the
2115     // group header position to the relative position.
2116     if (scrollOrientation() == Qt::Vertical) {
2117         // In the vertical scroll orientation the group header should always span
2118         // the whole width no matter which temporary position the parent widget
2119         // has. In this case the x-position and width will be adjusted manually.
2120         const qreal x = -widget->x() - itemOffset();
2121         const qreal width = maximumItemOffset();
2122         groupHeader->setPos(x, -groupHeaderRect.height());
2123         groupHeader->resize(width, groupHeaderRect.size().height());
2124     } else {
2125         groupHeader->setPos(groupHeaderRect.x() - itemRect.x(), -widget->y());
2126         groupHeader->resize(groupHeaderRect.size());
2127     }
2128 }
2129
2130 void KItemListView::recycleGroupHeaderForWidget(KItemListWidget *widget)
2131 {
2132     KItemListGroupHeader *header = m_visibleGroups.value(widget);
2133     if (header) {
2134         header->setParentItem(nullptr);
2135         groupHeaderCreator()->recycle(header);
2136         m_visibleGroups.remove(widget);
2137         disconnect(widget, &KItemListWidget::geometryChanged, this, &KItemListView::slotGeometryOfGroupHeaderParentChanged);
2138     }
2139 }
2140
2141 void KItemListView::updateVisibleGroupHeaders()
2142 {
2143     Q_ASSERT(m_grouped);
2144     m_layouter->markAsDirty();
2145
2146     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
2147     while (it.hasNext()) {
2148         it.next();
2149         updateGroupHeaderForWidget(it.value());
2150     }
2151 }
2152
2153 int KItemListView::groupIndexForItem(int index) const
2154 {
2155     Q_ASSERT(m_grouped);
2156
2157     const QList<QPair<int, QVariant>> groups = model()->groups();
2158     if (groups.isEmpty()) {
2159         return -1;
2160     }
2161
2162     int min = 0;
2163     int max = groups.count() - 1;
2164     int mid = 0;
2165     do {
2166         mid = (min + max) / 2;
2167         if (index > groups[mid].first) {
2168             min = mid + 1;
2169         } else {
2170             max = mid - 1;
2171         }
2172     } while (groups[mid].first != index && min <= max);
2173
2174     if (min > max) {
2175         while (groups[mid].first > index && mid > 0) {
2176             --mid;
2177         }
2178     }
2179
2180     return mid;
2181 }
2182
2183 void KItemListView::updateAlternateBackgrounds()
2184 {
2185     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
2186     while (it.hasNext()) {
2187         it.next();
2188         updateAlternateBackgroundForWidget(it.value());
2189     }
2190 }
2191
2192 void KItemListView::updateAlternateBackgroundForWidget(KItemListWidget *widget)
2193 {
2194     bool enabled = useAlternateBackgrounds();
2195     if (enabled) {
2196         const int index = widget->index();
2197         enabled = (index & 0x1) > 0;
2198         if (m_grouped) {
2199             const int groupIndex = groupIndexForItem(index);
2200             if (groupIndex >= 0) {
2201                 const QList<QPair<int, QVariant>> groups = model()->groups();
2202                 const int indexOfFirstGroupItem = groups[groupIndex].first;
2203                 const int relativeIndex = index - indexOfFirstGroupItem;
2204                 enabled = (relativeIndex & 0x1) > 0;
2205             }
2206         }
2207     }
2208     widget->setAlternateBackground(enabled);
2209 }
2210
2211 bool KItemListView::useAlternateBackgrounds() const
2212 {
2213     return m_alternateBackgrounds && m_itemSize.isEmpty();
2214 }
2215
2216 QHash<QByteArray, qreal> KItemListView::preferredColumnWidths(const KItemRangeList &itemRanges) const
2217 {
2218     QElapsedTimer timer;
2219     timer.start();
2220
2221     QHash<QByteArray, qreal> widths;
2222
2223     // Calculate the minimum width for each column that is required
2224     // to show the headline unclipped.
2225     const QFontMetricsF fontMetrics(m_headerWidget->font());
2226     const int gripMargin = m_headerWidget->style()->pixelMetric(QStyle::PM_HeaderGripMargin);
2227     const int headerMargin = m_headerWidget->style()->pixelMetric(QStyle::PM_HeaderMargin);
2228     for (const QByteArray &visibleRole : qAsConst(m_visibleRoles)) {
2229         const QString headerText = m_model->roleDescription(visibleRole);
2230         const qreal headerWidth = fontMetrics.horizontalAdvance(headerText) + gripMargin + headerMargin * 2;
2231         widths.insert(visibleRole, headerWidth);
2232     }
2233
2234     // Calculate the preferred column widths for each item and ignore values
2235     // smaller than the width for showing the headline unclipped.
2236     const KItemListWidgetCreatorBase *creator = widgetCreator();
2237     int calculatedItemCount = 0;
2238     bool maxTimeExceeded = false;
2239     for (const KItemRange &itemRange : itemRanges) {
2240         const int startIndex = itemRange.index;
2241         const int endIndex = startIndex + itemRange.count - 1;
2242
2243         for (int i = startIndex; i <= endIndex; ++i) {
2244             for (const QByteArray &visibleRole : qAsConst(m_visibleRoles)) {
2245                 qreal maxWidth = widths.value(visibleRole, 0);
2246                 const qreal width = creator->preferredRoleColumnWidth(visibleRole, i, this);
2247                 maxWidth = qMax(width, maxWidth);
2248                 widths.insert(visibleRole, maxWidth);
2249             }
2250
2251             if (calculatedItemCount > 100 && timer.elapsed() > 200) {
2252                 // When having several thousands of items calculating the sizes can get
2253                 // very expensive. We accept a possibly too small role-size in favour
2254                 // of having no blocking user interface.
2255                 maxTimeExceeded = true;
2256                 break;
2257             }
2258             ++calculatedItemCount;
2259         }
2260         if (maxTimeExceeded) {
2261             break;
2262         }
2263     }
2264
2265     return widths;
2266 }
2267
2268 void KItemListView::applyColumnWidthsFromHeader()
2269 {
2270     // Apply the new size to the layouter
2271     const qreal requiredWidth = columnWidthsSum() + m_headerWidget->sidePadding();
2272     const QSizeF dynamicItemSize(qMax(size().width(), requiredWidth), m_itemSize.height());
2273     m_layouter->setItemSize(dynamicItemSize);
2274
2275     // Update the role sizes for all visible widgets
2276     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
2277     while (it.hasNext()) {
2278         it.next();
2279         updateWidgetColumnWidths(it.value());
2280     }
2281 }
2282
2283 void KItemListView::updateWidgetColumnWidths(KItemListWidget *widget)
2284 {
2285     for (const QByteArray &role : qAsConst(m_visibleRoles)) {
2286         widget->setColumnWidth(role, m_headerWidget->columnWidth(role));
2287     }
2288     widget->setSidePadding(m_headerWidget->sidePadding());
2289 }
2290
2291 void KItemListView::updatePreferredColumnWidths(const KItemRangeList &itemRanges)
2292 {
2293     Q_ASSERT(m_itemSize.isEmpty());
2294     const int itemCount = m_model->count();
2295     int rangesItemCount = 0;
2296     for (const KItemRange &range : itemRanges) {
2297         rangesItemCount += range.count;
2298     }
2299
2300     if (itemCount == rangesItemCount) {
2301         const QHash<QByteArray, qreal> preferredWidths = preferredColumnWidths(itemRanges);
2302         for (const QByteArray &role : qAsConst(m_visibleRoles)) {
2303             m_headerWidget->setPreferredColumnWidth(role, preferredWidths.value(role));
2304         }
2305     } else {
2306         // Only a sub range of the roles need to be determined.
2307         // The chances are good that the widths of the sub ranges
2308         // already fit into the available widths and hence no
2309         // expensive update might be required.
2310         bool changed = false;
2311
2312         const QHash<QByteArray, qreal> updatedWidths = preferredColumnWidths(itemRanges);
2313         QHashIterator<QByteArray, qreal> it(updatedWidths);
2314         while (it.hasNext()) {
2315             it.next();
2316             const QByteArray &role = it.key();
2317             const qreal updatedWidth = it.value();
2318             const qreal currentWidth = m_headerWidget->preferredColumnWidth(role);
2319             if (updatedWidth > currentWidth) {
2320                 m_headerWidget->setPreferredColumnWidth(role, updatedWidth);
2321                 changed = true;
2322             }
2323         }
2324
2325         if (!changed) {
2326             // All the updated sizes are smaller than the current sizes and no change
2327             // of the stretched roles-widths is required
2328             return;
2329         }
2330     }
2331
2332     if (m_headerWidget->automaticColumnResizing()) {
2333         applyAutomaticColumnWidths();
2334     }
2335 }
2336
2337 void KItemListView::updatePreferredColumnWidths()
2338 {
2339     if (m_model) {
2340         updatePreferredColumnWidths(KItemRangeList() << KItemRange(0, m_model->count()));
2341     }
2342 }
2343
2344 void KItemListView::applyAutomaticColumnWidths()
2345 {
2346     Q_ASSERT(m_itemSize.isEmpty());
2347     Q_ASSERT(m_headerWidget->automaticColumnResizing());
2348     if (m_visibleRoles.isEmpty()) {
2349         return;
2350     }
2351
2352     // Calculate the maximum size of an item by considering the
2353     // visible role sizes and apply them to the layouter. If the
2354     // size does not use the available view-size the size of the
2355     // first role will get stretched.
2356
2357     for (const QByteArray &role : qAsConst(m_visibleRoles)) {
2358         const qreal preferredWidth = m_headerWidget->preferredColumnWidth(role);
2359         m_headerWidget->setColumnWidth(role, preferredWidth);
2360     }
2361
2362     const QByteArray firstRole = m_visibleRoles.first();
2363     qreal firstColumnWidth = m_headerWidget->columnWidth(firstRole);
2364     QSizeF dynamicItemSize = m_itemSize;
2365
2366     qreal requiredWidth = columnWidthsSum() + m_headerWidget->sidePadding()
2367         + m_headerWidget->sidePadding(); // Adding the padding a second time so we have the same padding symmetrically on both sides of the view.
2368     // 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.
2369     const qreal availableWidth = size().width();
2370     if (requiredWidth < availableWidth) {
2371         // Stretch the first column to use the whole remaining width
2372         firstColumnWidth += availableWidth - requiredWidth;
2373         m_headerWidget->setColumnWidth(firstRole, firstColumnWidth);
2374     } else if (requiredWidth > availableWidth && m_visibleRoles.count() > 1) {
2375         // Shrink the first column to be able to show as much other
2376         // columns as possible
2377         qreal shrinkedFirstColumnWidth = firstColumnWidth - requiredWidth + availableWidth;
2378
2379         // TODO: A proper calculation of the minimum width depends on the implementation
2380         // of KItemListWidget. Probably a kind of minimum size-hint should be introduced
2381         // later.
2382         const qreal minWidth = qMin(firstColumnWidth, qreal(m_styleOption.iconSize * 2 + 200));
2383         if (shrinkedFirstColumnWidth < minWidth) {
2384             shrinkedFirstColumnWidth = minWidth;
2385         }
2386
2387         m_headerWidget->setColumnWidth(firstRole, shrinkedFirstColumnWidth);
2388         requiredWidth -= firstColumnWidth - shrinkedFirstColumnWidth;
2389     }
2390
2391     dynamicItemSize.rwidth() = qMax(requiredWidth, availableWidth);
2392
2393     m_layouter->setItemSize(dynamicItemSize);
2394
2395     // Update the role sizes for all visible widgets
2396     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
2397     while (it.hasNext()) {
2398         it.next();
2399         updateWidgetColumnWidths(it.value());
2400     }
2401 }
2402
2403 qreal KItemListView::columnWidthsSum() const
2404 {
2405     qreal widthsSum = 0;
2406     for (const QByteArray &role : qAsConst(m_visibleRoles)) {
2407         widthsSum += m_headerWidget->columnWidth(role);
2408     }
2409     return widthsSum;
2410 }
2411
2412 QRectF KItemListView::headerBoundaries() const
2413 {
2414     return m_headerWidget->isVisible() ? m_headerWidget->geometry() : QRectF();
2415 }
2416
2417 bool KItemListView::changesItemGridLayout(const QSizeF &newGridSize, const QSizeF &newItemSize, const QSizeF &newItemMargin) const
2418 {
2419     if (newItemSize.isEmpty() || newGridSize.isEmpty()) {
2420         return false;
2421     }
2422
2423     if (m_layouter->scrollOrientation() == Qt::Vertical) {
2424         const qreal itemWidth = m_layouter->itemSize().width();
2425         if (itemWidth > 0) {
2426             const int newColumnCount = itemsPerSize(newGridSize.width(), newItemSize.width(), newItemMargin.width());
2427             if (m_model->count() > newColumnCount) {
2428                 const int oldColumnCount = itemsPerSize(m_layouter->size().width(), itemWidth, m_layouter->itemMargin().width());
2429                 return oldColumnCount != newColumnCount;
2430             }
2431         }
2432     } else {
2433         const qreal itemHeight = m_layouter->itemSize().height();
2434         if (itemHeight > 0) {
2435             const int newRowCount = itemsPerSize(newGridSize.height(), newItemSize.height(), newItemMargin.height());
2436             if (m_model->count() > newRowCount) {
2437                 const int oldRowCount = itemsPerSize(m_layouter->size().height(), itemHeight, m_layouter->itemMargin().height());
2438                 return oldRowCount != newRowCount;
2439             }
2440         }
2441     }
2442
2443     return false;
2444 }
2445
2446 bool KItemListView::animateChangedItemCount(int changedItemCount) const
2447 {
2448     if (m_itemSize.isEmpty()) {
2449         // We have only columns or only rows, but no grid: An animation is usually
2450         // welcome when inserting or removing items.
2451         return !supportsItemExpanding();
2452     }
2453
2454     if (m_layouter->size().isEmpty() || m_layouter->itemSize().isEmpty()) {
2455         return false;
2456     }
2457
2458     const int maximum = (scrollOrientation() == Qt::Vertical) ? m_layouter->size().width() / m_layouter->itemSize().width()
2459                                                               : m_layouter->size().height() / m_layouter->itemSize().height();
2460     // Only animate if up to 2/3 of a row or column are inserted or removed
2461     return changedItemCount <= maximum * 2 / 3;
2462 }
2463
2464 bool KItemListView::scrollBarRequired(const QSizeF &size) const
2465 {
2466     const QSizeF oldSize = m_layouter->size();
2467
2468     m_layouter->setSize(size);
2469     const qreal maxOffset = m_layouter->maximumScrollOffset();
2470     m_layouter->setSize(oldSize);
2471
2472     return m_layouter->scrollOrientation() == Qt::Vertical ? maxOffset > size.height() : maxOffset > size.width();
2473 }
2474
2475 int KItemListView::showDropIndicator(const QPointF &pos)
2476 {
2477     QHashIterator<int, KItemListWidget *> it(m_visibleItems);
2478     while (it.hasNext()) {
2479         it.next();
2480         const KItemListWidget *widget = it.value();
2481
2482         const QPointF mappedPos = widget->mapFromItem(this, pos);
2483         const QRectF rect = itemRect(widget->index());
2484         if (mappedPos.y() >= 0 && mappedPos.y() <= rect.height()) {
2485             if (m_model->supportsDropping(widget->index())) {
2486                 // Keep 30% of the rectangle as the gap instead of always having a fixed gap
2487                 const int gap = qMax(qreal(4.0), qreal(0.3) * rect.height());
2488                 if (mappedPos.y() >= gap && mappedPos.y() <= rect.height() - gap) {
2489                     return -1;
2490                 }
2491             }
2492
2493             const bool isAboveItem = (mappedPos.y() < rect.height() / 2);
2494             const qreal y = isAboveItem ? rect.top() : rect.bottom();
2495
2496             const QRectF draggingInsertIndicator(rect.left(), y, rect.width(), 1);
2497             if (m_dropIndicator != draggingInsertIndicator) {
2498                 m_dropIndicator = draggingInsertIndicator;
2499                 update();
2500             }
2501
2502             int index = widget->index();
2503             if (!isAboveItem) {
2504                 ++index;
2505             }
2506             return index;
2507         }
2508     }
2509
2510     const QRectF firstItemRect = itemRect(firstVisibleIndex());
2511     return (pos.y() <= firstItemRect.top()) ? 0 : -1;
2512 }
2513
2514 void KItemListView::hideDropIndicator()
2515 {
2516     if (!m_dropIndicator.isNull()) {
2517         m_dropIndicator = QRectF();
2518         update();
2519     }
2520 }
2521
2522 void KItemListView::updateGroupHeaderHeight()
2523 {
2524     qreal groupHeaderHeight = m_styleOption.fontMetrics.height();
2525     qreal groupHeaderMargin = 0;
2526
2527     if (scrollOrientation() == Qt::Horizontal) {
2528         // The vertical margin above and below the header should be
2529         // equal to the horizontal margin, not the vertical margin
2530         // from m_styleOption.
2531         groupHeaderHeight += 2 * m_styleOption.horizontalMargin;
2532         groupHeaderMargin = m_styleOption.horizontalMargin;
2533     } else if (m_itemSize.isEmpty()) {
2534         groupHeaderHeight += 4 * m_styleOption.padding;
2535         groupHeaderMargin = m_styleOption.iconSize / 2;
2536     } else {
2537         groupHeaderHeight += 2 * m_styleOption.padding + m_styleOption.verticalMargin;
2538         groupHeaderMargin = m_styleOption.iconSize / 4;
2539     }
2540     m_layouter->setGroupHeaderHeight(groupHeaderHeight);
2541     m_layouter->setGroupHeaderMargin(groupHeaderMargin);
2542
2543     updateVisibleGroupHeaders();
2544 }
2545
2546 void KItemListView::updateSiblingsInformation(int firstIndex, int lastIndex)
2547 {
2548     if (!supportsItemExpanding() || !m_model) {
2549         return;
2550     }
2551
2552     if (firstIndex < 0 || lastIndex < 0) {
2553         firstIndex = m_layouter->firstVisibleIndex();
2554         lastIndex = m_layouter->lastVisibleIndex();
2555     } else {
2556         const bool isRangeVisible = (firstIndex <= m_layouter->lastVisibleIndex() && lastIndex >= m_layouter->firstVisibleIndex());
2557         if (!isRangeVisible) {
2558             return;
2559         }
2560     }
2561
2562     int previousParents = 0;
2563     QBitArray previousSiblings;
2564
2565     // The rootIndex describes the first index where the siblings get
2566     // calculated from. For the calculation the upper most parent item
2567     // is required. For performance reasons it is checked first whether
2568     // the visible items before or after the current range already
2569     // contain a siblings information which can be used as base.
2570     int rootIndex = firstIndex;
2571
2572     KItemListWidget *widget = m_visibleItems.value(firstIndex - 1);
2573     if (!widget) {
2574         // There is no visible widget before the range, check whether there
2575         // is one after the range:
2576         widget = m_visibleItems.value(lastIndex + 1);
2577         if (widget) {
2578             // The sibling information of the widget may only be used if
2579             // all items of the range have the same number of parents.
2580             const int parents = m_model->expandedParentsCount(lastIndex + 1);
2581             for (int i = lastIndex; i >= firstIndex; --i) {
2582                 if (m_model->expandedParentsCount(i) != parents) {
2583                     widget = nullptr;
2584                     break;
2585                 }
2586             }
2587         }
2588     }
2589
2590     if (widget) {
2591         // Performance optimization: Use the sibling information of the visible
2592         // widget beside the given range.
2593         previousSiblings = widget->siblingsInformation();
2594         if (previousSiblings.isEmpty()) {
2595             return;
2596         }
2597         previousParents = previousSiblings.count() - 1;
2598         previousSiblings.truncate(previousParents);
2599     } else {
2600         // Potentially slow path: Go back to the upper most parent of firstIndex
2601         // to be able to calculate the initial value for the siblings.
2602         while (rootIndex > 0 && m_model->expandedParentsCount(rootIndex) > 0) {
2603             --rootIndex;
2604         }
2605     }
2606
2607     Q_ASSERT(previousParents >= 0);
2608     for (int i = rootIndex; i <= lastIndex; ++i) {
2609         // Update the parent-siblings in case if the current item represents
2610         // a child or an upper parent.
2611         const int currentParents = m_model->expandedParentsCount(i);
2612         Q_ASSERT(currentParents >= 0);
2613         if (previousParents < currentParents) {
2614             previousParents = currentParents;
2615             previousSiblings.resize(currentParents);
2616             previousSiblings.setBit(currentParents - 1, hasSiblingSuccessor(i - 1));
2617         } else if (previousParents > currentParents) {
2618             previousParents = currentParents;
2619             previousSiblings.truncate(currentParents);
2620         }
2621
2622         if (i >= firstIndex) {
2623             // The index represents a visible item. Apply the parent-siblings
2624             // and update the sibling of the current item.
2625             KItemListWidget *widget = m_visibleItems.value(i);
2626             if (!widget) {
2627                 continue;
2628             }
2629
2630             QBitArray siblings = previousSiblings;
2631             siblings.resize(siblings.count() + 1);
2632             siblings.setBit(siblings.count() - 1, hasSiblingSuccessor(i));
2633
2634             widget->setSiblingsInformation(siblings);
2635         }
2636     }
2637 }
2638
2639 bool KItemListView::hasSiblingSuccessor(int index) const
2640 {
2641     bool hasSuccessor = false;
2642     const int parentsCount = m_model->expandedParentsCount(index);
2643     int successorIndex = index + 1;
2644
2645     // Search the next sibling
2646     const int itemCount = m_model->count();
2647     while (successorIndex < itemCount) {
2648         const int currentParentsCount = m_model->expandedParentsCount(successorIndex);
2649         if (currentParentsCount == parentsCount) {
2650             hasSuccessor = true;
2651             break;
2652         } else if (currentParentsCount < parentsCount) {
2653             break;
2654         }
2655         ++successorIndex;
2656     }
2657
2658     if (m_grouped && hasSuccessor) {
2659         // If the sibling is part of another group, don't mark it as
2660         // successor as the group header is between the sibling connections.
2661         for (int i = index + 1; i <= successorIndex; ++i) {
2662             if (m_layouter->isFirstGroupItem(i)) {
2663                 hasSuccessor = false;
2664                 break;
2665             }
2666         }
2667     }
2668
2669     return hasSuccessor;
2670 }
2671
2672 void KItemListView::disconnectRoleEditingSignals(int index)
2673 {
2674     KStandardItemListWidget *widget = qobject_cast<KStandardItemListWidget *>(m_visibleItems.value(index));
2675     if (!widget) {
2676         return;
2677     }
2678
2679     disconnect(widget, &KItemListWidget::roleEditingCanceled, this, nullptr);
2680     disconnect(widget, &KItemListWidget::roleEditingFinished, this, nullptr);
2681     disconnect(this, &KItemListView::scrollOffsetChanged, widget, nullptr);
2682 }
2683
2684 int KItemListView::calculateAutoScrollingIncrement(int pos, int range, int oldInc)
2685 {
2686     int inc = 0;
2687
2688     const int minSpeed = 4;
2689     const int maxSpeed = 128;
2690     const int speedLimiter = 96;
2691     const int autoScrollBorder = 64;
2692
2693     // Limit the increment that is allowed to be added in comparison to 'oldInc'.
2694     // This assures that the autoscrolling speed grows gradually.
2695     const int incLimiter = 1;
2696
2697     if (pos < autoScrollBorder) {
2698         inc = -minSpeed + qAbs(pos - autoScrollBorder) * (pos - autoScrollBorder) / speedLimiter;
2699         inc = qMax(inc, -maxSpeed);
2700         inc = qMax(inc, oldInc - incLimiter);
2701     } else if (pos > range - autoScrollBorder) {
2702         inc = minSpeed + qAbs(pos - range + autoScrollBorder) * (pos - range + autoScrollBorder) / speedLimiter;
2703         inc = qMin(inc, maxSpeed);
2704         inc = qMin(inc, oldInc + incLimiter);
2705     }
2706
2707     return inc;
2708 }
2709
2710 int KItemListView::itemsPerSize(qreal size, qreal itemSize, qreal itemMargin)
2711 {
2712     const qreal availableSize = size - itemMargin;
2713     const int count = availableSize / (itemSize + itemMargin);
2714     return count;
2715 }
2716
2717 KItemListCreatorBase::~KItemListCreatorBase()
2718 {
2719     qDeleteAll(m_recycleableWidgets);
2720     qDeleteAll(m_createdWidgets);
2721 }
2722
2723 void KItemListCreatorBase::addCreatedWidget(QGraphicsWidget *widget)
2724 {
2725     m_createdWidgets.insert(widget);
2726 }
2727
2728 void KItemListCreatorBase::pushRecycleableWidget(QGraphicsWidget *widget)
2729 {
2730     Q_ASSERT(m_createdWidgets.contains(widget));
2731     m_createdWidgets.remove(widget);
2732
2733     if (m_recycleableWidgets.count() < 100) {
2734         m_recycleableWidgets.append(widget);
2735         widget->setVisible(false);
2736     } else {
2737         delete widget;
2738     }
2739 }
2740
2741 QGraphicsWidget *KItemListCreatorBase::popRecycleableWidget()
2742 {
2743     if (m_recycleableWidgets.isEmpty()) {
2744         return nullptr;
2745     }
2746
2747     QGraphicsWidget *widget = m_recycleableWidgets.takeLast();
2748     m_createdWidgets.insert(widget);
2749     return widget;
2750 }
2751
2752 KItemListWidgetCreatorBase::~KItemListWidgetCreatorBase()
2753 {
2754 }
2755
2756 void KItemListWidgetCreatorBase::recycle(KItemListWidget *widget)
2757 {
2758     widget->setParentItem(nullptr);
2759     widget->setOpacity(1.0);
2760     pushRecycleableWidget(widget);
2761 }
2762
2763 KItemListGroupHeaderCreatorBase::~KItemListGroupHeaderCreatorBase()
2764 {
2765 }
2766
2767 void KItemListGroupHeaderCreatorBase::recycle(KItemListGroupHeader *header)
2768 {
2769     header->setOpacity(1.0);
2770     pushRecycleableWidget(header);
2771 }