src/kitemviews/kfileitemlistwidget.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 KFILEITEMLISTWIDGET_H
  21 #define KFILEITEMLISTWIDGET_H
  22
  23 #include <libdolphin_export.h>
  24
  25 #include <kitemviews/kitemlistwidget.h>
  26
  27 #include <QPixmap>
  28 #include <QPointF>
  29 #include <QStaticText>
  30
  31 class KItemListView;
  32 class KItemListStyleOption;
  33
  34 class LIBDOLPHINPRIVATE_EXPORT KFileItemListWidget : public KItemListWidget
  35 {
  36     Q_OBJECT
  37
  38 public:
  39     enum Layout
  40     {
  41         IconsLayout,
  42         CompactLayout,
  43         DetailsLayout
  44     };
  45
  46     KFileItemListWidget(QGraphicsItem* parent);
  47     virtual ~KFileItemListWidget();
  48
  49     void setLayout(Layout layout);
  50     Layout layout() const;
  51
  52     void setSupportsItemExpanding(bool supportsItemExpanding);
  53     bool supportsItemExpanding() const;
  54
  55     virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = 0);
  56
  57     virtual QRectF iconRect() const;
  58     virtual QRectF textRect() const;
  59     virtual QRectF expansionToggleRect() const;
  60     virtual QRectF selectionToggleRect() const;
  61
  62     /**
  63      * Implementation of KItemListWidgetCreatorBase::itemSizeHint() when
  64      * using the KItemListWidgetCreator-template.
  65      *
  66      * @see KItemListView
  67      */
  68     static QSizeF itemSizeHint(int index, const KItemListView* view);
  69
  70     /**
  71      * Implementation of KItemListWidgetCreatorBase::preferredRoleColumnWidth() when
  72      * using the KItemListWidgetCreator-template.
  73      *
  74      * @see KItemListView
  75      */
  76     static qreal preferredRoleColumnWidth(const QByteArray& role, int index, const KItemListView* view);
  77
  78 protected:
  79     /**
  80      * Invalidates the cache which results in calling KFileItemListWidget::refreshCache() as
  81      * soon as the item need to gets repainted.
  82      */
  83     void invalidateCache();
  84
  85     /**
  86      * Is called if the cache got invalidated by KFileItemListWidget::invalidateCache().
  87      * The default implementation is empty.
  88      */
  89     virtual void refreshCache();
  90
  91     void setTextColor(const QColor& color);
  92     QColor textColor() const;
  93
  94     void setOverlay(const QPixmap& overlay);
  95     QPixmap overlay() const;
  96
  97     virtual void dataChanged(const QHash<QByteArray, QVariant>& current, const QSet<QByteArray>& roles = QSet<QByteArray>());
  98     virtual void visibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous);
  99     virtual void columnWidthChanged(const QByteArray& role, qreal current, qreal previous);
 100     virtual void styleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous);
 101     virtual void hoveredChanged(bool hovered);
 102     virtual void selectedChanged(bool selected);
 103     virtual void siblingsInformationChanged(const QBitArray& current, const QBitArray& previous);
 104     virtual void resizeEvent(QGraphicsSceneResizeEvent* event);
 105     virtual void showEvent(QShowEvent* event);
 106     virtual void hideEvent(QHideEvent* event);
 107
 108 private slots:
 109     void slotCutItemsChanged();
 110
 111 private:
 112     enum RoleType {
 113         Name,
 114         Size,
 115         Date,
 116         Generic  // Mandatory last entry
 117     };
 118
 119     void triggerCacheRefreshing();
 120     void updateExpansionArea();
 121     void updatePixmapCache();
 122
 123     void updateTextsCache();
 124     void updateIconsLayoutTextCache();
 125     void updateCompactLayoutTextCache();
 126     void updateDetailsLayoutTextCache();
 127
 128     void updateAdditionalInfoTextColor();
 129
 130     void drawPixmap(QPainter* painter, const QPixmap& pixmap);
 131     void drawSiblingsInformation(QPainter* painter);
 132
 133     static QPixmap pixmapForIcon(const QString& name, int size);
 134     static void applyCutEffect(QPixmap& pixmap);
 135     static void applyHiddenEffect(QPixmap& pixmap);
 136     static RoleType roleType(const QByteArray& role);
 137
 138     /**
 139      * @return Shown string for the role \p role of the item with the values \p values.
 140      */
 141     static QString roleText(const QByteArray& role, const QHash<QByteArray, QVariant>& values);
 142
 143 private:
 144     bool m_isCut;
 145     bool m_isHidden;
 146     bool m_isExpandable;
 147     bool m_supportsItemExpanding;
 148
 149     bool m_dirtyLayout;
 150     bool m_dirtyContent;
 151     QSet<QByteArray> m_dirtyContentRoles;
 152
 153     Layout m_layout;
 154     QPointF m_pixmapPos;
 155     QPixmap m_pixmap;
 156     QSize m_scaledPixmapSize;
 157
 158     QRectF m_iconRect;          // Cache for KItemListWidget::iconRect()
 159     QPixmap m_hoverPixmap;      // Cache for modified m_pixmap when hovering the item
 160
 161     struct TextInfo
 162     {
 163         QPointF pos;
 164         QStaticText staticText;
 165     };
 166     QHash<QByteArray, TextInfo*> m_textInfo;
 167
 168     QRectF m_textRect;
 169
 170     QList<QByteArray> m_sortedVisibleRoles;
 171
 172     QRectF m_expansionArea;
 173
 174     QColor m_customTextColor;
 175     QColor m_additionalInfoTextColor;
 176
 177     QPixmap m_overlay;
 178 };
 179
 180 #endif
 181
 182