1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtWidgets module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QITEMDELEGATE_H
41#define QITEMDELEGATE_H
42
43#include <QtWidgets/qtwidgetsglobal.h>
44#include <QtWidgets/qabstractitemdelegate.h>
45#include <QtCore/qstring.h>
46#include <QtGui/qpixmap.h>
47#include <QtCore/qvariant.h>
48
49QT_REQUIRE_CONFIG(itemviews);
50
51QT_BEGIN_NAMESPACE
52
53class QItemDelegatePrivate;
54class QItemEditorFactory;
55
56class Q_WIDGETS_EXPORT QItemDelegate : public QAbstractItemDelegate
57{
58 Q_OBJECT
59 Q_PROPERTY(bool clipping READ hasClipping WRITE setClipping)
60
61public:
62 explicit QItemDelegate(QObject *parent = nullptr);
63 ~QItemDelegate();
64
65 bool hasClipping() const;
66 void setClipping(bool clip);
67
68 // painting
69 void paint(QPainter *painter,
70 const QStyleOptionViewItem &option,
71 const QModelIndex &index) const override;
72 QSize sizeHint(const QStyleOptionViewItem &option,
73 const QModelIndex &index) const override;
74
75 // editing
76 QWidget *createEditor(QWidget *parent,
77 const QStyleOptionViewItem &option,
78 const QModelIndex &index) const override;
79
80 void setEditorData(QWidget *editor, const QModelIndex &index) const override;
81 void setModelData(QWidget *editor, QAbstractItemModel *model, const QModelIndex &index) const override;
82
83 void updateEditorGeometry(QWidget *editor,
84 const QStyleOptionViewItem &option,
85 const QModelIndex &index) const override;
86
87 // editor factory
88 QItemEditorFactory *itemEditorFactory() const;
89 void setItemEditorFactory(QItemEditorFactory *factory);
90
91protected:
92 virtual void drawDisplay(QPainter *painter, const QStyleOptionViewItem &option,
93 const QRect &rect, const QString &text) const;
94 virtual void drawDecoration(QPainter *painter, const QStyleOptionViewItem &option,
95 const QRect &rect, const QPixmap &pixmap) const;
96 virtual void drawFocus(QPainter *painter, const QStyleOptionViewItem &option,
97 const QRect &rect) const;
98 virtual void drawCheck(QPainter *painter, const QStyleOptionViewItem &option,
99 const QRect &rect, Qt::CheckState state) const;
100 void drawBackground(QPainter *painter, const QStyleOptionViewItem &option,
101 const QModelIndex &index) const;
102
103 void doLayout(const QStyleOptionViewItem &option,
104 QRect *checkRect, QRect *iconRect, QRect *textRect, bool hint) const;
105
106 QRect rect(const QStyleOptionViewItem &option, const QModelIndex &index, int role) const;
107
108 bool eventFilter(QObject *object, QEvent *event) override;
109 bool editorEvent(QEvent *event, QAbstractItemModel *model,
110 const QStyleOptionViewItem &option, const QModelIndex &index) override;
111
112 QStyleOptionViewItem setOptions(const QModelIndex &index,
113 const QStyleOptionViewItem &option) const;
114
115 QPixmap decoration(const QStyleOptionViewItem &option, const QVariant &variant) const;
116
117#if QT_DEPRECATED_SINCE(5, 13)
118 QT_DEPRECATED_X("Use selectedPixmap() instead")
119 QPixmap *selected(const QPixmap &pixmap, const QPalette &palette, bool enabled) const;
120#endif
121 static QPixmap selectedPixmap(const QPixmap &pixmap, const QPalette &palette, bool enabled);
122
123 QRect doCheck(const QStyleOptionViewItem &option, const QRect &bounding,
124 const QVariant &variant) const;
125 QRect textRectangle(QPainter *painter, const QRect &rect,
126 const QFont &font, const QString &text) const;
127
128private:
129 Q_DECLARE_PRIVATE(QItemDelegate)
130 Q_DISABLE_COPY(QItemDelegate)
131};
132
133QT_END_NAMESPACE
134
135#endif // QITEMDELEGATE_H
136