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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/*
Copyright (c) 2009 Stephen Kelly <steveire@gmail.com>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library 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 Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef KDESCENDANTSPROXYMODEL_P_H
#define KDESCENDANTSPROXYMODEL_P_H
#include <QtGui/QAbstractProxyModel>
class KDescendantsProxyModelPrivate;
#include "kdeui_export.h"
/**
@brief Proxy Model for restructuring a Tree into a list.
A KDescendantsProxyModel may be used to alter how the items in the tree are presented.
Given a model which is represented as a tree:
\image html entitytreemodel.png "A plain EntityTreeModel in a view"
The KDescendantsProxyModel restructures the sourceModel to represent it as a flat list.
@code
// ... Create an entityTreeModel
KDescendantsProxyModel *descProxy = new KDescendantsProxyModel(this);
descProxy->setSourceModel(entityTree);
view->setModel(descProxy);
@endcode
\image html descendantentitiesproxymodel.png "A KDescendantsProxyModel."
KDescendantEntitiesProxyModel can also display the ancestors of the index in the source model as part of its display.
@code
// ... Create an entityTreeModel
KDescendantsProxyModel *descProxy = new KDescendantsProxyModel(this);
descProxy->setSourceModel(entityTree);
// #### This is new
descProxy->setDisplayAncestorData(true);
descProxy->setDisplayAncestorSeparator(QString(" / "));
view->setModel(descProxy);
@endcode
\image html descendantentitiesproxymodel-withansecnames.png "A KDescendantsProxyModel with ancestor names."
@since 4.6
@author Stephen Kelly <steveire@gmail.com>
*/
class KDEUI_EXPORT KDescendantsProxyModel : public QAbstractProxyModel
{
Q_OBJECT
public:
/**
* Creates a new descendant entities proxy model.
*
* @param parent The parent object.
*/
explicit KDescendantsProxyModel( QObject *parent = 0 );
/**
* Destroys the descendant entities proxy model.
*/
virtual ~KDescendantsProxyModel();
/**
* Sets the source @p model of the proxy.
*/
virtual void setSourceModel( QAbstractItemModel *model );
/**
* @deprecated
*
* This method does nothing.
*/
void setRootIndex( const QModelIndex &index);
/**
* Set whether to show ancestor data in the model. If @p display is true, then
* a source model which is displayed as
*
* @code
* -> "Item 0-0" (this is row-depth)
* -> -> "Item 0-1"
* -> -> "Item 1-1"
* -> -> -> "Item 0-2"
* -> -> -> "Item 1-2"
* -> "Item 1-0"
* @endcode
*
* will be displayed as
*
* @code
* -> *Item 0-0"
* -> "Item 0-0 / Item 0-1"
* -> "Item 0-0 / Item 1-1"
* -> "Item 0-0 / Item 1-1 / Item 0-2"
* -> "Item 0-0 / Item 1-1 / Item 1-2"
* -> "Item 1-0"
* @endcode
*
* If @p display is false, the proxy will show
*
* @code
* -> *Item 0-0"
* -> "Item 0-1"
* -> "Item 1-1"
* -> "Item 0-2"
* -> "Item 1-2"
* -> "Item 1-0"
* @endcode
*
* Default is false.
*/
void setDisplayAncestorData( bool display );
/**
* Whether ancestor data will be displayed.
*/
bool displayAncestorData() const;
/**
* Sets the ancestor @p separator used between data of ancestors.
*/
void setAncestorSeparator( const QString &separator );
/**
* Separator used between data of ancestors.
*/
QString ancestorSeparator() const;
/**
* Returns the number of descendant entries for the given model @p index.
*/
int descendantCount( const QModelIndex &index ) const;
QModelIndex mapFromSource ( const QModelIndex & sourceIndex ) const;
QModelIndex mapToSource ( const QModelIndex & proxyIndex ) const;
virtual Qt::ItemFlags flags( const QModelIndex &index ) const;
QVariant data( const QModelIndex & index, int role = Qt::DisplayRole ) const;
virtual int rowCount( const QModelIndex & parent = QModelIndex() ) const;
virtual QVariant headerData(int section, Qt::Orientation orientation, int role) const;
virtual QMimeData* mimeData( const QModelIndexList & indexes ) const;
virtual QStringList mimeTypes() const;
virtual bool hasChildren ( const QModelIndex & parent = QModelIndex() ) const;
virtual QModelIndex index(int, int, const QModelIndex &parent = QModelIndex() ) const;
virtual QModelIndex parent(const QModelIndex&) const;
virtual int columnCount(const QModelIndex& index = QModelIndex()) const;
virtual Qt::DropActions supportedDropActions() const;
/**
Reimplemented to match all descendants.
*/
virtual QModelIndexList match(const QModelIndex& start, int role, const QVariant& value,
int hits = 1, Qt::MatchFlags flags = Qt::MatchFlags( Qt::MatchStartsWith | Qt::MatchWrap ) ) const;
private:
Q_DECLARE_PRIVATE( KDescendantsProxyModel )
//@cond PRIVATE
KDescendantsProxyModelPrivate *d_ptr;
Q_PRIVATE_SLOT(d_func(), void sourceRowsAboutToBeInserted(const QModelIndex &, int, int))
Q_PRIVATE_SLOT(d_func(), void sourceRowsInserted(const QModelIndex &, int, int))
Q_PRIVATE_SLOT(d_func(), void sourceRowsAboutToBeRemoved(const QModelIndex &, int, int))
Q_PRIVATE_SLOT(d_func(), void sourceRowsRemoved(const QModelIndex &, int, int))
Q_PRIVATE_SLOT(d_func(), void sourceRowsAboutToBeMoved(const QModelIndex &, int, int, const QModelIndex &, int))
Q_PRIVATE_SLOT(d_func(), void sourceRowsMoved(const QModelIndex &, int, int, const QModelIndex &, int))
Q_PRIVATE_SLOT(d_func(), void sourceModelAboutToBeReset())
Q_PRIVATE_SLOT(d_func(), void sourceModelReset())
Q_PRIVATE_SLOT(d_func(), void sourceLayoutAboutToBeChanged())
Q_PRIVATE_SLOT(d_func(), void sourceLayoutChanged())
Q_PRIVATE_SLOT(d_func(), void sourceDataChanged(const QModelIndex &, const QModelIndex &))
Q_PRIVATE_SLOT(d_func(), void sourceModelDestroyed())
Q_PRIVATE_SLOT(d_func(), void processPendingParents())
// Make these private, they shouldn't be called by applications
// virtual bool insertRows(int , int, const QModelIndex & = QModelIndex());
// virtual bool insertColumns(int, int, const QModelIndex & = QModelIndex());
// virtual bool removeRows(int, int, const QModelIndex & = QModelIndex());
// virtual bool removeColumns(int, int, const QModelIndex & = QModelIndex());
//@endcond
};
#endif
|
