Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qstandarditemmodel.h
Go to the documentation of this file.
1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3// Qt-Security score:significant reason:default
4
5#ifndef QSTANDARDITEMMODEL_H
6#define QSTANDARDITEMMODEL_H
7
8#include <QtGui/qtguiglobal.h>
9#include <QtCore/qabstractitemmodel.h>
10#include <QtGui/qbrush.h>
11#include <QtGui/qfont.h>
12#include <QtGui/qicon.h>
13#ifndef QT_NO_DATASTREAM
14#include <QtCore/qdatastream.h>
15#endif
16
17QT_REQUIRE_CONFIG(standarditemmodel);
18
19QT_BEGIN_NAMESPACE
20
21class QStandardItemModel;
22
23class QStandardItemPrivate;
24class Q_GUI_EXPORT QStandardItem
25{
26public:
27 QStandardItem();
28 explicit QStandardItem(const QString &text);
29 QStandardItem(const QIcon &icon, const QString &text);
30 explicit QStandardItem(int rows, int columns = 1);
31 virtual ~QStandardItem();
32
33 virtual QVariant data(int role = Qt::UserRole + 1) const;
34 virtual void multiData(QModelRoleDataSpan roleDataSpan) const;
35 virtual void setData(const QVariant &value, int role = Qt::UserRole + 1);
36 void clearData();
37
38 inline QString text() const {
39 return qvariant_cast<QString>(data(Qt::DisplayRole));
40 }
41 inline void setText(const QString &text);
42
43 inline QIcon icon() const {
44 return qvariant_cast<QIcon>(data(Qt::DecorationRole));
45 }
46 inline void setIcon(const QIcon &icon);
47
48 inline QString toolTip() const {
49 return qvariant_cast<QString>(data(Qt::ToolTipRole));
50 }
51 inline void setToolTip(const QString &toolTip);
52
53#ifndef QT_NO_STATUSTIP
54 inline QString statusTip() const {
55 return qvariant_cast<QString>(data(Qt::StatusTipRole));
56 }
57 inline void setStatusTip(const QString &statusTip);
58#endif
59
60#if QT_CONFIG(whatsthis)
61 inline QString whatsThis() const {
62 return qvariant_cast<QString>(data(Qt::WhatsThisRole));
63 }
64 inline void setWhatsThis(const QString &whatsThis);
65#endif
66
67 inline QSize sizeHint() const {
68 return qvariant_cast<QSize>(data(Qt::SizeHintRole));
69 }
70 inline void setSizeHint(const QSize &sizeHint);
71
72 inline QFont font() const {
73 return qvariant_cast<QFont>(data(Qt::FontRole));
74 }
75 inline void setFont(const QFont &font);
76
77 inline Qt::Alignment textAlignment() const {
78 return qvariant_cast<Qt::Alignment>(data(Qt::TextAlignmentRole));
79 }
80 inline void setTextAlignment(Qt::Alignment textAlignment);
81
82 inline QBrush background() const {
83 return qvariant_cast<QBrush>(data(Qt::BackgroundRole));
84 }
85 inline void setBackground(const QBrush &brush);
86
87 inline QBrush foreground() const {
88 return qvariant_cast<QBrush>(data(Qt::ForegroundRole));
89 }
90 inline void setForeground(const QBrush &brush);
91
92 inline Qt::CheckState checkState() const {
93 return Qt::CheckState(qvariant_cast<int>(data(Qt::CheckStateRole)));
94 }
95 inline void setCheckState(Qt::CheckState checkState);
96
97 inline QString accessibleText() const {
98 return qvariant_cast<QString>(data(Qt::AccessibleTextRole));
99 }
100 inline void setAccessibleText(const QString &accessibleText);
101
102 inline QString accessibleDescription() const {
103 return qvariant_cast<QString>(data(Qt::AccessibleDescriptionRole));
104 }
105 inline void setAccessibleDescription(const QString &accessibleDescription);
106
107 Qt::ItemFlags flags() const;
108 void setFlags(Qt::ItemFlags flags);
109
110 inline bool isEnabled() const {
111 return bool(flags() & Qt::ItemIsEnabled);
112 }
113 void setEnabled(bool enabled);
114
115 inline bool isEditable() const {
116 return bool(flags() & Qt::ItemIsEditable);
117 }
118 void setEditable(bool editable);
119
120 inline bool isSelectable() const {
121 return bool(flags() & Qt::ItemIsSelectable);
122 }
123 void setSelectable(bool selectable);
124
125 inline bool isCheckable() const {
126 return bool(flags() & Qt::ItemIsUserCheckable);
127 }
128 void setCheckable(bool checkable);
129
130 inline bool isAutoTristate() const {
131 return bool(flags() & Qt::ItemIsAutoTristate);
132 }
133 void setAutoTristate(bool tristate);
134
135 inline bool isUserTristate() const {
136 return bool(flags() & Qt::ItemIsUserTristate);
137 }
138 void setUserTristate(bool tristate);
139
140#if QT_CONFIG(draganddrop)
141 inline bool isDragEnabled() const {
142 return bool(flags() & Qt::ItemIsDragEnabled);
143 }
144 void setDragEnabled(bool dragEnabled);
145
146 inline bool isDropEnabled() const {
147 return bool(flags() & Qt::ItemIsDropEnabled);
148 }
149 void setDropEnabled(bool dropEnabled);
150#endif // QT_CONFIG(draganddrop)
151
152 QStandardItem *parent() const;
153 int row() const;
154 int column() const;
155 QModelIndex index() const;
156 QStandardItemModel *model() const;
157
158 int rowCount() const;
159 void setRowCount(int rows);
160 int columnCount() const;
161 void setColumnCount(int columns);
162
163 bool hasChildren() const;
164 QStandardItem *child(int row, int column = 0) const;
165 void setChild(int row, int column, QStandardItem *item);
166 inline void setChild(int row, QStandardItem *item);
167
168 void insertRow(int row, const QList<QStandardItem*> &items);
169 void insertColumn(int column, const QList<QStandardItem*> &items);
170 void insertRows(int row, const QList<QStandardItem*> &items);
171 void insertRows(int row, int count);
172 void insertColumns(int column, int count);
173
174 void removeRow(int row);
175 void removeColumn(int column);
176 void removeRows(int row, int count);
177 void removeColumns(int column, int count);
178
179 inline void appendRow(const QList<QStandardItem*> &items);
180 inline void appendRows(const QList<QStandardItem*> &items);
181 inline void appendColumn(const QList<QStandardItem*> &items);
182 inline void insertRow(int row, QStandardItem *item);
183 inline void appendRow(QStandardItem *item);
184
185 QStandardItem *takeChild(int row, int column = 0);
186 QList<QStandardItem*> takeRow(int row);
187 QList<QStandardItem*> takeColumn(int column);
188
189 void sortChildren(int column, Qt::SortOrder order = Qt::AscendingOrder);
190
191 virtual QStandardItem *clone() const;
192
193 enum ItemType { Type = 0, UserType = 1000 };
194 virtual int type() const;
195
196#ifndef QT_NO_DATASTREAM
197 virtual void read(QDataStream &in);
198 virtual void write(QDataStream &out) const;
199#endif
200 virtual bool operator<(const QStandardItem &other) const;
201
202protected:
203 QStandardItem(const QStandardItem &other);
204 QStandardItem(QStandardItemPrivate &dd);
205 QStandardItem &operator=(const QStandardItem &other);
206 QScopedPointer<QStandardItemPrivate> d_ptr;
207
208 void emitDataChanged();
209
210private:
211 Q_DECLARE_PRIVATE(QStandardItem)
212 friend class QStandardItemModelPrivate;
213 friend class QStandardItemModel;
214};
215
216inline void QStandardItem::setText(const QString &atext)
217{ setData(atext, Qt::DisplayRole); }
218
219inline void QStandardItem::setIcon(const QIcon &aicon)
220{ setData(aicon, Qt::DecorationRole); }
221
222inline void QStandardItem::setToolTip(const QString &atoolTip)
223{ setData(atoolTip, Qt::ToolTipRole); }
224
225#ifndef QT_NO_STATUSTIP
226inline void QStandardItem::setStatusTip(const QString &astatusTip)
227{ setData(astatusTip, Qt::StatusTipRole); }
228#endif
229
230#if QT_CONFIG(whatsthis)
231inline void QStandardItem::setWhatsThis(const QString &awhatsThis)
232{ setData(awhatsThis, Qt::WhatsThisRole); }
233#endif
234
235inline void QStandardItem::setSizeHint(const QSize &asizeHint)
236{ setData(asizeHint, Qt::SizeHintRole); }
237
238inline void QStandardItem::setFont(const QFont &afont)
239{ setData(afont, Qt::FontRole); }
240
241inline void QStandardItem::setTextAlignment(Qt::Alignment atextAlignment)
242{ setData(QVariant::fromValue(atextAlignment), Qt::TextAlignmentRole); }
243
244inline void QStandardItem::setBackground(const QBrush &abrush)
245{ setData(abrush, Qt::BackgroundRole); }
246
247inline void QStandardItem::setForeground(const QBrush &abrush)
248{ setData(abrush, Qt::ForegroundRole); }
249
250inline void QStandardItem::setCheckState(Qt::CheckState acheckState)
251{ setData(acheckState, Qt::CheckStateRole); }
252
253inline void QStandardItem::setAccessibleText(const QString &aaccessibleText)
254{ setData(aaccessibleText, Qt::AccessibleTextRole); }
255
256inline void QStandardItem::setAccessibleDescription(const QString &aaccessibleDescription)
257{ setData(aaccessibleDescription, Qt::AccessibleDescriptionRole); }
258
259inline void QStandardItem::setChild(int arow, QStandardItem *aitem)
260{ setChild(arow, 0, aitem); }
261
262inline void QStandardItem::appendRow(const QList<QStandardItem*> &aitems)
263{ insertRow(rowCount(), aitems); }
264
265inline void QStandardItem::appendRows(const QList<QStandardItem*> &aitems)
266{ insertRows(rowCount(), aitems); }
267
268inline void QStandardItem::appendColumn(const QList<QStandardItem*> &aitems)
269{ insertColumn(columnCount(), aitems); }
270
271inline void QStandardItem::insertRow(int arow, QStandardItem *aitem)
272{ insertRow(arow, QList<QStandardItem*>() << aitem); }
273
274inline void QStandardItem::appendRow(QStandardItem *aitem)
275{ insertRow(rowCount(), aitem); }
276
277class QStandardItemModelPrivate;
278
279class Q_GUI_EXPORT QStandardItemModel : public QAbstractItemModel
280{
281 Q_OBJECT
282 Q_PROPERTY(int sortRole READ sortRole WRITE setSortRole BINDABLE bindableSortRole)
283
284public:
285 explicit QStandardItemModel(QObject *parent = nullptr);
286 QStandardItemModel(int rows, int columns, QObject *parent = nullptr);
287 ~QStandardItemModel();
288
289 void setItemRoleNames(const QHash<int,QByteArray> &roleNames);
290 QHash<int, QByteArray> roleNames() const override;
291
292 QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const override;
293 QModelIndex parent(const QModelIndex &child) const override;
294
295 int rowCount(const QModelIndex &parent = QModelIndex()) const override;
296 int columnCount(const QModelIndex &parent = QModelIndex()) const override;
297 bool hasChildren(const QModelIndex &parent = QModelIndex()) const override;
298
299 QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
300 void multiData(const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const override;
301 bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
302 bool clearItemData(const QModelIndex &index) override;
303
304 QVariant headerData(int section, Qt::Orientation orientation,
305 int role = Qt::DisplayRole) const override;
306 bool setHeaderData(int section, Qt::Orientation orientation, const QVariant &value,
307 int role = Qt::EditRole) override;
308
309 bool insertRows(int row, int count, const QModelIndex &parent = QModelIndex()) override;
310 bool insertColumns(int column, int count, const QModelIndex &parent = QModelIndex()) override;
311 bool removeRows(int row, int count, const QModelIndex &parent = QModelIndex()) override;
312 bool removeColumns(int column, int count, const QModelIndex &parent = QModelIndex()) override;
313
314 Qt::ItemFlags flags(const QModelIndex &index) const override;
315 Qt::DropActions supportedDropActions() const override;
316
317 QMap<int, QVariant> itemData(const QModelIndex &index) const override;
318 bool setItemData(const QModelIndex &index, const QMap<int, QVariant> &roles) override;
319
320 void clear();
321
322 using QObject::parent;
323
324 void sort(int column, Qt::SortOrder order = Qt::AscendingOrder) override;
325
326 QStandardItem *itemFromIndex(const QModelIndex &index) const;
327 QModelIndex indexFromItem(const QStandardItem *item) const;
328
329 QStandardItem *item(int row, int column = 0) const;
330 void setItem(int row, int column, QStandardItem *item);
331 inline void setItem(int row, QStandardItem *item);
332 QStandardItem *invisibleRootItem() const;
333
334 QStandardItem *horizontalHeaderItem(int column) const;
335 void setHorizontalHeaderItem(int column, QStandardItem *item);
336 QStandardItem *verticalHeaderItem(int row) const;
337 void setVerticalHeaderItem(int row, QStandardItem *item);
338
339 void setHorizontalHeaderLabels(const QStringList &labels);
340 void setVerticalHeaderLabels(const QStringList &labels);
341
342 void setRowCount(int rows);
343 void setColumnCount(int columns);
344
345 void appendRow(const QList<QStandardItem*> &items);
346 void appendColumn(const QList<QStandardItem*> &items);
347 inline void appendRow(QStandardItem *item);
348
349 void insertRow(int row, const QList<QStandardItem*> &items);
350 void insertColumn(int column, const QList<QStandardItem*> &items);
351 inline void insertRow(int row, QStandardItem *item);
352
353 inline bool insertRow(int row, const QModelIndex &parent = QModelIndex());
354 inline bool insertColumn(int column, const QModelIndex &parent = QModelIndex());
355
356 QStandardItem *takeItem(int row, int column = 0);
357 QList<QStandardItem*> takeRow(int row);
358 QList<QStandardItem*> takeColumn(int column);
359
360 QStandardItem *takeHorizontalHeaderItem(int column);
361 QStandardItem *takeVerticalHeaderItem(int row);
362
363 const QStandardItem *itemPrototype() const;
364 void setItemPrototype(const QStandardItem *item);
365
366 QList<QStandardItem*> findItems(const QString &text,
367 Qt::MatchFlags flags = Qt::MatchExactly,
368 int column = 0) const;
369
370 int sortRole() const;
371 void setSortRole(int role);
372 QBindable<int> bindableSortRole();
373
374 QStringList mimeTypes() const override;
375 QMimeData *mimeData(const QModelIndexList &indexes) const override;
376 bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override;
377
378Q_SIGNALS:
379 void itemChanged(QStandardItem *item);
380
381protected:
382 QStandardItemModel(QStandardItemModelPrivate &dd, QObject *parent = nullptr);
383
384private:
385 friend class QStandardItemPrivate;
386 friend class QStandardItem;
387 Q_DISABLE_COPY(QStandardItemModel)
388 Q_DECLARE_PRIVATE(QStandardItemModel)
389
390 Q_PRIVATE_SLOT(d_func(), void _q_emitItemChanged(const QModelIndex &topLeft,
391 const QModelIndex &bottomRight))
392};
393
394inline void QStandardItemModel::setItem(int arow, QStandardItem *aitem)
395{ setItem(arow, 0, aitem); }
396
397inline void QStandardItemModel::appendRow(QStandardItem *aitem)
398{ appendRow(QList<QStandardItem*>() << aitem); }
399
400inline void QStandardItemModel::insertRow(int arow, QStandardItem *aitem)
401{ insertRow(arow, QList<QStandardItem*>() << aitem); }
402
403inline bool QStandardItemModel::insertRow(int arow, const QModelIndex &aparent)
404{ return QAbstractItemModel::insertRow(arow, aparent); }
405inline bool QStandardItemModel::insertColumn(int acolumn, const QModelIndex &aparent)
406{ return QAbstractItemModel::insertColumn(acolumn, aparent); }
407
408#ifndef QT_NO_DATASTREAM
409Q_GUI_EXPORT QDataStream &operator>>(QDataStream &in, QStandardItem &item);
410Q_GUI_EXPORT QDataStream &operator<<(QDataStream &out, const QStandardItem &item);
411#endif
412
413QT_END_NAMESPACE
414
415#endif //QSTANDARDITEMMODEL_H
QDataStream
\inmodule QtCore\reentrant
Definition qdatastream.h:50
QStandardItemModelGreaterThan::operator()
bool operator()(const std::pair< QStandardItem *, int > &l, const std::pair< QStandardItem *, int > &r) const
Definition qstandarditemmodel.cpp:46
QStandardItemModelLessThan::operator()
bool operator()(const std::pair< QStandardItem *, int > &l, const std::pair< QStandardItem *, int > &r) const
Definition qstandarditemmodel.cpp:33
QStandardItemModel
The QStandardItemModel class provides a generic model for storing custom data.
Definition qstandarditemmodel.h:280
QStandardItem
The QStandardItem class provides an item for use with the QStandardItemModel class.
Definition qstandarditemmodel.h:25
QT_REQUIRE_CONFIG
QT_REQUIRE_CONFIG(standarditemmodel)
operator<<
QDataStream & operator<<(QDataStream &stream, const QImage &image)
[0]
Definition qimage.cpp:4006
operator>>
QDataStream & operator>>(QDataStream &stream, QImage &image)
Definition qimage.cpp:4032