src/kitemviews/kfileitemlistview.h

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef KFILEITEMLISTVIEW_H
  21 #define KFILEITEMLISTVIEW_H
  22
  23 #include <libdolphin_export.h>
  24
  25 #include <kitemviews/kitemlistview.h>
  26
  27 class KFileItemModelRolesUpdater;
  28 class QTimer;
  29
  30 /**
  31  * @brief View that allows to show the content of file-items.
  32  *
  33  * The corresponding model set by the controller must be an instance
  34  * of KFileItemModel. Per default KFileItemListWidget is set as widget creator
  35  * value and KItemListGroupHeader as group-header creator value. Use
  36  * KItemListView::setWidgetCreator() and KItemListView::setGroupHeaderCreator()
  37  * to apply customized generators.
  38  */
  39 class LIBDOLPHINPRIVATE_EXPORT KFileItemListView : public KItemListView
  40 {
  41     Q_OBJECT
  42
  43 public:
  44     enum Layout
  45     {
  46         IconsLayout,
  47         CompactLayout,
  48         DetailsLayout
  49     };
  50
  51     KFileItemListView(QGraphicsWidget* parent = 0);
  52     virtual ~KFileItemListView();
  53
  54     void setPreviewsShown(bool show);
  55     bool previewsShown() const;
  56
  57     void setItemLayout(Layout layout);
  58     Layout itemLayout() const;
  59
  60     /** @reimp */
  61     virtual QSizeF itemSizeHint(int index) const;
  62
  63     /** @reimp */
  64     virtual QHash<QByteArray, QSizeF> visibleRolesSizes(const KItemRangeList& itemRanges) const;
  65
  66     /** @reimp */
  67     virtual bool supportsItemExpanding() const;
  68
  69     /** @reimp */
  70     virtual QPixmap createDragPixmap(const QSet<int>& indexes) const;
  71
  72 protected:
  73     virtual void initializeItemListWidget(KItemListWidget* item);
  74     virtual bool itemSizeHintUpdateRequired(const QSet<QByteArray>& changedRoles) const;
  75     virtual void onModelChanged(KItemModelBase* current, KItemModelBase* previous);
  76     virtual void onScrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous);
  77     virtual void onItemSizeChanged(const QSizeF& current, const QSizeF& previous);
  78     virtual void onScrollOffsetChanged(qreal current, qreal previous);
  79     virtual void onVisibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous);
  80     virtual void onStyleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous);
  81     virtual void onTransactionBegin();
  82     virtual void onTransactionEnd();
  83     virtual void resizeEvent(QGraphicsSceneResizeEvent* event);
  84
  85 protected slots:
  86     virtual void slotItemsRemoved(const KItemRangeList& itemRanges);
  87     virtual void slotSortRoleChanged(const QByteArray& current, const QByteArray& previous);
  88
  89 private slots:
  90     void triggerVisibleIndexRangeUpdate();
  91     void updateVisibleIndexRange();
  92
  93     void triggerIconSizeUpdate();
  94     void updateIconSize();
  95
  96 private:
  97     QSizeF visibleRoleSizeHint(int index, const QByteArray& role) const;
  98     void updateLayoutOfVisibleItems();
  99     void updateTimersInterval();
 100     void updateMinimumRolesWidths();
 101
 102     /**
 103      * Applies the roles defined by KItemListView::visibleRoles() to the
 104      * KFileItemModel and KFileItemModelRolesUpdater. As the model does not
 105      * distinct between visible and invisible roles also internal roles
 106      * are applied that are mandatory for having a working KFileItemModel.
 107      */
 108     void applyRolesToModel();
 109
 110 private:
 111     Layout m_itemLayout;
 112
 113     KFileItemModelRolesUpdater* m_modelRolesUpdater;
 114     QTimer* m_updateVisibleIndexRangeTimer;
 115     QTimer* m_updateIconSizeTimer;
 116
 117     // Cache for calculating visibleRoleSizes() in a fast way
 118     QHash<QByteArray, int> m_minimumRolesWidths;
 119
 120     friend class KFileItemListViewTest; // For unit testing
 121 };
 122
 123 #endif
 124
 125