src/kitemviews/kstandarditemlistwidget.h

   1 /***************************************************************************
   2  *   Copyright (C) 2012 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 KSTANDARDITEMLISTWIDGET_H
  21 #define KSTANDARDITEMLISTWIDGET_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 KItemListRoleEditor;
  32 class KItemListStyleOption;
  33 class KItemListView;
  34
  35 class LIBDOLPHINPRIVATE_EXPORT KStandardItemListWidgetInformant : public KItemListWidgetInformant
  36 {
  37 public:
  38     KStandardItemListWidgetInformant();
  39     virtual ~KStandardItemListWidgetInformant();
  40
  41     virtual QSizeF itemSizeHint(int index, const KItemListView* view) const;
  42
  43     virtual qreal preferredRoleColumnWidth(const QByteArray& role,
  44                                            int index,
  45                                            const KItemListView* view) const;
  46 protected:
  47     /**
  48      * @return String representation of the role \a role. The representation of
  49      *         a role might depend on other roles, so the values of all roles
  50      *         are passed as parameter.
  51      */
  52     virtual QString roleText(const QByteArray& role,
  53                              const QHash<QByteArray, QVariant>& values) const;
  54
  55     friend class KStandardItemListWidget; // Accesses roleText()
  56 };
  57
  58 /**
  59  * @brief Itemlist widget implementation for KStandardItemView and KStandardItemModel.
  60  */
  61 class LIBDOLPHINPRIVATE_EXPORT KStandardItemListWidget : public KItemListWidget
  62 {
  63     Q_OBJECT
  64
  65 public:
  66     enum Layout
  67     {
  68         IconsLayout,
  69         CompactLayout,
  70         DetailsLayout
  71     };
  72
  73     KStandardItemListWidget(KItemListWidgetInformant* informant, QGraphicsItem* parent);
  74     virtual ~KStandardItemListWidget();
  75
  76     void setLayout(Layout layout);
  77     Layout layout() const;
  78
  79     void setSupportsItemExpanding(bool supportsItemExpanding);
  80     bool supportsItemExpanding() const;
  81
  82     virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = 0);
  83
  84     virtual QRectF iconRect() const;
  85     virtual QRectF textRect() const;
  86     virtual QRectF textFocusRect() const;
  87     virtual QRectF expansionToggleRect() const;
  88     virtual QRectF selectionToggleRect() const;
  89
  90     static KItemListWidgetInformant* createInformant();
  91
  92 protected:
  93     /**
  94      * Invalidates the cache which results in calling KStandardItemListWidget::refreshCache() as
  95      * soon as the item need to gets repainted.
  96      */
  97     void invalidateCache();
  98
  99     /**
 100      * Is called if the cache got invalidated by KStandardItemListWidget::invalidateCache().
 101      * The default implementation is empty.
 102      */
 103     virtual void refreshCache();
 104
 105     /**
 106      * @return True if the give role should be right aligned when showing it inside a column.
 107      *         Per default false is returned.
 108      */
 109     virtual bool isRoleRightAligned(const QByteArray& role) const;
 110
 111     /**
 112      * @return True if the item should be visually marked as hidden item. Per default
 113      *         false is returned.
 114      */
 115     virtual bool isHidden() const;
 116
 117     void setTextColor(const QColor& color);
 118     QColor textColor() const;
 119
 120     void setOverlay(const QPixmap& overlay);
 121     QPixmap overlay() const;
 122
 123     /**
 124      * @see KStandardItemListWidgetInformant::roleText().
 125      */
 126     QString roleText(const QByteArray& role, const QHash<QByteArray, QVariant>& values) const;
 127
 128     virtual void dataChanged(const QHash<QByteArray, QVariant>& current, const QSet<QByteArray>& roles = QSet<QByteArray>());
 129     virtual void visibleRolesChanged(const QList<QByteArray>& current, const QList<QByteArray>& previous);
 130     virtual void columnWidthChanged(const QByteArray& role, qreal current, qreal previous);
 131     virtual void styleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous);
 132     virtual void hoveredChanged(bool hovered);
 133     virtual void selectedChanged(bool selected);
 134     virtual void siblingsInformationChanged(const QBitArray& current, const QBitArray& previous);
 135     virtual void editedRoleChanged(const QByteArray& current, const QByteArray& previous);
 136     virtual void resizeEvent(QGraphicsSceneResizeEvent* event);
 137     virtual void showEvent(QShowEvent* event);
 138     virtual void hideEvent(QHideEvent* event);
 139
 140 private slots:
 141     void slotCutItemsChanged();
 142     void slotRoleEditingCanceled(int index, const QByteArray& role, const QVariant& value);
 143     void slotRoleEditingFinished(int index, const QByteArray& role, const QVariant& value);
 144
 145 private:
 146     void triggerCacheRefreshing();
 147     void updateExpansionArea();
 148     void updatePixmapCache();
 149
 150     void updateTextsCache();
 151     void updateIconsLayoutTextCache();
 152     void updateCompactLayoutTextCache();
 153     void updateDetailsLayoutTextCache();
 154
 155     void updateAdditionalInfoTextColor();
 156
 157     void drawPixmap(QPainter* painter, const QPixmap& pixmap);
 158     void drawSiblingsInformation(QPainter* painter);
 159
 160     QRectF roleEditingRect(const QByteArray &role) const;
 161
 162     static QPixmap pixmapForIcon(const QString& name, int size);
 163     static void applyCutEffect(QPixmap& pixmap);
 164     static void applyHiddenEffect(QPixmap& pixmap);
 165
 166     /**
 167      * @return Preferred size of the rating-image based on the given
 168      *         style-option. The height of the font is taken as
 169      *         reference.
 170      */
 171     static QSizeF preferredRatingSize(const KItemListStyleOption& option);
 172
 173     /**
 174      * @return Horizontal padding in pixels that is added to the required width of
 175      *         a column to display the content.
 176      */
 177     static qreal columnPadding(const KItemListStyleOption& option);
 178
 179 private:
 180     bool m_isCut;
 181     bool m_isHidden;
 182     bool m_isExpandable;
 183     bool m_supportsItemExpanding;
 184
 185     bool m_dirtyLayout;
 186     bool m_dirtyContent;
 187     QSet<QByteArray> m_dirtyContentRoles;
 188
 189     Layout m_layout;
 190     QPointF m_pixmapPos;
 191     QPixmap m_pixmap;
 192     QSize m_scaledPixmapSize;
 193
 194     QRectF m_iconRect;          // Cache for KItemListWidget::iconRect()
 195     QPixmap m_hoverPixmap;      // Cache for modified m_pixmap when hovering the item
 196
 197     struct TextInfo
 198     {
 199         QPointF pos;
 200         QStaticText staticText;
 201     };
 202     QHash<QByteArray, TextInfo*> m_textInfo;
 203
 204     QRectF m_textRect;
 205
 206     QList<QByteArray> m_sortedVisibleRoles;
 207
 208     QRectF m_expansionArea;
 209
 210     QColor m_customTextColor;
 211     QColor m_additionalInfoTextColor;
 212
 213     QPixmap m_overlay;
 214     QPixmap m_rating;
 215
 216     KItemListRoleEditor* m_roleEditor;
 217
 218     friend class KStandardItemListWidgetInformant; // Accesses private static methods to be able to
 219                                                    // share a common layout calculation
 220 };
 221
 222 #endif
 223
 224