qlistwidget.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  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. #ifndef QLISTWIDGET_H
  40. #define QLISTWIDGET_H
  41. #include <QtWidgets/qlistview.h>
  42. #include <QtCore/qvariant.h>
  43. #include <QtCore/qvector.h>
  44. #include <QtCore/qitemselectionmodel.h>
  45. QT_BEGIN_NAMESPACE
  46. #ifndef QT_NO_LISTWIDGET
  47. class QListWidget;
  48. class QListModel;
  49. class QWidgetItemData;
  50. class QListWidgetItemPrivate;
  51. class Q_WIDGETS_EXPORT QListWidgetItem
  52. {
  53. friend class QListModel;
  54. friend class QListWidget;
  55. public:
  56. enum ItemType { Type = 0, UserType = 1000 };
  57. explicit QListWidgetItem(QListWidget *view = Q_NULLPTR, int type = Type);
  58. explicit QListWidgetItem(const QString &text, QListWidget *view = Q_NULLPTR, int type = Type);
  59. explicit QListWidgetItem(const QIcon &icon, const QString &text,
  60. QListWidget *view = Q_NULLPTR, int type = Type);
  61. QListWidgetItem(const QListWidgetItem &other);
  62. virtual ~QListWidgetItem();
  63. virtual QListWidgetItem *clone() const;
  64. inline QListWidget *listWidget() const { return view; }
  65. inline void setSelected(bool select);
  66. inline bool isSelected() const;
  67. inline void setHidden(bool hide);
  68. inline bool isHidden() const;
  69. inline Qt::ItemFlags flags() const { return itemFlags; }
  70. void setFlags(Qt::ItemFlags flags);
  71. inline QString text() const
  72. { return data(Qt::DisplayRole).toString(); }
  73. inline void setText(const QString &text);
  74. inline QIcon icon() const
  75. { return qvariant_cast<QIcon>(data(Qt::DecorationRole)); }
  76. inline void setIcon(const QIcon &icon);
  77. inline QString statusTip() const
  78. { return data(Qt::StatusTipRole).toString(); }
  79. inline void setStatusTip(const QString &statusTip);
  80. #ifndef QT_NO_TOOLTIP
  81. inline QString toolTip() const
  82. { return data(Qt::ToolTipRole).toString(); }
  83. inline void setToolTip(const QString &toolTip);
  84. #endif
  85. #ifndef QT_NO_WHATSTHIS
  86. inline QString whatsThis() const
  87. { return data(Qt::WhatsThisRole).toString(); }
  88. inline void setWhatsThis(const QString &whatsThis);
  89. #endif
  90. inline QFont font() const
  91. { return qvariant_cast<QFont>(data(Qt::FontRole)); }
  92. inline void setFont(const QFont &font);
  93. inline int textAlignment() const
  94. { return data(Qt::TextAlignmentRole).toInt(); }
  95. inline void setTextAlignment(int alignment)
  96. { setData(Qt::TextAlignmentRole, alignment); }
  97. inline QColor backgroundColor() const
  98. { return qvariant_cast<QColor>(data(Qt::BackgroundColorRole)); }
  99. virtual void setBackgroundColor(const QColor &color)
  100. { setData(Qt::BackgroundColorRole, color); }
  101. inline QBrush background() const
  102. { return qvariant_cast<QBrush>(data(Qt::BackgroundRole)); }
  103. inline void setBackground(const QBrush &brush)
  104. { setData(Qt::BackgroundRole, brush); }
  105. inline QColor textColor() const
  106. { return qvariant_cast<QColor>(data(Qt::TextColorRole)); }
  107. inline void setTextColor(const QColor &color)
  108. { setData(Qt::TextColorRole, color); }
  109. inline QBrush foreground() const
  110. { return qvariant_cast<QBrush>(data(Qt::ForegroundRole)); }
  111. inline void setForeground(const QBrush &brush)
  112. { setData(Qt::ForegroundRole, brush); }
  113. inline Qt::CheckState checkState() const
  114. { return static_cast<Qt::CheckState>(data(Qt::CheckStateRole).toInt()); }
  115. inline void setCheckState(Qt::CheckState state)
  116. { setData(Qt::CheckStateRole, static_cast<int>(state)); }
  117. inline QSize sizeHint() const
  118. { return qvariant_cast<QSize>(data(Qt::SizeHintRole)); }
  119. inline void setSizeHint(const QSize &size)
  120. { setData(Qt::SizeHintRole, size); }
  121. virtual QVariant data(int role) const;
  122. virtual void setData(int role, const QVariant &value);
  123. virtual bool operator<(const QListWidgetItem &other) const;
  124. #ifndef QT_NO_DATASTREAM
  125. virtual void read(QDataStream &in);
  126. virtual void write(QDataStream &out) const;
  127. #endif
  128. QListWidgetItem &operator=(const QListWidgetItem &other);
  129. inline int type() const { return rtti; }
  130. private:
  131. int rtti;
  132. QVector<void *> dummy;
  133. QListWidget *view;
  134. QListWidgetItemPrivate *d;
  135. Qt::ItemFlags itemFlags;
  136. };
  137. inline void QListWidgetItem::setText(const QString &atext)
  138. { setData(Qt::DisplayRole, atext); }
  139. inline void QListWidgetItem::setIcon(const QIcon &aicon)
  140. { setData(Qt::DecorationRole, aicon); }
  141. inline void QListWidgetItem::setStatusTip(const QString &astatusTip)
  142. { setData(Qt::StatusTipRole, astatusTip); }
  143. #ifndef QT_NO_TOOLTIP
  144. inline void QListWidgetItem::setToolTip(const QString &atoolTip)
  145. { setData(Qt::ToolTipRole, atoolTip); }
  146. #endif
  147. #ifndef QT_NO_WHATSTHIS
  148. inline void QListWidgetItem::setWhatsThis(const QString &awhatsThis)
  149. { setData(Qt::WhatsThisRole, awhatsThis); }
  150. #endif
  151. inline void QListWidgetItem::setFont(const QFont &afont)
  152. { setData(Qt::FontRole, afont); }
  153. #ifndef QT_NO_DATASTREAM
  154. Q_WIDGETS_EXPORT QDataStream &operator<<(QDataStream &out, const QListWidgetItem &item);
  155. Q_WIDGETS_EXPORT QDataStream &operator>>(QDataStream &in, QListWidgetItem &item);
  156. #endif
  157. class QListWidgetPrivate;
  158. class Q_WIDGETS_EXPORT QListWidget : public QListView
  159. {
  160. Q_OBJECT
  161. Q_PROPERTY(int count READ count)
  162. Q_PROPERTY(int currentRow READ currentRow WRITE setCurrentRow NOTIFY currentRowChanged USER true)
  163. Q_PROPERTY(bool sortingEnabled READ isSortingEnabled WRITE setSortingEnabled)
  164. friend class QListWidgetItem;
  165. friend class QListModel;
  166. public:
  167. explicit QListWidget(QWidget *parent = Q_NULLPTR);
  168. ~QListWidget();
  169. void setSelectionModel(QItemSelectionModel *selectionModel) Q_DECL_OVERRIDE;
  170. QListWidgetItem *item(int row) const;
  171. int row(const QListWidgetItem *item) const;
  172. void insertItem(int row, QListWidgetItem *item);
  173. void insertItem(int row, const QString &label);
  174. void insertItems(int row, const QStringList &labels);
  175. inline void addItem(const QString &label) { insertItem(count(), label); }
  176. inline void addItem(QListWidgetItem *item);
  177. inline void addItems(const QStringList &labels) { insertItems(count(), labels); }
  178. QListWidgetItem *takeItem(int row);
  179. int count() const;
  180. QListWidgetItem *currentItem() const;
  181. void setCurrentItem(QListWidgetItem *item);
  182. void setCurrentItem(QListWidgetItem *item, QItemSelectionModel::SelectionFlags command);
  183. int currentRow() const;
  184. void setCurrentRow(int row);
  185. void setCurrentRow(int row, QItemSelectionModel::SelectionFlags command);
  186. QListWidgetItem *itemAt(const QPoint &p) const;
  187. inline QListWidgetItem *itemAt(int x, int y) const;
  188. QRect visualItemRect(const QListWidgetItem *item) const;
  189. void sortItems(Qt::SortOrder order = Qt::AscendingOrder);
  190. void setSortingEnabled(bool enable);
  191. bool isSortingEnabled() const;
  192. void editItem(QListWidgetItem *item);
  193. void openPersistentEditor(QListWidgetItem *item);
  194. void closePersistentEditor(QListWidgetItem *item);
  195. QWidget *itemWidget(QListWidgetItem *item) const;
  196. void setItemWidget(QListWidgetItem *item, QWidget *widget);
  197. inline void removeItemWidget(QListWidgetItem *item);
  198. bool isItemSelected(const QListWidgetItem *item) const;
  199. void setItemSelected(const QListWidgetItem *item, bool select);
  200. QList<QListWidgetItem*> selectedItems() const;
  201. QList<QListWidgetItem*> findItems(const QString &text, Qt::MatchFlags flags) const;
  202. bool isItemHidden(const QListWidgetItem *item) const;
  203. void setItemHidden(const QListWidgetItem *item, bool hide);
  204. void dropEvent(QDropEvent *event) Q_DECL_OVERRIDE;
  205. public Q_SLOTS:
  206. void scrollToItem(const QListWidgetItem *item, QAbstractItemView::ScrollHint hint = EnsureVisible);
  207. void clear();
  208. Q_SIGNALS:
  209. void itemPressed(QListWidgetItem *item);
  210. void itemClicked(QListWidgetItem *item);
  211. void itemDoubleClicked(QListWidgetItem *item);
  212. void itemActivated(QListWidgetItem *item);
  213. void itemEntered(QListWidgetItem *item);
  214. void itemChanged(QListWidgetItem *item);
  215. void currentItemChanged(QListWidgetItem *current, QListWidgetItem *previous);
  216. void currentTextChanged(const QString &currentText);
  217. void currentRowChanged(int currentRow);
  218. void itemSelectionChanged();
  219. protected:
  220. bool event(QEvent *e) Q_DECL_OVERRIDE;
  221. virtual QStringList mimeTypes() const;
  222. #if QT_VERSION >= QT_VERSION_CHECK(6,0,0)
  223. virtual QMimeData *mimeData(const QList<QListWidgetItem *> &items) const;
  224. #else
  225. virtual QMimeData *mimeData(const QList<QListWidgetItem*> items) const;
  226. #endif
  227. #ifndef QT_NO_DRAGANDDROP
  228. virtual bool dropMimeData(int index, const QMimeData *data, Qt::DropAction action);
  229. virtual Qt::DropActions supportedDropActions() const;
  230. #endif
  231. QList<QListWidgetItem*> items(const QMimeData *data) const;
  232. QModelIndex indexFromItem(QListWidgetItem *item) const;
  233. QListWidgetItem *itemFromIndex(const QModelIndex &index) const;
  234. private:
  235. void setModel(QAbstractItemModel *model) Q_DECL_OVERRIDE;
  236. Qt::SortOrder sortOrder() const;
  237. Q_DECLARE_PRIVATE(QListWidget)
  238. Q_DISABLE_COPY(QListWidget)
  239. Q_PRIVATE_SLOT(d_func(), void _q_emitItemPressed(const QModelIndex &index))
  240. Q_PRIVATE_SLOT(d_func(), void _q_emitItemClicked(const QModelIndex &index))
  241. Q_PRIVATE_SLOT(d_func(), void _q_emitItemDoubleClicked(const QModelIndex &index))
  242. Q_PRIVATE_SLOT(d_func(), void _q_emitItemActivated(const QModelIndex &index))
  243. Q_PRIVATE_SLOT(d_func(), void _q_emitItemEntered(const QModelIndex &index))
  244. Q_PRIVATE_SLOT(d_func(), void _q_emitItemChanged(const QModelIndex &index))
  245. Q_PRIVATE_SLOT(d_func(), void _q_emitCurrentItemChanged(const QModelIndex &previous, const QModelIndex &current))
  246. Q_PRIVATE_SLOT(d_func(), void _q_sort())
  247. Q_PRIVATE_SLOT(d_func(), void _q_dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight))
  248. };
  249. inline void QListWidget::removeItemWidget(QListWidgetItem *aItem)
  250. { setItemWidget(aItem, Q_NULLPTR); }
  251. inline void QListWidget::addItem(QListWidgetItem *aitem)
  252. { insertItem(count(), aitem); }
  253. inline QListWidgetItem *QListWidget::itemAt(int ax, int ay) const
  254. { return itemAt(QPoint(ax, ay)); }
  255. inline void QListWidgetItem::setSelected(bool aselect)
  256. { if (view) view->setItemSelected(this, aselect); }
  257. inline bool QListWidgetItem::isSelected() const
  258. { return (view ? view->isItemSelected(this) : false); }
  259. inline void QListWidgetItem::setHidden(bool ahide)
  260. { if (view) view->setItemHidden(this, ahide); }
  261. inline bool QListWidgetItem::isHidden() const
  262. { return (view ? view->isItemHidden(this) : false); }
  263. #endif // QT_NO_LISTWIDGET
  264. QT_END_NAMESPACE
  265. #endif // QLISTWIDGET_H