]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/kitemviews/kitemlistview.h
Remember sort settings
[dolphin.git] / src / kitemviews / kitemlistview.h
index 091d2c36b90b6ff46f77c58bbf666b6f276b48de..a56a8db59f60a713c41b0c6064366a0d36d26291 100644 (file)
@@ -25,6 +25,7 @@
 
 #include <libdolphin_export.h>
 
+#include <kitemviews/kitemlistgroupheader.h>
 #include <kitemviews/kitemliststyleoption.h>
 #include <kitemviews/kitemlistviewanimation_p.h>
 #include <kitemviews/kitemlistwidget.h>
@@ -33,7 +34,6 @@
 #include <QSet>
 
 class KItemListController;
-class KItemListGroupHeader;
 class KItemListGroupHeaderCreatorBase;
 class KItemListHeader;
 class KItemListSizeHintResolver;
@@ -66,6 +66,7 @@ class LIBDOLPHINPRIVATE_EXPORT KItemListView : public QGraphicsWidget
     Q_OBJECT
 
     Q_PROPERTY(qreal scrollOffset READ scrollOffset WRITE setScrollOffset)
+    Q_PROPERTY(qreal itemOffset READ itemOffset WRITE setItemOffset)
 
 public:
     KItemListView(QGraphicsWidget* parent = 0);
@@ -100,11 +101,11 @@ public:
     bool autoScroll() const;
 
     /**
-     * Turns on the header if \p show is true. Per default the
-     * header is not shown.
+     * If set to true selection-toggles will be shown when hovering
+     * an item. Per default the selection-toggles are disabled.
      */
-    void setHeaderShown(bool show);
-    bool isHeaderShown() const;
+    void setEnabledSelectionToggles(bool enabled);
+    bool enabledSelectionToggles() const;
 
     /**
      * @return Controller of the item-list. The controller gets
@@ -168,10 +169,38 @@ public:
     virtual QHash<QByteArray, QSizeF> visibleRolesSizes(const KItemRangeList& itemRanges) const;
 
     /**
-     * @return The bounding rectangle of the item relative to the top/left of
+     * @return True if the view supports the expanding of items. Per default false
+     *         is returned. If expanding of items is supported, the methods
+     *         KItemModelBase::setExpanded(), KItemModelBase::isExpanded() and
+     *         KItemModelBase::isExpandable() must be reimplemented. The view-implementation
+     *         has to take care itself how to visually represent the expanded items provided
+     *         by the model.
+     */
+    virtual bool supportsItemExpanding() const;
+
+    /**
+     * @return The rectangle of the item relative to the top/left of
      *         the currently visible area (see KItemListView::offset()).
      */
-    QRectF itemBoundingRect(int index) const;
+    QRectF itemRect(int index) const;
+
+    /**
+     * @return The context rectangle of the item relative to the top/left of
+     *         the currently visible area (see KItemListView::offset()). The
+     *         context rectangle is defined by by the united rectangle of
+     *         the icon rectangle and the text rectangle (see KItemListWidget::iconRect()
+     *         and KItemListWidget::textRect()) and is useful as reference for e.g. aligning
+     *         a tooltip or a context-menu for an item. Note that a context rectangle will
+     *         only be returned for (at least partly) visible items. An empty rectangle will
+     *         be returned for fully invisible items.
+     */
+    QRectF itemContextRect(int index) const;
+
+    /**
+     * Scrolls to the item with the index \a index so that the item
+     * will be fully visible.
+     */
+    void scrollToItem(int index);
 
     /**
      * @return The number of items that can be shown in parallel for one offset.
@@ -186,6 +215,13 @@ public:
     void endTransaction();
     bool isTransactionActive() const;
 
+    /**
+     * Turns on the header if \p show is true. Per default the
+     * header is not shown.
+     */
+    void setHeaderShown(bool show);
+    bool isHeaderShown() const;
+
     /**
      * @return Pixmap that is used for a drag operation based on the
      *         items given by \a indexes. The default implementation returns
@@ -199,12 +235,31 @@ public:
     virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = 0);
 
 signals:
+    void scrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous);
     void scrollOffsetChanged(qreal current, qreal previous);
     void maximumScrollOffsetChanged(qreal current, qreal previous);
     void itemOffsetChanged(qreal current, qreal previous);
     void maximumItemOffsetChanged(qreal current, qreal previous);
     void scrollTo(qreal newOffset);
 
+    /**
+     * Is emitted if the user has changed the sort order by clicking on a
+     * header item (see KItemListView::setHeaderShown()). The sort order
+     * of the model has already been adjusted to
+     * the current sort order. Note that no signal will be emitted if the
+     * sort order of the model has been changed without user interaction.
+     */
+    void sortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous);
+
+    /**
+     * Is emitted if the user has changed the sort role by clicking on a
+     * header item (see KItemListView::setHeaderShown()). The sort role
+     * of the model has already been adjusted to
+     * the current sort role. Note that no signal will be emitted if the
+     * sort role of the model has been changed without user interaction.
+     */
+    void sortRoleChanged(const QByteArray& current, const QByteArray& previous);
+
 protected:
     virtual void initializeItemListWidget(KItemListWidget* item);
 
