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 LIBDOLPHINPRIVATE_EXPORT KFileItemListWidget : public KItemListWidget
  32 {
  33     Q_OBJECT
  34
  35 public:
  36     enum Layout
  37     {
  38         IconsLayout,
  39         CompactLayout,
  40         DetailsLayout
  41     };
  42
  43     KFileItemListWidget(QGraphicsItem* parent);
  44     virtual ~KFileItemListWidget();
  45
  46     void setLayout(Layout layout);
  47     Layout layout() const;
  48
  49     virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = 0);
  50
  51     virtual QRectF iconRect() const;
  52     virtual QRectF textRect() const;
  53     virtual QRectF expansionToggleRect() const;
  54     virtual QRectF selectionToggleRect() const;
  55
  56     /**
  57      * @return Shown string for the role \p role of the item with the values \p values.
  58      */
  59     // TODO: Move this method to a helper class shared by KFileItemListWidget and
  60     // KFileItemListView to share information that is required to calculate the size hints
  61     // in KFileItemListView and to represent the actual data in KFileItemListWidget.
  62     static QString roleText(const QByteArray& role, const QHash<QByteArray, QVariant>& values);
  63
  64 protected:
  65     /**
  66      * Invalidates the cache which results in calling KFileItemListWidget::refreshCache() as
  67      * soon as the item need to gets repainted.
  68      */
  69     void invalidateCache();
  70
  71     /**
  72      * Is called if the cache got invalidated by KFileItemListWidget::invalidateCache().
  73      * The default implementation is empty.
  74      */
  75     virtual void refreshCache();
  76
  77     void setTextColor(const QColor& color);
  78     QColor textColor() const;
  79
  80     void setOverlay(const QPixmap& overlay);
  81     QPixmap overlay() const;
  82
  83     virtual void dataChanged(const QHash<QByteArray, QVariant>& current, const QSet<QByteArray>& roles = QSet<QByteArray>());
  84     virtual void visibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous);
  85     virtual void visibleRolesSizesChanged(const QHash<QByteArray, QSizeF>& current, const QHash<QByteArray, QSizeF>& previous);
  86     virtual void styleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous);
  87     virtual void hoveredChanged(bool hovered);
  88     virtual void selectedChanged(bool selected);
  89     virtual void resizeEvent(QGraphicsSceneResizeEvent* event);
  90     virtual void showEvent(QShowEvent* event);
  91     virtual void hideEvent(QHideEvent* event);
  92
  93 private slots:
  94     void slotCutItemsChanged();
  95
  96 private:
  97     enum TextId {
  98         Name,
  99         Size,
 100         Date,
 101         Permissions,
 102         Owner,
 103         Group,
 104         Type,
 105         Destination,
 106         Path,
 107         TextIdCount // Mandatory last entry
 108     };
 109
 110     void triggerCacheRefreshing();
 111     void updateExpansionArea();
 112     void updatePixmapCache();
 113
 114     void updateTextsCache();
 115     void updateIconsLayoutTextCache();
 116     void updateCompactLayoutTextCache();
 117     void updateDetailsLayoutTextCache();
 118
 119     void updateAdditionalInfoTextColor();
 120
 121     void drawPixmap(QPainter* painter, const QPixmap& pixmap);
 122
 123     static QPixmap pixmapForIcon(const QString& name, int size);
 124     static TextId roleTextId(const QByteArray& role);
 125     static void applyCutEffect(QPixmap& pixmap);
 126     static void applyHiddenEffect(QPixmap& pixmap);
 127
 128 private:
 129     bool m_isCut;
 130     bool m_isHidden;
 131     bool m_isExpandable;
 132
 133     bool m_dirtyLayout;
 134     bool m_dirtyContent;
 135     QSet<QByteArray> m_dirtyContentRoles;
 136
 137     Layout m_layout;
 138     QPointF m_pixmapPos;
 139     QPixmap m_pixmap;
 140     QSize m_scaledPixmapSize;
 141
 142     QSize m_originalPixmapSize; // Size of pixmap before it gets converted to a square pixmap
 143     QRectF m_iconRect;          // Cache for KItemListWidget::iconRect()
 144     QPixmap m_hoverPixmap;      // Cache for modified m_pixmap when hovering the item
 145
 146     QPointF m_textPos[TextIdCount];
 147     QStaticText m_text[TextIdCount];
 148     QRectF m_textRect;
 149
 150     QList<QByteArray> m_sortedVisibleRoles;
 151
 152     QRectF m_expansionArea;
 153
 154     QColor m_customTextColor;
 155     QColor m_additionalInfoTextColor;
 156
 157     QPixmap m_overlay;
 158 };
 159
 160 #endif
 161
 162