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 <libdolphin_export.h>
  24
  25 #include <kitemviews/kitemliststyleoption.h>
  26
  27 #include <QByteArray>
  28 #include <QGraphicsWidget>
  29 #include <QVariant>
  30
  31 class KItemListView;
  32
  33 /**
  34  * @brief Base class for group headers.
  35  *
  36  * Draws a default header background. Derived classes must reimplement
  37  * the method paint() and draw the role within the given roleBounds() with
  38  * the color roleColor().
  39  */
  40 class LIBDOLPHINPRIVATE_EXPORT KItemListGroupHeader : public QGraphicsWidget
  41 {
  42     Q_OBJECT
  43
  44 public:
  45     KItemListGroupHeader(QGraphicsWidget* parent = 0);
  46     virtual ~KItemListGroupHeader();
  47
  48     void setRole(const QByteArray& role);
  49     QByteArray role() const;
  50
  51     void setData(const QVariant& data);
  52     QVariant data() const;
  53
  54     void setStyleOption(const KItemListStyleOption& option);
  55     const KItemListStyleOption& styleOption() const;
  56
  57     /**
  58      * Sets the scroll orientation that is used by the KItemListView.
  59      * This allows the group header to use a modified look dependent
  60      * on the orientation.
  61      */
  62     void setScrollOrientation(Qt::Orientation orientation);
  63     Qt::Orientation scrollOrientation() const;
  64
  65     virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = 0);
  66
  67 protected:
  68     /** @return Bounding rectangle where the role should be drawn into. */
  69     QRectF roleBounds() const;
  70
  71     /** @return Primary color that should be used for drawing the role. */
  72     QColor roleColor() const;
  73
  74     /**
  75      * Is called after the role has been changed and allows the derived class
  76      * to react on this change.
  77      */
  78     virtual void roleChanged(const QByteArray& current, const QByteArray& previous);
  79
  80     /**
  81      * Is called after the role has been changed and allows the derived class
  82      * to react on this change.
  83      */
  84     virtual void dataChanged(const QVariant& current, const QVariant& previous);
  85
  86     /**
  87      * Is called after the style option has been changed and allows the derived class
  88      * to react on this change.
  89      */
  90     virtual void styleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous);
  91
  92     /**
  93      * Is called after the scroll orientation has been changed and allows the derived class
  94      * to react on this change.
  95      */
  96     virtual void scrollOrientationChanged(Qt::Orientation current, Qt::Orientation previous);
  97
  98     /** @reimp */
  99     virtual void resizeEvent(QGraphicsSceneResizeEvent* event);
 100
 101 private:
 102     void updateCache();
 103
 104 private:
 105     bool m_dirtyCache;
 106     QByteArray m_role;
 107     QVariant m_data;
 108     KItemListStyleOption m_styleOption;
 109     Qt::Orientation m_scrollOrientation;
 110
 111     QColor m_roleColor;
 112     QRectF m_roleBounds;
 113 };
 114 #endif
 115
 116