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 QABSTRACTITEMDELEGATE_H
41#define QABSTRACTITEMDELEGATE_H
42
43#include <QtWidgets/qtwidgetsglobal.h>
44#include <QtCore/qobject.h>
45#include <QtWidgets/qstyleoption.h>
46
47QT_REQUIRE_CONFIG(itemviews);
48
49QT_BEGIN_NAMESPACE
50
51class QPainter;
52class QModelIndex;
53class QAbstractItemModel;
54class QAbstractItemView;
55class QHelpEvent;
56class QAbstractItemDelegatePrivate;
57
58class Q_WIDGETS_EXPORT QAbstractItemDelegate : public QObject
59{
60 Q_OBJECT
61
62public:
63
64 enum EndEditHint {
65 NoHint,
66 EditNextItem,
67 EditPreviousItem,
68 SubmitModelCache,
69 RevertModelCache
70 };
71
72 explicit QAbstractItemDelegate(QObject *parent = nullptr);
73 virtual ~QAbstractItemDelegate();
74
75 // painting
76 virtual void paint(QPainter *painter,
77 const QStyleOptionViewItem &option,
78 const QModelIndex &index) const = 0;
79
80 virtual QSize sizeHint(const QStyleOptionViewItem &option,
81 const QModelIndex &index) const = 0;
82
83 // editing
84 virtual QWidget *createEditor(QWidget *parent,
85 const QStyleOptionViewItem &option,
86 const QModelIndex &index) const;
87
88 virtual void destroyEditor(QWidget *editor, const QModelIndex &index) const;
89
90 virtual void setEditorData(QWidget *editor, const QModelIndex &index) const;
91
92 virtual void setModelData(QWidget *editor,
93 QAbstractItemModel *model,
94 const QModelIndex &index) const;
95
96 virtual void updateEditorGeometry(QWidget *editor,
97 const QStyleOptionViewItem &option,
98 const QModelIndex &index) const;
99
100 // for non-widget editors
101 virtual bool editorEvent(QEvent *event,
102 QAbstractItemModel *model,
103 const QStyleOptionViewItem &option,
104 const QModelIndex &index);
105
106#if QT_DEPRECATED_SINCE(5, 13)
107 QT_DEPRECATED_X("Use QFontMetrics::elidedText() instead")
108 static QString elidedText(const QFontMetrics &fontMetrics, int width,
109 Qt::TextElideMode mode, const QString &text);
110#endif
111
112 virtual bool helpEvent(QHelpEvent *event,
113 QAbstractItemView *view,
114 const QStyleOptionViewItem &option,
115 const QModelIndex &index);
116
117 virtual QVector<int> paintingRoles() const;
118
119Q_SIGNALS:
120 void commitData(QWidget *editor);
121 void closeEditor(QWidget *editor, QAbstractItemDelegate::EndEditHint hint = NoHint);
122 void sizeHintChanged(const QModelIndex &);
123
124protected:
125 QAbstractItemDelegate(QObjectPrivate &, QObject *parent = nullptr);
126private:
127 Q_DECLARE_PRIVATE(QAbstractItemDelegate)
128 Q_DISABLE_COPY(QAbstractItemDelegate)
129 Q_PRIVATE_SLOT(d_func(), void _q_commitDataAndCloseEditor(QWidget*))
130};
131
132QT_END_NAMESPACE
133
134#endif // QABSTRACTITEMDELEGATE_H
135