src/kitemviews/kitemlistgroupheader.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 KITEMLISTGROUPHEADER_H
  21 #define KITEMLISTGROUPHEADER_H
  22
  23 #include "dolphin_export.h"
  24 #include "kitemviews/kitemliststyleoption.h"
  25
  26 #include <QByteArray>
  27 #include <QGraphicsWidget>
  28 #include <QVariant>
  29
  30 class KItemListView;
  31
  32 /**
  33  * @brief Base class for group headers.
  34  *
  35  * Draws a default header background. Derived classes must reimplement
  36  * the method paint() and draw the role within the given roleBounds() with
  37  * the color roleColor().
  38  */
  39 class DOLPHIN_EXPORT KItemListGroupHeader : public QGraphicsWidget
  40 {
  41     Q_OBJECT
  42
  43 public:
  44     explicit KItemListGroupHeader(QGraphicsWidget* parent = nullptr);
  45     ~KItemListGroupHeader() override;
  46
  47     void setRole(const QByteArray& role);
  48     QByteArray role() const;
  49
  50     void setData(const QVariant& data);
  51     QVariant data() const;
  52
  53     void setStyleOption(const KItemListStyleOption& option);
  54     const KItemListStyleOption& styleOption() const;
  55
  56     /**
  57      * Sets the scroll orientation that is used by the KItemListView.
  58      * This allows the group header to use a modified look dependent
  59      * on the orientation.
  60      */
  61     void setScrollOrientation(Qt::Orientation orientation);
  62     Qt::Orientation scrollOrientation() const;
  63
  64     void setItemIndex(int index);
  65     int itemIndex() const;
  66
  67     void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = nullptr) override;
  68
  69 protected:
  70     virtual void paintRole(QPainter* painter, const QRectF& roleBounds, const QColor& color) = 0;
  71     virtual void paintSeparator(QPainter* painter, const QColor& color) = 0;
  72
  73     /**
  74      * Is called after the role has been changed and allows the derived class
  75      * to react on this change.
  76      */
  77     virtual void roleChanged(const QByteArray& current, const QByteArray& previous);
  78
  79     /**
  80      * Is called after the role has been changed and allows the derived class
  81      * to react on this change.
  82      */
  83     virtual void dataChanged(const QVariant& current, const QVariant& previous);
  84
  85     /**
  86      * Is called after the style option has been changed and allows the derived class
  87      * to react on this change.
  88      */
  89     virtual void styleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous);
  90
  91     /**
  92      * Is called after the scroll orientation has been changed and allows the derived class
  93      * to react on this change.
  94      */
  95     virtual void scrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous);
  96
  97     /**
  98      * Is called after the item index has been changed and allows the derived class to react on
  99      * this change.
 100      */
 101     virtual void itemIndexChanged(int current, int previous);
 102
 103     void resizeEvent(QGraphicsSceneResizeEvent* event) override;
 104
 105     virtual QPalette::ColorRole normalTextColorRole() const;
 106     virtual QPalette::ColorRole normalBaseColorRole() const;
 107
 108 private:
 109     void updateCache();
 110
 111     static QColor mixedColor(const QColor& c1, const QColor& c2, int c1Percent = 50);
 112
 113     QColor textColor() const;
 114     QColor baseColor() const;
 115
 116 private:
 117     bool m_dirtyCache;
 118     QByteArray m_role;
 119     QVariant m_data;
 120     KItemListStyleOption m_styleOption;
 121     Qt::Orientation m_scrollOrientation;
 122     int m_itemIndex;
 123
 124     QColor m_separatorColor;
 125     QColor m_roleColor;
 126     QRectF m_roleBounds;
 127 };
 128 #endif
 129
 130