@@ -246,12 +301,17 @@ protected:
 protected slots:
     virtual void slotItemsInserted(const KItemRangeList& itemRanges);
     virtual void slotItemsRemoved(const KItemRangeList& itemRanges);
+    virtual void slotItemsMoved(const KItemRange& itemRange, const QList<int>& movedToIndexes);
     virtual void slotItemsChanged(const KItemRangeList& itemRanges,
                                   const QSet<QByteArray>& roles);
 
+    virtual void slotGroupedSortingChanged(bool current);
+    virtual void slotSortOrderChanged(Qt::SortOrder current, Qt::SortOrder previous);
+    virtual void slotSortRoleChanged(const QByteArray& current, const QByteArray& previous);
+    virtual void slotCurrentChanged(int current, int previous);
+    virtual void slotSelectionChanged(const QSet<int>& current, const QSet<int>& previous);
+
 private slots:
-    void slotCurrentChanged(int current, int previous);
-    void slotSelectionChanged(const QSet<int>& current, const QSet<int>& previous);
     void slotAnimationFinished(QGraphicsWidget* widget,
                                KItemListViewAnimation::AnimationType type);
     void slotLayoutTimerFinished();
@@ -294,7 +354,6 @@ private:
 
     KItemListRubberBand* rubberBand() const;
 
-    void updateLayout();
     void doLayout(LayoutAnimationHint hint, int changedIndex, int changedCount);
     void doGroupHeadersLayout(LayoutAnimationHint hint, int changedIndex, int changedCount);
     void emitOffsetChanges();
@@ -326,10 +385,29 @@ private:
     void updateWidgetProperties(KItemListWidget* widget, int index);
 
     /**
-     * Updates the width of the KItemListHeader corresponding to the required width of
-     * the roles.
+     * Helper method for createWidget() and setWidgetIndex() to create or update
+     * the itemlist group-header.
+     */
+    void updateGroupHeaderForWidget(KItemListWidget* widget);
+
+    /**
+     * Updates the position and size of the group-header that belongs
+     * to the itemlist widget \a widget. The given widget must represent
+     * the first item of a group.
+     */
+    void updateGroupHeaderLayout(KItemListWidget* widget);
+
+    /**
+     * Recycles the group-header from the widget.
+     */
+    void recycleGroupHeaderForWidget(KItemListWidget* widget);
+
+    /**
+     * Helper method for slotGroupedSortingChanged(), slotSortOrderChanged()
+     * and slotSortRoleChanged(): Iterates through all visible items and updates
+     * the group-header widgets.
      */
