src/kitemviews/kitemlistview.h

   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 #ifndef KITEMLISTVIEW_H
  10 #define KITEMLISTVIEW_H
  11
  12 #include <optional>
  13
  14 #include "dolphin_export.h"
  15 #include "kitemviews/kitemliststyleoption.h"
  16 #include "kitemviews/kitemlistwidget.h"
  17 #include "kitemviews/kitemmodelbase.h"
  18 #include "kitemviews/kstandarditemlistgroupheader.h"
  19 #include "kitemviews/private/kitemlistviewanimation.h"
  20
  21 #include <QGraphicsWidget>
  22 #include <QSet>
  23
  24 class KItemListController;
  25 class KItemListGroupHeaderCreatorBase;
  26 class KItemListHeader;
  27 class KItemListHeaderWidget;
  28 class KItemListSizeHintResolver;
  29 class KItemListRubberBand;
  30 class KItemListViewAnimation;
  31 class KItemListViewLayouter;
  32 class KItemListWidget;
  33 class KItemListWidgetInformant;
  34 class KItemListWidgetCreatorBase;
  35 class QTimer;
  36 class QPropertyAnimation;
  37 class QVariantAnimation;
  38
  39 /**
  40  * @brief Represents the view of an item-list.
  41  *
  42  * The view is responsible for showing the items of the model within
  43  * a GraphicsItem. Each visible item is represented by a KItemListWidget.
  44  *
  45  * The created view must be applied to the KItemListController with
  46  * KItemListController::setView() or with the constructor of
  47  * KItemListController.
  48  *
  49  * @see KItemListWidget
  50  * @see KItemModelBase
  51  */
  52 class DOLPHIN_EXPORT KItemListView : public QGraphicsWidget
  53 {
  54     Q_OBJECT
  55
  56     Q_PROPERTY(qreal scrollOffset READ scrollOffset WRITE setScrollOffset)
  57     Q_PROPERTY(qreal itemOffset READ itemOffset WRITE setItemOffset)
  58
  59 public:
  60     explicit KItemListView(QGraphicsWidget* parent = nullptr);
  61     ~KItemListView() override;
  62
  63     /**
  64      * Offset of the scrollbar that represents the scroll-orientation
  65      * (see setScrollOrientation()).
  66      */
  67     void setScrollOffset(qreal offset);
  68     qreal scrollOffset() const;
  69
  70     qreal maximumScrollOffset() const;
  71
  72     /**
  73      * Offset related to an item, that does not fit into the available
  74      * size of the listview. If the scroll-orientation is vertical
  75      * the item-offset describes the offset of the horizontal axe, if
  76      * the scroll-orientation is horizontal the item-offset describes
  77      * the offset of the vertical axe.
  78      */
  79     void setItemOffset(qreal scrollOffset);
  80     qreal itemOffset() const;
  81
  82     qreal maximumItemOffset() const;
  83
  84     int maximumVisibleItems() const;
  85
  86     void setVisibleRoles(const QList<QByteArray>& roles);
  87     QList<QByteArray> visibleRoles() const;
  88
  89     /**
  90      * If set to true an automatic scrolling is done as soon as the
  91      * mouse is moved near the borders of the view. Per default
  92      * the automatic scrolling is turned off.
  93      */
  94     void setAutoScroll(bool enabled);
  95     bool autoScroll() const;
  96
  97     /**
  98      * If set to true selection-toggles will be shown when hovering
  99      * an item. Per default the selection-toggles are disabled.
 100      */
 101     void setEnabledSelectionToggles(bool enabled);
 102     bool enabledSelectionToggles() const;
 103
 104     /**
 105      * @return Controller of the item-list. The controller gets
 106      *         initialized by KItemListController::setView() and will
 107      *         result in calling KItemListController::onControllerChanged().
 108      */
 109     KItemListController* controller() const;
 110
 111     /**
 112      * @return Model of the item-list. The model gets
 113      *         initialized by KItemListController::setModel() and will
 114      *         result in calling KItemListController::onModelChanged().
 115      */
 116     KItemModelBase* model() const;
 117
 118     /**
 119      * Sets the creator that creates a widget showing the
 120      * content of one model-item. Usually it is sufficient
 121      * to implement a custom widget X derived from KItemListWidget and
 122      * set the creator by:
 123      * <code>
 124      * itemListView->setWidgetCreator(new KItemListWidgetCreator<X>());
 125      * </code>
 126      * The ownership of the widget creator is transferred to
 127      * the item-list view.
 128      **/
 129     void setWidgetCreator(KItemListWidgetCreatorBase* widgetCreator);
 130     KItemListWidgetCreatorBase* widgetCreator() const;
 131
 132     /**
 133      * Sets the creator that creates a group header. Usually it is sufficient
 134      * to implement a custom header widget X derived from KItemListGroupHeader and
 135      * set the creator by:
 136      * <code>
 137      * itemListView->setGroupHeaderCreator(new KItemListGroupHeaderCreator<X>());
 138      * </code>
 139      * The ownership of the gropup header creator is transferred to
 140      * the item-list view.
 141      **/
 142     void setGroupHeaderCreator(KItemListGroupHeaderCreatorBase* groupHeaderCreator);
 143     KItemListGroupHeaderCreatorBase* groupHeaderCreator() const;
 144
 145     /**
 146      * @return The basic size of all items. The size of an item may be larger than
 147      *         the basic size (see KItemListView::itemRect()).
 148      */
 149     QSizeF itemSize() const;
 150
 151     const KItemListStyleOption& styleOption() const;
 152
 153     void setGeometry(const QRectF& rect) override;
 154
 155     /**
 156      * @return The page step which should be used by the vertical scroll bar.
 157      *         This is the height of the view except for the header widget.
 158      */
 159     qreal verticalPageStep() const;
 160
 161     /**
 162      * @return Index of the item that is below the point \a pos.
 163      *         The position is relative to the upper right of
 164      *         the visible area. Only (at least partly) visible
 165      *         items are considered. std::nullopt is returned if
 166      *         no item is below the position.
 167      */
 168     std::optional<int> itemAt(const QPointF& pos) const;
 169     bool isAboveSelectionToggle(int index, const QPointF& pos) const;
 170     bool isAboveExpansionToggle(int index, const QPointF& pos) const;
 171     bool isAboveText(int index, const QPointF& pos) const;
 172
 173     /**
 174      * @return Index of the first item that is at least partly visible.
 175      *         -1 is returned if the model contains no items.
 176      */
 177     int firstVisibleIndex() const;
 178
 179     /**
 180      * @return Index of the last item that is at least partly visible.
 181      *         -1 is returned if the model contains no items.
 182      */
 183     int lastVisibleIndex() const;
 184
 185     /**
 186      * Calculates the required size for all items in the model.
 187      * It might be larger than KItemListView::itemSize().
 188      * In this case the layout grid will be stretched to assure an
 189      * unclipped item.
 190      *
 191      * @note the logical height (width) is actually the
 192      * width (height) if the scroll orientation is Qt::Vertical!
 193      */
 194     void calculateItemSizeHints(QVector<std::pair<qreal, bool>>& logicalHeightHints, qreal& logicalWidthHint) const;
 195
 196     /**
 197      * If set to true, items having child-items can be expanded to show the child-items as
 198      * part of the view. Per default the expanding of items is disabled. If expanding of
 199      * items is enabled, the methods KItemModelBase::setExpanded(), KItemModelBase::isExpanded(),
 200      * KItemModelBase::isExpandable() and KItemModelBase::expandedParentsCount()
 201      * must be reimplemented. The view-implementation
 202      * has to take care itself how to visually represent the expanded items provided
 203      * by the model.
 204      */
 205     void setSupportsItemExpanding(bool supportsExpanding);
 206     bool supportsItemExpanding() const;
 207
 208     void setHighlightEntireRow(bool highlightEntireRow);
 209     bool highlightEntireRow() const;
 210
 211     void setAlternateBackgrounds(bool alternate);
 212     bool alternateBackgrounds() const;
 213
 214     /**
 215      * @return The rectangle of the item relative to the top/left of
 216      *         the currently visible area (see KItemListView::offset()).
 217      */
 218     QRectF itemRect(int index) const;
 219
 220     /**
 221      * @return The context rectangle of the item relative to the top/left of
 222      *         the currently visible area (see KItemListView::offset()). The
 223      *         context rectangle is defined by the united rectangle of
 224      *         the icon rectangle and the text rectangle (see KItemListWidget::iconRect()
 225      *         and KItemListWidget::textRect()) and is useful as reference for e.g. aligning
 226      *         a tooltip or a context-menu for an item. Note that a context rectangle will
 227      *         only be returned for (at least partly) visible items. An empty rectangle will
 228      *         be returned for fully invisible items.
 229      */
 230     QRectF itemContextRect(int index) const;
 231
 232     /**
 233      * @return Whether or not the name of the file has been elided. At present this will
 234      *         only ever be true when in icons view.
 235      */
 236     bool isElided(int index) const;
 237
 238     /**
 239      * Scrolls to the item with the index \a index so that the item
 240      * will be fully visible.
 241      */
 242     void scrollToItem(int index);
 243
 244     /**
 245      * If several properties of KItemListView are changed synchronously, it is
 246      * recommended to encapsulate the calls between beginTransaction() and endTransaction().
 247      * This prevents unnecessary and expensive layout-calculations.
 248      */
 249     void beginTransaction();
 250
 251     /**
 252      * Counterpart to beginTransaction(). The layout changes will only be animated if
 253      * all property changes between beginTransaction() and endTransaction() support
 254      * animations.
 255      */
 256     void endTransaction();
 257
 258     bool isTransactionActive() const;
 259
 260     /**
 261      * Turns on the header if \p visible is true. Per default the
 262      * header is not visible. Usually the header is turned on when
 263      * showing a classic "table-view" to describe the shown columns.
 264      */
 265     void setHeaderVisible(bool visible);
 266     bool isHeaderVisible() const;
 267
 268     /**
 269      * @return Header of the list. The header is also available if it is not shown
 270      *         (see KItemListView::setHeaderShown()).
 271      */
 272     KItemListHeader* header() const;
 273
 274     /**
 275      * @return Pixmap that is used for a drag operation based on the
 276      *         items given by \a indexes.
 277      */
 278     virtual QPixmap createDragPixmap(const KItemSet& indexes) const;
 279
 280     /**
 281      * Lets the user edit the role \a role for item with the index \a index.
 282      */
 283     void editRole(int index, const QByteArray& role);
 284
 285     void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = nullptr) override;
 286
 287 Q_SIGNALS:
 288     void scrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous);
 289     void scrollOffsetChanged(qreal current, qreal previous);
 290     void maximumScrollOffsetChanged(qreal current, qreal previous);
 291     void itemOffsetChanged(qreal current, qreal previous);
 292     void maximumItemOffsetChanged(qreal current, qreal previous);
 293     void scrollTo(qreal newOffset);
 294
 295     /**
 296      * Is emitted if the user has changed the sort order by clicking on a
 297      * header item (see KItemListView::setHeaderShown()). The sort order
 298      * of the model has already been adjusted to
 299      * the current sort order. Note that no signal will be emitted if the
 300      * sort order of the model has been changed without user interaction.
 301      */
 302     void sortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous);
 303
 304     /**
 305      * Is emitted if the user has changed the sort role by clicking on a
 306      * header item (see KItemListView::setHeaderShown()). The sort role
 307      * of the model has already been adjusted to
 308      * the current sort role. Note that no signal will be emitted if the
 309      * sort role of the model has been changed without user interaction.
 310      */
 311     void sortRoleChanged(const QByteArray& current, const QByteArray& previous);
 312
 313     /**
 314      * Is emitted if the user has changed the visible roles by moving a header
 315      * item (see KItemListView::setHeaderShown()). Note that no signal will be
 316      * emitted if the roles have been changed without user interaction by
 317      * KItemListView::setVisibleRoles().
 318      */
 319     void visibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous);
 320
 321     void roleEditingCanceled(int index, const QByteArray& role, const QVariant& value);
 322     void roleEditingFinished(int index, const QByteArray& role, const QVariant& value);
 323
 324     /**
 325      * Emitted once scrolling has finished, or immediately if no scrolling was necessary
 326      * to get item in view in scrollToItem.
 327      */
 328     void scrollingStopped();
 329
 330 protected:
 331     QVariant itemChange(GraphicsItemChange change, const QVariant &value) override;
 332     void setItemSize(const QSizeF& size);
 333     void setStyleOption(const KItemListStyleOption& option);
 334
 335     /**
 336      * If the scroll-orientation is vertical, the items are ordered
 337      * from top to bottom (= default setting). If the scroll-orientation
 338      * is horizontal, the items are ordered from left to right.
 339      */
 340     void setScrollOrientation(Qt::Orientation orientation);
 341     Qt::Orientation scrollOrientation() const;
 342
 343     /**
 344      * Factory method for creating a default widget-creator. The method will be used
 345      * in case if setWidgetCreator() has not been set by the application.
 346      * @return New instance of the widget-creator that should be used per
 347      *         default.
 348      */
 349     virtual KItemListWidgetCreatorBase* defaultWidgetCreator() const;
 350
 351     /**
 352      * Factory method for creating a default group-header-creator. The method will be used
 353      * in case if setGroupHeaderCreator() has not been set by the application.
 354      * @return New instance of the group-header-creator that should be used per
 355      *         default.
 356      */
 357     virtual KItemListGroupHeaderCreatorBase* defaultGroupHeaderCreator() const;
 358
 359     /**
 360      * Is called when creating a new KItemListWidget instance and allows derived
 361      * classes to do a custom initialization.
 362      */
 363     virtual void initializeItemListWidget(KItemListWidget* item);
 364
 365     /**
 366      * @return True if at least one of the changed roles \p changedRoles might result
 367      *         in the need to update the item-size hint (see KItemListView::itemSizeHint()).
 368      *         Per default true is returned which means on each role-change of existing items
 369      *         the item-size hints are recalculated. For performance reasons it is recommended
 370      *         to return false in case if a role-change will not result in a changed
 371      *         item-size hint.
 372      */
 373     virtual bool itemSizeHintUpdateRequired(const QSet<QByteArray>& changedRoles) const;
 374
 375     virtual void onControllerChanged(KItemListController* current, KItemListController* previous);
 376     virtual void onModelChanged(KItemModelBase* current, KItemModelBase* previous);
 377
 378     virtual void onScrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous);
 379     virtual void onItemSizeChanged(const QSizeF& current, const QSizeF& previous);
 380     virtual void onScrollOffsetChanged(qreal current, qreal previous);
 381     virtual void onVisibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous);
 382     virtual void onStyleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous);
 383     virtual void onHighlightEntireRowChanged(bool highlightEntireRow);
 384     virtual void onSupportsItemExpandingChanged(bool supportsExpanding);
 385
 386     virtual void onTransactionBegin();
 387     virtual void onTransactionEnd();
 388
 389     bool event(QEvent* event) override;
 390     void mousePressEvent(QGraphicsSceneMouseEvent* event) override;
 391     void mouseMoveEvent(QGraphicsSceneMouseEvent* event) override;
 392     void dragEnterEvent(QGraphicsSceneDragDropEvent* event) override;
 393     void dragMoveEvent(QGraphicsSceneDragDropEvent* event) override;
 394     void dragLeaveEvent(QGraphicsSceneDragDropEvent* event) override;
 395     void dropEvent(QGraphicsSceneDragDropEvent* event) override;
 396
 397     QList<KItemListWidget*> visibleItemListWidgets() const;
 398
 399     virtual void updateFont();
 400     virtual void updatePalette();
 401
 402     KItemListSizeHintResolver* m_sizeHintResolver;
 403
 404 protected Q_SLOTS:
 405     virtual void slotItemsInserted(const KItemRangeList& itemRanges);
 406     virtual void slotItemsRemoved(const KItemRangeList& itemRanges);
 407     virtual void slotItemsMoved(const KItemRange& itemRange, const QList<int>& movedToIndexes);
 408     virtual void slotItemsChanged(const KItemRangeList& itemRanges,
 409                                   const QSet<QByteArray>& roles);
 410     virtual void slotGroupsChanged();
 411
 412     virtual void slotGroupedSortingChanged(bool current);
 413     virtual void slotSortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous);
 414     virtual void slotSortRoleChanged(const QByteArray& current, const QByteArray& previous);
 415     virtual void slotCurrentChanged(int current, int previous);
 416     virtual void slotSelectionChanged(const KItemSet& current, const KItemSet& previous);
 417
 418 private Q_SLOTS:
 419     void slotAnimationFinished(QGraphicsWidget* widget,
 420                                KItemListViewAnimation::AnimationType type);
 421     void slotLayoutTimerFinished();
 422
 423     void slotRubberBandPosChanged();
 424     void slotRubberBandActivationChanged(bool active);
 425
 426     /**
 427      * Is invoked if the column-width of one role in the header has
 428      * been changed by the user. The automatic resizing of columns
 429      * will be turned off as soon as this method has been called at
 430      * least once.
 431      */
 432     void slotHeaderColumnWidthChanged(const QByteArray& role,
 433                                       qreal currentWidth,
 434                                       qreal previousWidth);
 435
 436     void slotLeadingPaddingChanged(qreal width);
 437
 438     /**
 439      * Is invoked if a column has been moved by the user. Applies
 440      * the moved role to the view.
 441      */
 442     void slotHeaderColumnMoved(const QByteArray& role,
 443                                int currentIndex,
 444                                int previousIndex);
 445
 446     /**
 447      * Triggers the autoscrolling if autoScroll() is enabled by checking the
 448      * current mouse position. If the mouse position is within the autoscroll
 449      * margins a timer will be started that periodically triggers the autoscrolling.
 450      */
 451     void triggerAutoScrolling();
 452
 453     /**
 454      * Is invoked if the geometry of the parent-widget from a group-header has been
 455      * changed. The x-position and width of the group-header gets adjusted to assure
 456      * that it always spans the whole width even during temporary transitions of the
 457      * parent widget.
 458      */
 459     void slotGeometryOfGroupHeaderParentChanged();
 460
 461     void slotRoleEditingCanceled(int index, const QByteArray& role, const QVariant& value);
 462     void slotRoleEditingFinished(int index, const QByteArray& role, const QVariant& value);
 463
 464 private:
 465     enum LayoutAnimationHint
 466     {
 467         NoAnimation,
 468         Animation
 469     };
 470
 471     enum SizeType
 472     {
 473         LayouterSize,
 474         ItemSize
 475     };
 476
 477     void setController(KItemListController* controller);
 478     void setModel(KItemModelBase* model);
 479
 480     KItemListRubberBand* rubberBand() const;
 481
 482     void doLayout(LayoutAnimationHint hint, int changedIndex = 0, int changedCount = 0);
 483
 484     /**
 485      * Helper method for doLayout: Returns a list of items that can be reused for the visible
 486      * area. Invisible group headers get recycled. The reusable items are items that are
 487      * invisible. If the animation hint is 'Animation' then items that are currently animated
 488      * won't be reused. Reusing items is faster in comparison to deleting invisible
 489      * items and creating a new instance for visible items.
 490      */
 491     QList<int> recycleInvisibleItems(int firstVisibleIndex,
 492                                      int lastVisibleIndex,
 493                                      LayoutAnimationHint hint);
 494
 495     /**
 496      * Helper method for doLayout: Starts a moving-animation for the widget to the given
 497      * new position. The moving-animation is only started if the new position is within
 498      * the same row or column, otherwise the create-animation is used instead.
 499      * @return True if the moving-animation has been applied.
 500      */
 501     bool moveWidget(KItemListWidget* widget, const QPointF& newPos);
 502
 503     void emitOffsetChanges();
 504
 505     KItemListWidget* createWidget(int index);
 506     void recycleWidget(KItemListWidget* widget);
 507
 508     /**
 509      * Changes the index of the widget to \a index and assures a consistent
 510      * update for m_visibleItems and m_visibleCells. The cell-information
 511      * for the new index will not be updated and be initialized as empty cell.
 512      */
 513     void setWidgetIndex(KItemListWidget* widget, int index);
 514
 515     /**
 516      * Changes the index of the widget to \a index. In opposite to
 517      * setWidgetIndex() the cell-information for the widget gets updated.
 518      * This update gives doLayout() the chance to animate the moving
 519      * of the item visually (see moveWidget()).
 520      */
 521     void moveWidgetToIndex(KItemListWidget* widget, int index);
 522
 523     /**
 524      * Helper method for prepareLayoutForIncreasedItemCount().
 525      */
 526     void setLayouterSize(const QSizeF& size, SizeType sizeType);
 527
 528     /**
 529      * Helper method for createWidget() and setWidgetIndex() to update the properties
 530      * of the itemlist widget.
 531      */
 532     void updateWidgetProperties(KItemListWidget* widget, int index);
 533
 534     /**
 535      * Helper method for updateWidgetPropertes() to create or update
 536      * the itemlist group-header.
 537      */
 538     void updateGroupHeaderForWidget(KItemListWidget* widget);
 539
 540     /**
 541      * Updates the position and size of the group-header that belongs
 542      * to the itemlist widget \a widget. The given widget must represent
 543      * the first item of a group.
 544      */
 545     void updateGroupHeaderLayout(KItemListWidget* widget);
 546
 547     /**
 548      * Recycles the group-header for the widget.
 549      */
 550     void recycleGroupHeaderForWidget(KItemListWidget* widget);
 551
 552     /**
 553      * Helper method for slotGroupedSortingChanged(), slotSortOrderChanged()
 554      * and slotSortRoleChanged(): Iterates through all visible items and updates
 555      * the group-header widgets.
 556      */
 557     void updateVisibleGroupHeaders();
 558
 559     /**
 560      * @return Index for the item in the list returned by KItemModelBase::groups()
 561      *         that represents the group where the item with the index \a index
 562      *         belongs to. -1 is returned if no groups are available.
 563      */
 564     int groupIndexForItem(int index) const;
 565
 566     /**
 567      * Updates the alternate background for all visible items.
 568      * @see updateAlternateBackgroundForWidget()
 569      */
 570     void updateAlternateBackgrounds();
 571
 572     /**
 573      * Updates the alternateBackground-property of the widget dependent
 574      * on the state of useAlternateBackgrounds() and the grouping state.
 575      */
 576     void updateAlternateBackgroundForWidget(KItemListWidget* widget);
 577
 578     /**
 579      * @return True if alternate backgrounds should be used for the items.
 580      *         This is the case if an empty item-size is given and if there
 581      *         is more than one visible role.
 582      */
 583     bool useAlternateBackgrounds() const;
 584
 585     /**
 586      * @param itemRanges Items that must be checked for getting the widths of columns.
 587      * @return           The preferred width of the column of each visible role. The width will
 588      *                   be respected if the width of the item size is <= 0 (see
 589      *                   KItemListView::setItemSize()). Per default an empty hash
 590      *                   is returned.
 591      */
 592     QHash<QByteArray, qreal> preferredColumnWidths(const KItemRangeList& itemRanges) const;
 593
 594     /**
 595      * Applies the column-widths from m_headerWidget to the layout
 596      * of the view.
 597      */
 598     void applyColumnWidthsFromHeader();
 599
 600     /**
 601      * Applies the column-widths from m_headerWidget to \a widget.
 602      */
 603     void updateWidgetColumnWidths(KItemListWidget* widget);
 604
 605     /**
 606      * Updates the preferred column-widths of m_groupHeaderWidget by
 607      * invoking KItemListView::columnWidths().
 608      */
 609     void updatePreferredColumnWidths(const KItemRangeList& itemRanges);
 610
 611     /**
 612      * Convenience method for
 613      * updatePreferredColumnWidths(KItemRangeList() << KItemRange(0, m_model->count()).
 614      */
 615     void updatePreferredColumnWidths();
 616
 617     /**
 618      * Resizes the column-widths of m_headerWidget based on the preferred widths
 619      * and the available view-size.
 620      */
 621     void applyAutomaticColumnWidths();
 622
 623     /**
 624      * @return Sum of the widths of all columns.
 625      */
 626     qreal columnWidthsSum() const;
 627
 628     /**
 629      * @return Boundaries of the header. An empty rectangle is returned
 630      *         if no header is shown.
 631      */
 632     QRectF headerBoundaries() const;
 633
 634     /**
 635      * @return True if the number of columns or rows will be changed when applying
 636      *         the new grid- and item-size. Used to determine whether an animation
 637      *         should be done when applying the new layout.
 638      */
 639     bool changesItemGridLayout(const QSizeF& newGridSize,
 640                                const QSizeF& newItemSize,
 641                                const QSizeF& newItemMargin) const;
 642
 643     /**
 644      * @param changedItemCount Number of inserted  or removed items.
 645      * @return                 True if the inserting or removing of items should be animated.
 646      *                         No animation should be done if the number of items is too large
 647      *                         to provide a pleasant animation.
 648      */
 649     bool animateChangedItemCount(int changedItemCount) const;
 650
 651     /**
 652      * @return True if a scrollbar for the given scroll-orientation is required
 653      *         when using a size of \p size for the view. Calling the method is rather
 654      *         expansive as a temporary relayout needs to be done.
 655      */
 656     bool scrollBarRequired(const QSizeF& size) const;
 657
 658     /**
 659      * Shows a drop-indicator between items dependent on the given
 660      * cursor position. The cursor position is relative to the upper left
 661      * edge of the view.
 662      * @return Index of the item where the dropping is done. An index of -1
 663      *         indicates that the item has been dropped after the last item.
 664      */
 665     int showDropIndicator(const QPointF& pos);
 666     void hideDropIndicator();
 667
 668     /**
 669      * Applies the height of the group header to the layouter. The height
 670      * depends on the used scroll orientation.
 671      */
 672     void updateGroupHeaderHeight();
 673
 674     /**
 675      * Updates the siblings-information for all visible items that are inside
 676      * the range of \p firstIndex and \p lastIndex. If firstIndex or lastIndex
 677      * is smaller than 0, the siblings-information for all visible items gets
 678      * updated.
 679      * @see KItemListWidget::setSiblingsInformation()
 680      */
 681     void updateSiblingsInformation(int firstIndex = -1, int lastIndex = -1);
 682
 683     /**
 684      * Helper method for updateExpansionIndicators().
 685      * @return True if the item with the index \a index has a sibling successor
 686      *         (= the item is not the last item of the current hierarchy).
 687      */
 688     bool hasSiblingSuccessor(int index) const;
 689
 690     /**
 691      * Helper method for slotRoleEditingCanceled() and slotRoleEditingFinished().
 692      * Disconnects the two Signals "roleEditingCanceled" and
 693      * "roleEditingFinished"
 694      */
 695     void disconnectRoleEditingSignals(int index);
 696
 697     /**
 698      * Helper function for triggerAutoScrolling().
 699      * @param pos    Logical position of the mouse relative to the range.
 700      * @param range  Range of the visible area.
 701      * @param oldInc Previous increment. Is used to assure that the increment
 702      *               increases only gradually.
 703      * @return Scroll increment that should be added to the offset().
 704      *         As soon as \a pos is inside the autoscroll-margin a
 705      *         value != 0 will be returned.
 706      */
 707     static int calculateAutoScrollingIncrement(int pos, int range, int oldInc);
 708
 709     /**
 710      * Helper functions for changesItemCount().
 711      * @return The number of items that fit into the available size by
 712      *         respecting the size of the item and the margin between the items.
 713      */
 714     static int itemsPerSize(qreal size, qreal itemSize, qreal itemMargin);
 715
 716 private:
 717     bool m_enabledSelectionToggles;
 718     bool m_grouped;
 719     bool m_highlightEntireRow;
 720     bool m_alternateBackgrounds;
 721     bool m_supportsItemExpanding;
 722     bool m_editingRole;
 723     int m_activeTransactions; // Counter for beginTransaction()/endTransaction()
 724     LayoutAnimationHint m_endTransactionAnimationHint;
 725
 726     QSizeF m_itemSize;
 727     KItemListController* m_controller;
 728     KItemModelBase* m_model;
 729     QList<QByteArray> m_visibleRoles;
 730     mutable KItemListWidgetCreatorBase* m_widgetCreator;
 731     mutable KItemListGroupHeaderCreatorBase* m_groupHeaderCreator;
 732     KItemListStyleOption m_styleOption;
 733
 734     QHash<int, KItemListWidget*> m_visibleItems;
 735     QHash<KItemListWidget*, KItemListGroupHeader*> m_visibleGroups;
 736
 737     struct Cell
 738     {
 739         Cell() : column(-1), row(-1) {}
 740         Cell(int c, int r) : column(c), row(r) {}
 741         int column;
 742         int row;
 743     };
 744     QHash<int, Cell> m_visibleCells;
 745
 746     int m_scrollBarExtent;
 747     KItemListViewLayouter* m_layouter;
 748     KItemListViewAnimation* m_animation;
 749
 750     QTimer* m_layoutTimer; // Triggers an asynchronous doLayout() call.
 751     qreal m_oldScrollOffset;
 752     qreal m_oldMaximumScrollOffset;
 753     qreal m_oldItemOffset;
 754     qreal m_oldMaximumItemOffset;
 755
 756     bool m_skipAutoScrollForRubberBand;
 757     KItemListRubberBand* m_rubberBand;
 758     KItemListRubberBand* m_tapAndHoldIndicator;
 759
 760     QPointF m_mousePos;
 761     int m_autoScrollIncrement;
 762     QTimer* m_autoScrollTimer;
 763
 764     KItemListHeader* m_header;
 765     KItemListHeaderWidget* m_headerWidget;
 766
 767     QPropertyAnimation* m_indicatorAnimation;
 768
 769     // When dragging items into the view where the sort-role of the model
 770     // is empty, a visual indicator should be shown during dragging where
 771     // the dropping will happen. This indicator is specified by an index
 772     // of the item. -1 means that no indicator will be shown at all.
 773     // The m_dropIndicator is set by the KItemListController
 774     // by KItemListView::showDropIndicator() and KItemListView::hideDropIndicator().
 775     QRectF m_dropIndicator;
 776
 777     QList<QVariantAnimation*> m_rubberBandAnimations;
 778
 779     friend class KItemListContainer; // Accesses scrollBarRequired()
 780     friend class KItemListHeader;    // Accesses m_headerWidget
 781     friend class KItemListController;
 782     friend class KItemListControllerTest;
 783     friend class KItemListViewAccessible;
 784     friend class KItemListAccessibleCell;
 785 };
 786
 787 /**
 788  * Allows to do a fast logical creation and deletion of QGraphicsWidgets
 789  * by recycling existing QGraphicsWidgets instances. Is used by
 790  * KItemListWidgetCreatorBase and KItemListGroupHeaderCreatorBase.
 791  * @internal
 792  */
 793 class DOLPHIN_EXPORT KItemListCreatorBase
 794 {
 795 public:
 796     virtual ~KItemListCreatorBase();
 797
 798 protected:
 799     void addCreatedWidget(QGraphicsWidget* widget);
 800     void pushRecycleableWidget(QGraphicsWidget* widget);
 801     QGraphicsWidget* popRecycleableWidget();
 802
 803 private:
 804     QSet<QGraphicsWidget*> m_createdWidgets;
 805     QList<QGraphicsWidget*> m_recycleableWidgets;
 806 };
 807
 808 /**
 809  * @brief Base class for creating KItemListWidgets.
 810  *
 811  * It is recommended that applications simply use the KItemListWidgetCreator-template class.
 812  * For a custom implementation the methods create(), itemSizeHint() and preferredColumnWith()
 813  * must be reimplemented. The intention of the widget creator is to prevent repetitive and
 814  * expensive instantiations and deletions of KItemListWidgets by recycling existing widget
 815  * instances.
 816  */
 817 class DOLPHIN_EXPORT KItemListWidgetCreatorBase : public KItemListCreatorBase
 818 {
 819 public:
 820     ~KItemListWidgetCreatorBase() override;
 821
 822     virtual KItemListWidget* create(KItemListView* view) = 0;
 823
 824     virtual void recycle(KItemListWidget* widget);
 825
 826     virtual void calculateItemSizeHints(QVector<std::pair<qreal, bool>>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const = 0;
 827
 828     virtual qreal preferredRoleColumnWidth(const QByteArray& role,
 829                                            int index,
 830                                            const KItemListView* view) const = 0;
 831 };
 832
 833 /**
 834  * @brief Template class for creating KItemListWidgets.
 835  */
 836 template <class T>
 837 class KItemListWidgetCreator : public KItemListWidgetCreatorBase
 838 {
 839 public:
 840     KItemListWidgetCreator();
 841     ~KItemListWidgetCreator() override;
 842
 843     KItemListWidget* create(KItemListView* view) override;
 844
 845     void calculateItemSizeHints(QVector<std::pair<qreal, bool>>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const override;
 846
 847     qreal preferredRoleColumnWidth(const QByteArray& role,
 848                                            int index,
 849                                            const KItemListView* view) const override;
 850 private:
 851     KItemListWidgetInformant* m_informant;
 852 };
 853
 854 template <class T>
 855 KItemListWidgetCreator<T>::KItemListWidgetCreator() :
 856     m_informant(T::createInformant())
 857 {
 858 }
 859
 860 template <class T>
 861 KItemListWidgetCreator<T>::~KItemListWidgetCreator()
 862 {
 863     delete m_informant;
 864 }
 865
 866 template <class T>
 867 KItemListWidget* KItemListWidgetCreator<T>::create(KItemListView* view)
 868 {
 869     KItemListWidget* widget = static_cast<KItemListWidget*>(popRecycleableWidget());
 870     if (!widget) {
 871         widget = new T(m_informant, view);
 872         addCreatedWidget(widget);
 873     }
 874     widget->setParentItem(view);
 875     return widget;
 876 }
 877
 878 template<class T>
 879 void KItemListWidgetCreator<T>::calculateItemSizeHints(QVector<std::pair<qreal, bool>>& logicalHeightHints, qreal& logicalWidthHint, const KItemListView* view) const
 880 {
 881     return m_informant->calculateItemSizeHints(logicalHeightHints, logicalWidthHint, view);
 882 }
 883
 884 template<class T>
 885 qreal KItemListWidgetCreator<T>::preferredRoleColumnWidth(const QByteArray& role,
 886                                                           int index,
 887                                                           const KItemListView* view) const
 888 {
 889     return m_informant->preferredRoleColumnWidth(role, index, view);
 890 }
 891
 892 /**
 893  * @brief Base class for creating KItemListGroupHeaders.
 894  *
 895  * It is recommended that applications simply use the KItemListGroupHeaderCreator-template class.
 896  * For a custom implementation the methods create() and recycle() must be reimplemented.
 897  * The intention of the group-header creator is to prevent repetitive and expensive instantiations and
 898  * deletions of KItemListGroupHeaders by recycling existing header instances.
 899  */
 900 class DOLPHIN_EXPORT KItemListGroupHeaderCreatorBase : public KItemListCreatorBase
 901 {
 902 public:
 903     ~KItemListGroupHeaderCreatorBase() override;
 904     virtual KItemListGroupHeader* create(KItemListView* view) = 0;
 905     virtual void recycle(KItemListGroupHeader* header);
 906 };
 907
 908 template <class T>
 909 class KItemListGroupHeaderCreator : public KItemListGroupHeaderCreatorBase
 910 {
 911 public:
 912     ~KItemListGroupHeaderCreator() override;
 913     KItemListGroupHeader* create(KItemListView* view) override;
 914 };
 915
 916 template <class T>
 917 KItemListGroupHeaderCreator<T>::~KItemListGroupHeaderCreator()
 918 {
 919 }
 920
 921 template <class T>
 922 KItemListGroupHeader* KItemListGroupHeaderCreator<T>::create(KItemListView* view)
 923 {
 924     KItemListGroupHeader* widget = static_cast<KItemListGroupHeader*>(popRecycleableWidget());
 925     if (!widget) {
 926         widget = new T(view);
 927         addCreatedWidget(widget);
 928     }
 929     return widget;
 930 }
 931
 932 #endif