1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
/*
* Copyright 2013 Kevin Funk <kfunk@kde.org>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License or (at your option) version 3 or any later version
* accepted by the membership of KDE e.V. (or its successor approved
* by the membership of KDE e.V.), which shall act as a proxy
* defined in Section 14 of version 3 of the license.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef KDEVPLATFORM_PLACEHOLDERITEMPROXYMODEL_H
#define KDEVPLATFORM_PLACEHOLDERITEMPROXYMODEL_H
#include "utilexport.h"
#include <QIdentityProxyModel>
#include <QScopedPointer>
namespace KDevelop {
class PlaceholderItemProxyModelPrivate;
/**
* Proxy model adding a placeholder item for new entries
*
* This is mostly a QIdentityProxyModel, with one additional row added at the end
*
* Example use:
*
* @code
* PlaceholderItemProxyModel* proxyModel = new PlaceholderItemProxyModel;
* proxyModel->setSourceModel(new MyItemModel);
* proxyModel->setColumnHint(0, "(Add new entry)");
* connect(proxyModel, SIGNAL(dataInserted(...), SLOT(handleDataInserted(...));
* @endcode
*
* In this case MyItemModel has exactly two entries, "Item1" and "Item2"
*
* This will end up in PlaceholderItemProxyModel holding the following indices:
* - "Item1" (from source model)
* - "Item2" (from source model)
* - "(Add new entry)" (from PlaceholderItemProxyModel)
*
* In case the last entry is edited, and a non-empty value is supplied,
* dataInserted() is emitted to notify the user about newly created rows.
* The user then has to make sure the signal is handled accordingly and
* new items are added to the source model.
*
* @see dataInserted
*
* @note WARNING: This implementation is only suitable for flat models
* It will fall apart when you use a tree model as source
*/
class KDEVPLATFORMUTIL_EXPORT PlaceholderItemProxyModel : public QIdentityProxyModel
{
Q_OBJECT
public:
explicit PlaceholderItemProxyModel(QObject* parent = nullptr);
~PlaceholderItemProxyModel() override;
QVariant columnHint(int column) const;
/**
* Set the hint value for @p column to @p hint
*
* This text is going to be displayed in the place holder item row
*
* Only columns with non-empty hints are clickable and editable and
* eventually cause the dataInserted() signal to be triggered
*/
void setColumnHint(int column, const QVariant& hint);
void setSourceModel(QAbstractItemModel* sourceModel) override;
Qt::ItemFlags flags(const QModelIndex& index) const override;
int rowCount(const QModelIndex& parent = QModelIndex()) const override;
bool hasChildren(const QModelIndex& parent = QModelIndex()) const override;
QVariant data(const QModelIndex& proxyIndex, int role = Qt::DisplayRole) const override;
bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override;
QModelIndex parent(const QModelIndex& child) const override;
QModelIndex sibling(int row, int column, const QModelIndex& idx) const override;
QModelIndex buddy(const QModelIndex& index) const override;
QModelIndex index(int row, int column, const QModelIndex& parent = QModelIndex()) const override;
QModelIndex mapToSource(const QModelIndex& proxyIndex) const override;
/**
* Implement in subclass.
*
* @return True in case the input was valid, and the filter should notify
* external observers via the dataInserted signal.
*
* By default, this method returns true only in case @p value is non-empty
*
* @sa dataInserted()
*/
virtual bool validateRow(const QModelIndex& index, const QVariant& value) const;
Q_SIGNALS:
void dataInserted(int column, const QVariant& values);
private:
const QScopedPointer<class PlaceholderItemProxyModelPrivate> d_ptr;
Q_DECLARE_PRIVATE(PlaceholderItemProxyModel)
};
}
#endif // KDEVPLATFORM_PLACEHOLDERITEMPROXYMODEL_H
|
