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
31class 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 */
40class LIBDOLPHINPRIVATE_EXPORT KItemListGroupHeader : public QGraphicsWidget
41{
42 Q_OBJECT
43
44public:
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 void setItemIndex(int index);
66 int itemIndex() const;
67
68 virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = 0);
69
70protected:
71 virtual void paintRole(QPainter* painter, const QRectF& roleBounds, const QColor& color) = 0;
72 virtual void paintSeparator(QPainter* painter, const QColor& color) = 0;
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 /**
99 * Is called after the item index has been changed and allows the derived class to react on
100 * this change.
101 */
102 virtual void itemIndexChanged(int current, int previous);
103
104 /** @reimp */
105 virtual void resizeEvent(QGraphicsSceneResizeEvent* event);
106
107 virtual QPalette::ColorRole normalTextColorRole() const;
108 virtual QPalette::ColorRole normalBaseColorRole() const;
109
110private:
111 void updateCache();
112
113 static QColor mixedColor(const QColor& c1, const QColor& c2, int c1Percent = 50);
114
115 QColor textColor() const;
116 QColor baseColor() const;
117
118private:
119 bool m_dirtyCache;
120 QByteArray m_role;
121 QVariant m_data;
122 KItemListStyleOption m_styleOption;
123 Qt::Orientation m_scrollOrientation;
124 int m_itemIndex;
125
126 QColor m_separatorColor;
127 QColor m_roleColor;
128 QRectF m_roleBounds;
129};
130#endif
131
132
133