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
qlistwidget.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 QLISTWIDGET_H
6#define QLISTWIDGET_H
7
8#include <QtWidgets/qlistview.h>
9#include <QtWidgets/qtwidgetsglobal.h>
10#include <QtCore/qlist.h>
11#include <QtCore/qitemselectionmodel.h>
12#include <QtCore/qvariant.h>
13
14QT_REQUIRE_CONFIG(listwidget);
15
16QT_BEGIN_NAMESPACE
17
18class QListWidget;
19class QListModel;
20class QWidgetItemData;
21class QListWidgetItemPrivate;
22
23class Q_WIDGETS_EXPORT QListWidgetItem
24{
25 friend class QListModel;
26 friend class QListWidget;
27public:
28 enum ItemType { Type = 0, UserType = 1000 };
29 explicit QListWidgetItem(QListWidget *listview = nullptr, int type = Type);
30 explicit QListWidgetItem(const QString &text, QListWidget *listview = nullptr, int type = Type);
31 explicit QListWidgetItem(const QIcon &icon, const QString &text,
32 QListWidget *listview = nullptr, int type = Type);
33 QListWidgetItem(const QListWidgetItem &other);
34 virtual ~QListWidgetItem();
35
36 virtual QListWidgetItem *clone() const;
37
38 inline QListWidget *listWidget() const { return view; }
39
40 void setSelected(bool select);
41 bool isSelected() const;
42
43 inline void setHidden(bool hide);
44 inline bool isHidden() const;
45
46 inline Qt::ItemFlags flags() const { return itemFlags; }
47 void setFlags(Qt::ItemFlags flags);
48
49 inline QString text() const
50 { return data(Qt::DisplayRole).toString(); }
51 inline void setText(const QString &text);
52
53 inline QIcon icon() const
54 { return qvariant_cast<QIcon>(data(Qt::DecorationRole)); }
55 inline void setIcon(const QIcon &icon);
56
57 inline QString statusTip() const
58 { return data(Qt::StatusTipRole).toString(); }
59 inline void setStatusTip(const QString &statusTip);
60
61#if QT_CONFIG(tooltip)
62 inline QString toolTip() const
63 { return data(Qt::ToolTipRole).toString(); }
64 inline void setToolTip(const QString &toolTip);
65#endif
66
67#if QT_CONFIG(whatsthis)
68 inline QString whatsThis() const
69 { return data(Qt::WhatsThisRole).toString(); }
70 inline void setWhatsThis(const QString &whatsThis);
71#endif
72
73 inline QFont font() const
74 { return qvariant_cast<QFont>(data(Qt::FontRole)); }
75 inline void setFont(const QFont &font);
76
77#if QT_VERSION < QT_VERSION_CHECK(7, 0, 0)
78 inline int textAlignment() const
79 { return data(Qt::TextAlignmentRole).toInt(); }
80#else
81 inline Qt::Alignment textAlignment() const
82 { return qvariant_cast<Qt::Alignment>(data(Qt::TextAlignmentRole)); }
83#endif
84#if QT_DEPRECATED_SINCE(6, 4)
85 QT_DEPRECATED_VERSION_X_6_4("Use the overload taking Qt::Alignment")
86 inline void setTextAlignment(int alignment)
87 { setData(Qt::TextAlignmentRole, alignment); }
88 inline void setTextAlignment(Qt::AlignmentFlag alignment)
89 { setData(Qt::TextAlignmentRole, QVariant::fromValue(Qt::Alignment(alignment))); }
90#endif
91 inline void setTextAlignment(Qt::Alignment alignment)
92 { setData(Qt::TextAlignmentRole, QVariant::fromValue(alignment)); }
93
94 inline QBrush background() const
95 { return qvariant_cast<QBrush>(data(Qt::BackgroundRole)); }
96 inline void setBackground(const QBrush &brush)
97 { setData(Qt::BackgroundRole, brush.style() != Qt::NoBrush ? QVariant(brush) : QVariant()); }
98
99 inline QBrush foreground() const
100 { return qvariant_cast<QBrush>(data(Qt::ForegroundRole)); }
101 inline void setForeground(const QBrush &brush)
102 { setData(Qt::ForegroundRole, brush.style() != Qt::NoBrush ? QVariant(brush) : QVariant()); }
103
104 inline Qt::CheckState checkState() const
105 { return qvariant_cast<Qt::CheckState>(data(Qt::CheckStateRole)); }
106 inline void setCheckState(Qt::CheckState state)
107 { setData(Qt::CheckStateRole, static_cast<int>(state)); }
108
109 inline QSize sizeHint() const
110 { return qvariant_cast<QSize>(data(Qt::SizeHintRole)); }
111 inline void setSizeHint(const QSize &size)
112 { setData(Qt::SizeHintRole, size.isValid() ? QVariant(size) : QVariant()); }
113
114 virtual QVariant data(int role) const;
115 virtual void setData(int role, const QVariant &value);
116
117 virtual bool operator<(const QListWidgetItem &other) const;
118
119#ifndef QT_NO_DATASTREAM
120 virtual void read(QDataStream &in);
121 virtual void write(QDataStream &out) const;
122#endif
123 QListWidgetItem &operator=(const QListWidgetItem &other);
124
125 inline int type() const { return rtti; }
126
127private:
128 QListModel *listModel() const;
129 int rtti;
130 QListWidget *view;
131 QListWidgetItemPrivate *d;
132 Qt::ItemFlags itemFlags;
133};
134
135inline void QListWidgetItem::setText(const QString &atext)
136{ setData(Qt::DisplayRole, atext); }
137
138inline void QListWidgetItem::setIcon(const QIcon &aicon)
139{ setData(Qt::DecorationRole, aicon); }
140
141inline void QListWidgetItem::setStatusTip(const QString &astatusTip)
142{ setData(Qt::StatusTipRole, astatusTip); }
143
144#if QT_CONFIG(tooltip)
145inline void QListWidgetItem::setToolTip(const QString &atoolTip)
146{ setData(Qt::ToolTipRole, atoolTip); }
147#endif
148
149#if QT_CONFIG(whatsthis)
150inline void QListWidgetItem::setWhatsThis(const QString &awhatsThis)
151{ setData(Qt::WhatsThisRole, awhatsThis); }
152#endif
153
154inline void QListWidgetItem::setFont(const QFont &afont)
155{ setData(Qt::FontRole, afont); }
156
157#ifndef QT_NO_DATASTREAM
158Q_WIDGETS_EXPORT QDataStream &operator<<(QDataStream &out, const QListWidgetItem &item);
159Q_WIDGETS_EXPORT QDataStream &operator>>(QDataStream &in, QListWidgetItem &item);
160#endif
161
162class QListWidgetPrivate;
163
164class Q_WIDGETS_EXPORT QListWidget : public QListView
165{
166 Q_OBJECT
167 Q_PROPERTY(int count READ count)
168 Q_PROPERTY(int currentRow READ currentRow WRITE setCurrentRow NOTIFY currentRowChanged
169 USER true)
170 Q_PROPERTY(bool sortingEnabled READ isSortingEnabled WRITE setSortingEnabled)
171#if QT_CONFIG(draganddrop)
172 Q_PROPERTY(Qt::DropActions supportedDragActions READ supportedDragActions WRITE setSupportedDragActions)
173#endif
174
175 friend class QListWidgetItem;
176 friend class QListModel;
177public:
178 explicit QListWidget(QWidget *parent = nullptr);
179 ~QListWidget();
180
181 void setSelectionModel(QItemSelectionModel *selectionModel) override;
182
183 QListWidgetItem *item(int row) const;
184 int row(const QListWidgetItem *item) const;
185 void insertItem(int row, QListWidgetItem *item);
186 void insertItem(int row, const QString &label);
187 void insertItems(int row, const QStringList &labels);
188 inline void addItem(const QString &label) { insertItem(count(), label); }
189 inline void addItem(QListWidgetItem *item);
190 inline void addItems(const QStringList &labels) { insertItems(count(), labels); }
191 QListWidgetItem *takeItem(int row);
192 int count() const;
193
194 QListWidgetItem *currentItem() const;
195 void setCurrentItem(QListWidgetItem *item);
196 void setCurrentItem(QListWidgetItem *item, QItemSelectionModel::SelectionFlags command);
197
198 int currentRow() const;
199 void setCurrentRow(int row);
200 void setCurrentRow(int row, QItemSelectionModel::SelectionFlags command);
201
202 QListWidgetItem *itemAt(const QPoint &p) const;
203 inline QListWidgetItem *itemAt(int x, int y) const;
204 QRect visualItemRect(const QListWidgetItem *item) const;
205
206 void sortItems(Qt::SortOrder order = Qt::AscendingOrder);
207 void setSortingEnabled(bool enable);
208 bool isSortingEnabled() const;
209
210 void editItem(QListWidgetItem *item);
211 void openPersistentEditor(QListWidgetItem *item);
212 void closePersistentEditor(QListWidgetItem *item);
213 using QAbstractItemView::isPersistentEditorOpen;
214 bool isPersistentEditorOpen(QListWidgetItem *item) const;
215
216 QWidget *itemWidget(QListWidgetItem *item) const;
217 void setItemWidget(QListWidgetItem *item, QWidget *widget);
218 inline void removeItemWidget(QListWidgetItem *item);
219
220 QList<QListWidgetItem*> selectedItems() const;
221 QList<QListWidgetItem*> findItems(const QString &text, Qt::MatchFlags flags) const;
222
223 QList<QListWidgetItem*> items(const QMimeData *data) const;
224
225 QModelIndex indexFromItem(const QListWidgetItem *item) const;
226 QListWidgetItem *itemFromIndex(const QModelIndex &index) const;
227
228#if QT_CONFIG(draganddrop)
229 void setSupportedDragActions(Qt::DropActions actions);
230 Qt::DropActions supportedDragActions() const;
231#endif
232protected:
233#if QT_CONFIG(draganddrop)
234 void dropEvent(QDropEvent *event) override;
235#endif
236public Q_SLOTS:
237 void scrollToItem(const QListWidgetItem *item, QAbstractItemView::ScrollHint hint = EnsureVisible);
238 void clear();
239
240Q_SIGNALS:
241 void itemPressed(QListWidgetItem *item);
242 void itemClicked(QListWidgetItem *item);
243 void itemDoubleClicked(QListWidgetItem *item);
244 void itemActivated(QListWidgetItem *item);
245 void itemEntered(QListWidgetItem *item);
246 void itemChanged(QListWidgetItem *item);
247
248 void currentItemChanged(QListWidgetItem *current, QListWidgetItem *previous);
249 void currentTextChanged(const QString &currentText);
250 void currentRowChanged(int currentRow);
251
252 void itemSelectionChanged();
253
254protected:
255 bool event(QEvent *e) override;
256 virtual QStringList mimeTypes() const;
257 virtual QMimeData *mimeData(const QList<QListWidgetItem *> &items) const;
258#if QT_CONFIG(draganddrop)
259 virtual bool dropMimeData(int index, const QMimeData *data, Qt::DropAction action);
260 virtual Qt::DropActions supportedDropActions() const;
261#endif
262
263private:
264 void setModel(QAbstractItemModel *model) override;
265 Qt::SortOrder sortOrder() const;
266
267 Q_DECLARE_PRIVATE(QListWidget)
268 Q_DISABLE_COPY(QListWidget)
269};
270
271inline void QListWidget::removeItemWidget(QListWidgetItem *aItem)
272{ setItemWidget(aItem, nullptr); }
273
274inline void QListWidget::addItem(QListWidgetItem *aitem)
275{ insertItem(count(), aitem); }
276
277inline QListWidgetItem *QListWidget::itemAt(int ax, int ay) const
278{ return itemAt(QPoint(ax, ay)); }
279
280inline void QListWidgetItem::setHidden(bool ahide)
281{ if (view) view->setRowHidden(view->row(this), ahide); }
282
283inline bool QListWidgetItem::isHidden() const
284{ return (view ? view->isRowHidden(view->row(this)) : false); }
285
286QT_END_NAMESPACE
287
288#endif // QLISTWIDGET_H
QDataStream
\inmodule QtCore\reentrant
Definition qdatastream.h:50
QListWidgetItem
The QListWidgetItem class provides an item for use with the QListWidget item view class.
Definition qlistwidget.h:24
QListWidget
The QListWidget class provides an item-based list widget.
Definition qlistwidget.h:165
QT_REQUIRE_CONFIG
QT_REQUIRE_CONFIG(listwidget)
operator<<
QDataStream & operator<<(QDataStream &stream, const QImage &image)
[0]
Definition qimage.cpp:4006
operator>>
QDataStream & operator>>(QDataStream &stream, QImage &image)
Definition qimage.cpp:4032