src/kitemviews/kitemlistview.h

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   Based on the Itemviews NG project from Trolltech Labs:                *
   5  *   http://qt.gitorious.org/qt-labs/itemviews-ng                          *
   6  *                                                                         *
   7  *   This program is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU General Public License as published by  *
   9  *   the Free Software Foundation; either version 2 of the License, or     *
  10  *   (at your option) any later version.                                   *
  11  *                                                                         *
  12  *   This program is distributed in the hope that it will be useful,       *
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  15  *   GNU General Public License for more details.                          *
  16  *                                                                         *
  17  *   You should have received a copy of the GNU General Public License     *
  18  *   along with this program; if not, write to the                         *
  19  *   Free Software Foundation, Inc.,                                       *
  20  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  21  ***************************************************************************/
  22
  23 #ifndef KITEMLISTVIEW_H
  24 #define KITEMLISTVIEW_H
  25
  26 #include <libdolphin_export.h>
  27
  28 #include <kitemviews/kitemlistgroupheader.h>
  29 #include <kitemviews/kitemliststyleoption.h>
  30 #include <kitemviews/kitemlistviewanimation_p.h>
  31 #include <kitemviews/kitemlistwidget.h>
  32 #include <kitemviews/kitemmodelbase.h>
  33 #include <QGraphicsWidget>
  34 #include <QSet>
  35
  36 class KItemListController;
  37 class KItemListGroupHeaderCreatorBase;
  38 class KItemListHeader;
  39 class KItemListSizeHintResolver;
  40 class KItemListRubberBand;
  41 class KItemListViewAnimation;
  42 class KItemListViewLayouter;
  43 class KItemListWidget;
  44 class KItemListWidgetCreatorBase;
  45 class KItemListViewCreatorBase;
  46 class QTimer;
  47
  48 /**
  49  * @brief Represents the view of an item-list.
  50  *
  51  * The view is responsible for showing the items of the model within
  52  * a GraphicsItem. Each visible item is represented by a KItemListWidget.
  53  *
  54  * The created view must be applied to the KItemListController with
  55  * KItemListController::setView(). For showing a custom model it is not
  56  * mandatory to derive from KItemListView, all that is necessary is
  57  * to set a widget-creator that is capable to create KItemListWidgets
  58  * showing the model items. A widget-creator can be set with
  59  * KItemListView::setWidgetCreator().
  60  *
  61  * @see KItemListWidget
  62  * @see KItemModelBase
  63  */
  64 class LIBDOLPHINPRIVATE_EXPORT KItemListView : public QGraphicsWidget
  65 {
  66     Q_OBJECT
  67
  68     Q_PROPERTY(qreal scrollOffset READ scrollOffset WRITE setScrollOffset)
  69     Q_PROPERTY(qreal itemOffset READ itemOffset WRITE setItemOffset)
  70
  71 public:
  72     KItemListView(QGraphicsWidget* parent = 0);
  73     virtual ~KItemListView();
  74
  75     void setScrollOrientation(Qt::Orientation orientation);
  76     Qt::Orientation scrollOrientation() const;
  77
  78     void setItemSize(const QSizeF& size);
  79     QSizeF itemSize() const;
  80
  81     // TODO: add note that offset is not checked against maximumOffset, only against 0.
  82     void setScrollOffset(qreal offset);
  83     qreal scrollOffset() const;
  84
  85     qreal maximumScrollOffset() const;
  86
  87     void setItemOffset(qreal scrollOffset);
  88     qreal itemOffset() const;
  89
  90     qreal maximumItemOffset() const;
  91
  92     void setVisibleRoles(const QList<QByteArray>& roles);
  93     QList<QByteArray> visibleRoles() const;
  94
  95     /**
  96      * If set to true an automatic scrolling is done as soon as the
  97      * mouse is moved near the borders of the view. Per default
  98      * the automatic scrolling is turned off.
  99      */
 100     void setAutoScroll(bool enabled);
 101     bool autoScroll() const;
 102
 103     /**
 104      * If set to true selection-toggles will be shown when hovering
 105      * an item. Per default the selection-toggles are disabled.
 106      */
 107     void setEnabledSelectionToggles(bool enabled);
 108     bool enabledSelectionToggles() const;
 109
 110     /**
 111      * @return Controller of the item-list. The controller gets
 112      *         initialized by KItemListController::setView() and will
 113      *         result in calling KItemListController::onControllerChanged().
 114      */
 115     KItemListController* controller() const;
 116
 117     /**
 118      * @return Model of the item-list. The model gets
 119      *         initialized by KItemListController::setView() and will
 120      *         result in calling KItemListController::onModelChanged().
 121      */
 122     KItemModelBase* model() const;
 123
 124     /**
 125      * Sets the creator that creates a widget showing the
 126      * content of one model-item. Usually it is sufficient
 127      * to implement a custom widget X derived from KItemListWidget and
 128      * set the creator by:
 129      * <code>
 130      * itemListView->setWidgetCreator(new KItemListWidgetCreator<X>());
 131      * </code>
 132      * Note that the ownership of the widget creator is not transferred to
 133      * the item-list view: One instance of a widget creator might get shared
 134      * by several item-list view instances.
 135      **/
 136     void setWidgetCreator(KItemListWidgetCreatorBase* widgetCreator);
 137     KItemListWidgetCreatorBase* widgetCreator() const;
 138
 139     void setGroupHeaderCreator(KItemListGroupHeaderCreatorBase* groupHeaderCreator);
 140     KItemListGroupHeaderCreatorBase* groupHeaderCreator() const;
 141
 142     void setStyleOption(const KItemListStyleOption& option);
 143     const KItemListStyleOption& styleOption() const;
 144
 145     /** @reimp */
 146     virtual void setGeometry(const QRectF& rect);
 147
 148     int itemAt(const QPointF& pos) const;
 149     bool isAboveSelectionToggle(int index, const QPointF& pos) const;
 150     bool isAboveExpansionToggle(int index, const QPointF& pos) const;
 151
 152     int firstVisibleIndex() const;
 153     int lastVisibleIndex() const;
 154
 155     /**
 156      * @return Required size for the item with the index \p index.
 157      *         Per default KItemListView::itemSize() is returned.
 158      *         When reimplementing this method it is recommended to
 159      *         also reimplement KItemListView::itemSizeHintUpdateRequired().
 160      */
 161     virtual QSizeF itemSizeHint(int index) const;
 162
 163     /**
 164      * @param itemRanges Items that must be checked for getting the visible roles sizes.
 165      * @return The size of each visible role in case if KItemListView::itemSize()
 166      *         is empty. This allows to have dynamic but equal role sizes between
 167      *         all items. Per default an empty hash is returned.
 168      */
 169     virtual QHash<QByteArray, QSizeF> visibleRolesSizes(const KItemRangeList& itemRanges) const;
 170
 171     /**
 172      * @return True if the view supports the expanding of items. Per default false
 173      *         is returned. If expanding of items is supported, the methods
 174      *         KItemModelBase::setExpanded(), KItemModelBase::isExpanded() and
 175      *         KItemModelBase::isExpandable() must be reimplemented. The view-implementation
 176      *         has to take care itself how to visually represent the expanded items provided
 177      *         by the model.
 178      */
 179     virtual bool supportsItemExpanding() const;
 180
 181     /**
 182      * @return The rectangle of the item relative to the top/left of
 183      *         the currently visible area (see KItemListView::offset()).
 184      */
 185     QRectF itemRect(int index) const;
 186
 187     /**
 188      * @return The context rectangle of the item relative to the top/left of
 189      *         the currently visible area (see KItemListView::offset()). The
 190      *         context rectangle is defined by by the united rectangle of
 191      *         the icon rectangle and the text rectangle (see KItemListWidget::iconRect()
 192      *         and KItemListWidget::textRect()) and is useful as reference for e.g. aligning
 193      *         a tooltip or a context-menu for an item. Note that a context rectangle will
 194      *         only be returned for (at least partly) visible items. An empty rectangle will
 195      *         be returned for fully invisible items.
 196      */
 197     QRectF itemContextRect(int index) const;
 198
 199     /**
 200      * Scrolls to the item with the index \a index so that the item
 201      * will be fully visible.
 202      */
 203     void scrollToItem(int index);
 204
 205     void beginTransaction();
 206     void endTransaction();
 207     bool isTransactionActive() const;
 208
 209     /**
 210      * Turns on the header if \p show is true. Per default the
 211      * header is not shown.
 212      */
 213     void setHeaderShown(bool show);
 214     bool isHeaderShown() const;
 215
 216     /**
 217      * @return Pixmap that is used for a drag operation based on the
 218      *         items given by \a indexes. The default implementation returns
 219      *         a null-pixmap.
 220      */
 221     virtual QPixmap createDragPixmap(const QSet<int>& indexes) const;
 222
 223     /**
 224      * @reimp
 225      */
 226     virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = 0);
 227
 228 signals:
 229     void scrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous);
 230     void scrollOffsetChanged(qreal current, qreal previous);
 231     void maximumScrollOffsetChanged(qreal current, qreal previous);
 232     void itemOffsetChanged(qreal current, qreal previous);
 233     void maximumItemOffsetChanged(qreal current, qreal previous);
 234     void scrollTo(qreal newOffset);
 235
 236     /**
 237      * Is emitted if the user has changed the sort order by clicking on a
 238      * header item (see KItemListView::setHeaderShown()). The sort order
 239      * of the model has already been adjusted to
 240      * the current sort order. Note that no signal will be emitted if the
 241      * sort order of the model has been changed without user interaction.
 242      */
 243     void sortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous);
 244
 245     /**
 246      * Is emitted if the user has changed the sort role by clicking on a
 247      * header item (see KItemListView::setHeaderShown()). The sort role
 248      * of the model has already been adjusted to
 249      * the current sort role. Note that no signal will be emitted if the
 250      * sort role of the model has been changed without user interaction.
 251      */
 252     void sortRoleChanged(const QByteArray& current, const QByteArray& previous);
 253
 254 protected:
 255     virtual void initializeItemListWidget(KItemListWidget* item);
 256
 257     /**
 258      * @return True if at least one of the changed roles \p changedRoles might result
 259      *         in the need to update the item-size hint (see KItemListView::itemSizeHint()).
 260      *         Per default true is returned which means on each role-change of existing items
 261      *         the item-size hints are recalculated. For performance reasons it is recommended
 262      *         to return false in case if a role-change will not result in a changed
 263      *         item-size hint.
 264      */
 265     virtual bool itemSizeHintUpdateRequired(const QSet<QByteArray>& changedRoles) const;
 266
 267     virtual void onControllerChanged(KItemListController* current, KItemListController* previous);
 268     virtual void onModelChanged(KItemModelBase* current, KItemModelBase* previous);
 269
 270     virtual void onScrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous);
 271     virtual void onItemSizeChanged(const QSizeF& current, const QSizeF& previous);
 272     virtual void onScrollOffsetChanged(qreal current, qreal previous);
 273     virtual void onVisibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous);
 274     virtual void onStyleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous);
 275
 276     virtual void onTransactionBegin();
 277     virtual void onTransactionEnd();
 278
 279     virtual bool event(QEvent* event);
 280     virtual void mousePressEvent(QGraphicsSceneMouseEvent* event);
 281     virtual void mouseMoveEvent(QGraphicsSceneMouseEvent* event);
 282     virtual void dragEnterEvent(QGraphicsSceneDragDropEvent* event);
 283     virtual void dragMoveEvent(QGraphicsSceneDragDropEvent* event);
 284     virtual void dragLeaveEvent(QGraphicsSceneDragDropEvent* event);
 285     virtual void dropEvent(QGraphicsSceneDragDropEvent* event);
 286
 287     QList<KItemListWidget*> visibleItemListWidgets() const;
 288
 289 protected slots:
 290     virtual void slotItemsInserted(const KItemRangeList& itemRanges);
 291     virtual void slotItemsRemoved(const KItemRangeList& itemRanges);
 292     virtual void slotItemsMoved(const KItemRange& itemRange, const QList<int>& movedToIndexes);
 293     virtual void slotItemsChanged(const KItemRangeList& itemRanges,
 294                                   const QSet<QByteArray>& roles);
 295
 296     virtual void slotGroupedSortingChanged(bool current);
 297     virtual void slotSortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous);
 298     virtual void slotSortRoleChanged(const QByteArray& current, const QByteArray& previous);
 299     virtual void slotCurrentChanged(int current, int previous);
 300     virtual void slotSelectionChanged(const QSet<int>& current, const QSet<int>& previous);
 301
 302 private slots:
 303     void slotAnimationFinished(QGraphicsWidget* widget,
 304                                KItemListViewAnimation::AnimationType type);
 305     void slotLayoutTimerFinished();
 306
 307     void slotRubberBandPosChanged();
 308     void slotRubberBandActivationChanged(bool active);
 309
 310     /**
 311      * Is invoked if the visible role-width of one role in the header has
 312      * been changed by the user. It is remembered that the user has modified
 313      * the role-width, so that it won't be changed anymore automatically to
 314      * calculate an optimized width.
 315      */
 316     void slotVisibleRoleWidthChanged(const QByteArray& role,
 317                                      qreal currentWidth,
 318                                      qreal previousWidth);
 319
 320     /**
 321      * Triggers the autoscrolling if autoScroll() is enabled by checking the
 322      * current mouse position. If the mouse position is within the autoscroll
 323      * margins a timer will be started that periodically triggers the autoscrolling.
 324      */
 325     void triggerAutoScrolling();
 326
 327 private:
 328     enum LayoutAnimationHint
 329     {
 330         NoAnimation,
 331         Animation
 332     };
 333
 334     enum SizeType
 335     {
 336         LayouterSize,
 337         ItemSize
 338     };
 339
 340     void setController(KItemListController* controller);
 341     void setModel(KItemModelBase* model);
 342
 343     KItemListRubberBand* rubberBand() const;
 344
 345     void doLayout(LayoutAnimationHint hint, int changedIndex = 0, int changedCount = 0);
 346
 347     void emitOffsetChanges();
 348
 349     KItemListWidget* createWidget(int index);
 350     void recycleWidget(KItemListWidget* widget);
 351     void setWidgetIndex(KItemListWidget* widget, int index);
 352
 353     /**
 354      * Helper method for setGeometry() and setItemSize(): Calling both methods might result
 355      * in a changed number of visible items. To assure that currently invisible items can
 356      * get animated from the old position to the new position prepareLayoutForIncreasedItemCount()
 357      * takes care to create all item widgets that are visible with the old or the new size.
 358      * @param size     Size of the layouter or the item dependent on \p sizeType.
 359      * @param sizeType LayouterSize: KItemListLayouter::setSize() is used.
 360      *                 ItemSize: KItemListLayouter::setItemSize() is used.
 361      */
 362     void prepareLayoutForIncreasedItemCount(const QSizeF& size, SizeType sizeType);
 363
 364     /**
 365      * Helper method for prepareLayoutForIncreasedItemCount().
 366      */
 367     void setLayouterSize(const QSizeF& size, SizeType sizeType);
 368
 369     /**
 370      * Helper method for createWidget() and setWidgetIndex() to update the properties
 371      * of the itemlist widget.
 372      */
 373     void updateWidgetProperties(KItemListWidget* widget, int index);
 374
 375     /**
 376      * Helper method for createWidget() and setWidgetIndex() to create or update
 377      * the itemlist group-header.
 378      */
 379     void updateGroupHeaderForWidget(KItemListWidget* widget);
 380
 381     /**
 382      * Updates the position and size of the group-header that belongs
 383      * to the itemlist widget \a widget. The given widget must represent
 384      * the first item of a group.
 385      */
 386     void updateGroupHeaderLayout(KItemListWidget* widget);
 387
 388     /**
 389      * Recycles the group-header from the widget.
 390      */
 391     void recycleGroupHeaderForWidget(KItemListWidget* widget);
 392
 393     /**
 394      * Helper method for slotGroupedSortingChanged(), slotSortOrderChanged()
 395      * and slotSortRoleChanged(): Iterates through all visible items and updates
 396      * the group-header widgets.
 397      */
 398     void updateVisibleGroupHeaders();
 399
 400     /**
 401      * @return The widths of each visible role that is shown in the KItemListHeader.
 402      */
 403     QHash<QByteArray, qreal> headerRolesWidths() const;
 404
 405     /**
 406      * Updates m_visibleRolesSizes by calling KItemListView::visibleRolesSizes().
 407      * Nothing will be done if m_itemRect is not empty or custom header-widths
 408      * are used (see m_useHeaderWidths). Also m_strechedVisibleRolesSizes will be adjusted
 409      * to respect the available view-size.
 410      */
 411     void updateVisibleRolesSizes(const KItemRangeList& itemRanges);
 412
 413     /**
 414      * Convenience method for updateVisibleRoleSizes(KItemRangeList() << KItemRange(0, m_model->count()).
 415      */
 416     void updateVisibleRolesSizes();
 417
 418     /**
 419      * Updates m_stretchedVisibleRolesSizes based on m_visibleRolesSizes and the available
 420      * view-size. Nothing will be done if m_itemRect is not empty or custom header-widths
 421      * are used (see m_useHeaderWidths).
 422      */
 423     void updateStretchedVisibleRolesSizes();
 424
 425     /**
 426      * @return Sum of the widths of all visible roles.
 427      */
 428     qreal visibleRolesSizesWidthSum() const;
 429
 430     /**
 431      * @return Sum of the heights of all visible roles.
 432      */
 433     qreal visibleRolesSizesHeightSum() const;
 434
 435     /**
 436      * @return Boundaries of the header. An empty rectangle is returned
 437      *         if no header is shown.
 438      */
 439     QRectF headerBoundaries() const;
 440
 441     /**
 442      * Helper function for triggerAutoScrolling().
 443      * @param pos    Logical position of the mouse relative to the range.
 444      * @param range  Range of the visible area.
 445      * @param oldInc Previous increment. Is used to assure that the increment
 446      *               increases only gradually.
 447      * @return Scroll increment that should be added to the offset().
 448      *         As soon as \a pos is inside the autoscroll-margin a
 449      *         value != 0 will be returned.
 450      */
 451     static int calculateAutoScrollingIncrement(int pos, int range, int oldInc);
 452
 453 private:
 454     bool m_enabledSelectionToggles;
 455     bool m_grouped;
 456     int m_activeTransactions; // Counter for beginTransaction()/endTransaction()
 457
 458     QSizeF m_itemSize;
 459     KItemListController* m_controller;
 460     KItemModelBase* m_model;
 461     QList<QByteArray> m_visibleRoles;
 462     QHash<QByteArray, QSizeF> m_visibleRolesSizes;
 463     QHash<QByteArray, QSizeF> m_stretchedVisibleRolesSizes;
 464     KItemListWidgetCreatorBase* m_widgetCreator;
 465     KItemListGroupHeaderCreatorBase* m_groupHeaderCreator;
 466     KItemListStyleOption m_styleOption;
 467
 468     QHash<int, KItemListWidget*> m_visibleItems;
 469     QHash<KItemListWidget*, KItemListGroupHeader*> m_visibleGroups;
 470
 471     int m_scrollBarExtent;
 472     KItemListSizeHintResolver* m_sizeHintResolver;
 473     KItemListViewLayouter* m_layouter;
 474     KItemListViewAnimation* m_animation;
 475
 476     QTimer* m_layoutTimer; // Triggers an asynchronous doLayout() call.
 477     qreal m_oldScrollOffset;
 478     qreal m_oldMaximumScrollOffset;
 479     qreal m_oldItemOffset;
 480     qreal m_oldMaximumItemOffset;
 481
 482     bool m_skipAutoScrollForRubberBand;
 483     KItemListRubberBand* m_rubberBand;
 484
 485     QPointF m_mousePos;
 486     int m_autoScrollIncrement;
 487     QTimer* m_autoScrollTimer;
 488
 489     KItemListHeader* m_header;
 490     bool m_useHeaderWidths;
 491
 492     friend class KItemListController;
 493 };
 494
 495 /**
 496  * Allows to do a fast logical creation and deletion of QGraphicsWidgets
 497  * by recycling existing QGraphicsWidgets instances. Is used by
 498  * KItemListWidgetCreatorBase and KItemListGroupHeaderCreatorBase.
 499  * @internal
 500  */
 501 class LIBDOLPHINPRIVATE_EXPORT KItemListCreatorBase
 502 {
 503 public:
 504     virtual ~KItemListCreatorBase();
 505
 506 protected:
 507     void addCreatedWidget(QGraphicsWidget* widget);
 508     void pushRecycleableWidget(QGraphicsWidget* widget);
 509     QGraphicsWidget* popRecycleableWidget();
 510
 511 private:
 512     QSet<QGraphicsWidget*> m_createdWidgets;
 513     QList<QGraphicsWidget*> m_recycleableWidgets;
 514 };
 515
 516 /**
 517  * @brief Base class for creating KItemListWidgets.
 518  *
 519  * It is recommended that applications simply use the KItemListWidgetCreator-template class.
 520  * For a custom implementation the methods create() and recyle() must be reimplemented.
 521  * The intention of the widget creator is to prevent repetitive and expensive instantiations and
 522  * deletions of KItemListWidgets by recycling existing widget instances.
 523  */
 524 class LIBDOLPHINPRIVATE_EXPORT KItemListWidgetCreatorBase : public KItemListCreatorBase
 525 {
 526 public:
 527     virtual ~KItemListWidgetCreatorBase();
 528     virtual KItemListWidget* create(KItemListView* view) = 0;
 529     virtual void recycle(KItemListWidget* widget);
 530 };
 531
 532 template <class T>
 533 class KItemListWidgetCreator : public KItemListWidgetCreatorBase
 534 {
 535 public:
 536     virtual ~KItemListWidgetCreator();
 537     virtual KItemListWidget* create(KItemListView* view);
 538 };
 539
 540 template <class T>
 541 KItemListWidgetCreator<T>::~KItemListWidgetCreator()
 542 {
 543 }
 544
 545 template <class T>
 546 KItemListWidget* KItemListWidgetCreator<T>::create(KItemListView* view)
 547 {
 548     KItemListWidget* widget = static_cast<KItemListWidget*>(popRecycleableWidget());
 549     if (!widget) {
 550         widget = new T(view);
 551         addCreatedWidget(widget);
 552     }
 553     return widget;
 554 }
 555
 556 /**
 557  * @brief Base class for creating KItemListGroupHeaders.
 558  *
 559  * It is recommended that applications simply use the KItemListGroupHeaderCreator-template class.
 560  * For a custom implementation the methods create() and recyle() must be reimplemented.
 561  * The intention of the group-header creator is to prevent repetitive and expensive instantiations and
 562  * deletions of KItemListGroupHeaders by recycling existing header instances.
 563  */
 564 class LIBDOLPHINPRIVATE_EXPORT KItemListGroupHeaderCreatorBase : public KItemListCreatorBase
 565 {
 566 public:
 567     virtual ~KItemListGroupHeaderCreatorBase();
 568     virtual KItemListGroupHeader* create(KItemListView* view) = 0;
 569     virtual void recycle(KItemListGroupHeader* header);
 570 };
 571
 572 template <class T>
 573 class KItemListGroupHeaderCreator : public KItemListGroupHeaderCreatorBase
 574 {
 575 public:
 576     virtual ~KItemListGroupHeaderCreator();
 577     virtual KItemListGroupHeader* create(KItemListView* view);
 578 };
 579
 580 template <class T>
 581 KItemListGroupHeaderCreator<T>::~KItemListGroupHeaderCreator()
 582 {
 583 }
 584
 585 template <class T>
 586 KItemListGroupHeader* KItemListGroupHeaderCreator<T>::create(KItemListView* view)
 587 {
 588     KItemListGroupHeader* widget = static_cast<KItemListGroupHeader*>(popRecycleableWidget());
 589     if (!widget) {
 590         widget = new T(view);
 591         addCreatedWidget(widget);
 592     }
 593     return widget;
 594 }
 595
 596 #endif