-    void updateHeaderWidth();
+    void updateVisibleGroupHeaders();
 
     /**
      * @return The widths of each visible role that is shown in the KItemListHeader.
@@ -337,16 +415,40 @@ private:
     QHash<QByteArray, qreal> headerRolesWidths() const;
 
     /**
-     * Updates m_visibleRoleSizes by calling KItemListView::visibleRoleSizes()
-     * if the m_itemRect is empty and no custom header-widths are used
-     * (see m_useHeaderWidths).
+     * Updates m_visibleRolesSizes by calling KItemListView::visibleRolesSizes().
+     * Nothing will be done if m_itemRect is not empty or custom header-widths
+     * are used (see m_useHeaderWidths). Also m_strechedVisibleRolesSizes will be adjusted
+     * to respect the available view-size.
      */
-    void updateVisibleRoleSizes(const KItemRangeList& itemRanges);
+    void updateVisibleRolesSizes(const KItemRangeList& itemRanges);
 
     /**
      * Convenience method for updateVisibleRoleSizes(KItemRangeList() << KItemRange(0, m_model->count()).
      */
-    void updateVisibleRoleSizes();
+    void updateVisibleRolesSizes();
+
+    /**
+     * Updates m_stretchedVisibleRolesSizes based on m_visibleRolesSizes and the available
+     * view-size. Nothing will be done if m_itemRect is not empty or custom header-widths
+     * are used (see m_useHeaderWidths).
+     */
+    void updateStretchedVisibleRolesSizes();
+
+    /**
+     * @return Sum of the widths of all visible roles.
+     */
+    qreal visibleRolesSizesWidthSum() const;
+
+    /**
+     * @return Sum of the heights of all visible roles.
+     */
+    qreal visibleRolesSizesHeightSum() const;
+
+    /**
+     * @return Boundaries of the header. An empty rectangle is returned
+     *         if no header is shown.
+     */
+    QRectF headerBoundaries() const;
 
     /**
      * Helper function for triggerAutoScrolling().
@@ -361,6 +463,7 @@ private:
     static int calculateAutoScrollingIncrement(int pos, int range, int oldInc);
 
 private:
+    bool m_enabledSelectionToggles;
     bool m_grouped;
     int m_activeTransactions; // Counter for beginTransaction()/endTransaction()
 
@@ -369,6 +472,7 @@ private:
     KItemModelBase* m_model;
     QList<QByteArray> m_visibleRoles;
     QHash<QByteArray, QSizeF> m_visibleRolesSizes;
+    QHash<QByteArray, QSizeF> m_stretchedVisibleRolesSizes;
     KItemListWidgetCreatorBase* m_widgetCreator;
     KItemListGroupHeaderCreatorBase* m_groupHeaderCreator;
     KItemListStyleOption m_styleOption;
@@ -473,7 +577,7 @@ class LIBDOLPHINPRIVATE_EXPORT KItemListGroupHeaderCreatorBase : public KItemLis
 {
 public:
     virtual ~KItemListGroupHeaderCreatorBase();
-    virtual KItemListGroupHeader* create(QGraphicsWidget* parent) = 0;
+    virtual KItemListGroupHeader* create(KItemListView* view) = 0;
     virtual void recycle(KItemListGroupHeader* header);
 };
 
@@ -482,7 +586,7 @@ class LIBDOLPHINPRIVATE_EXPORT KItemListGroupHeaderCreator : public KItemListGro
 {
 public:
     virtual ~KItemListGroupHeaderCreator();
-    virtual KItemListGroupHeader* create(QGraphicsWidget* parent);
+    virtual KItemListGroupHeader* create(KItemListView* view);
 };
 
 template <class T>
@@ -491,11 +595,11 @@ KItemListGroupHeaderCreator<T>::~KItemListGroupHeaderCreator()
 }
 
 template <class T>
-KItemListGroupHeader* KItemListGroupHeaderCreator<T>::create(QGraphicsWidget* parent)
+KItemListGroupHeader* KItemListGroupHeaderCreator<T>::create(KItemListView* view)
 {
     KItemListGroupHeader* widget = static_cast<KItemListGroupHeader*>(popRecycleableWidget());
     if (!widget) {
-        widget = new T(parent);
+        widget = new T(view);
         addCreatedWidget(widget);
     }
     return widget;