361 lines
13 KiB
C++
361 lines
13 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of the QtWidgets module of the Qt Toolkit.
|
|
**
|
|
** $QT_BEGIN_LICENSE:LGPL$
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU Lesser General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU Lesser
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation and appearing in the file LICENSE.LGPL3 included in the
|
|
** packaging of this file. Please review the following information to
|
|
** ensure the GNU Lesser General Public License version 3 requirements
|
|
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 2.0 or (at your option) the GNU General
|
|
** Public license version 3 or any later version approved by the KDE Free
|
|
** Qt Foundation. The licenses are as published by the Free Software
|
|
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
|
|
** https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
** $QT_END_LICENSE$
|
|
**
|
|
****************************************************************************/
|
|
|
|
#ifndef QLISTWIDGET_H
|
|
#define QLISTWIDGET_H
|
|
|
|
#include <QtWidgets/qtwidgetsglobal.h>
|
|
#include <QtWidgets/qlistview.h>
|
|
#include <QtCore/qvariant.h>
|
|
#include <QtCore/qvector.h>
|
|
#include <QtCore/qitemselectionmodel.h>
|
|
|
|
QT_REQUIRE_CONFIG(listwidget);
|
|
|
|
QT_BEGIN_NAMESPACE
|
|
|
|
class QListWidget;
|
|
class QListModel;
|
|
class QWidgetItemData;
|
|
class QListWidgetItemPrivate;
|
|
|
|
class Q_WIDGETS_EXPORT QListWidgetItem
|
|
{
|
|
friend class QListModel;
|
|
friend class QListWidget;
|
|
public:
|
|
enum ItemType { Type = 0, UserType = 1000 };
|
|
explicit QListWidgetItem(QListWidget *listview = nullptr, int type = Type);
|
|
explicit QListWidgetItem(const QString &text, QListWidget *listview = nullptr, int type = Type);
|
|
explicit QListWidgetItem(const QIcon &icon, const QString &text,
|
|
QListWidget *listview = nullptr, int type = Type);
|
|
QListWidgetItem(const QListWidgetItem &other);
|
|
virtual ~QListWidgetItem();
|
|
|
|
virtual QListWidgetItem *clone() const;
|
|
|
|
inline QListWidget *listWidget() const { return view; }
|
|
|
|
void setSelected(bool select);
|
|
bool isSelected() const;
|
|
|
|
inline void setHidden(bool hide);
|
|
inline bool isHidden() const;
|
|
|
|
inline Qt::ItemFlags flags() const { return itemFlags; }
|
|
void setFlags(Qt::ItemFlags flags);
|
|
|
|
inline QString text() const
|
|
{ return data(Qt::DisplayRole).toString(); }
|
|
inline void setText(const QString &text);
|
|
|
|
inline QIcon icon() const
|
|
{ return qvariant_cast<QIcon>(data(Qt::DecorationRole)); }
|
|
inline void setIcon(const QIcon &icon);
|
|
|
|
inline QString statusTip() const
|
|
{ return data(Qt::StatusTipRole).toString(); }
|
|
inline void setStatusTip(const QString &statusTip);
|
|
|
|
#ifndef QT_NO_TOOLTIP
|
|
inline QString toolTip() const
|
|
{ return data(Qt::ToolTipRole).toString(); }
|
|
inline void setToolTip(const QString &toolTip);
|
|
#endif
|
|
|
|
#if QT_CONFIG(whatsthis)
|
|
inline QString whatsThis() const
|
|
{ return data(Qt::WhatsThisRole).toString(); }
|
|
inline void setWhatsThis(const QString &whatsThis);
|
|
#endif
|
|
|
|
inline QFont font() const
|
|
{ return qvariant_cast<QFont>(data(Qt::FontRole)); }
|
|
inline void setFont(const QFont &font);
|
|
|
|
inline int textAlignment() const
|
|
{ return data(Qt::TextAlignmentRole).toInt(); }
|
|
inline void setTextAlignment(int alignment)
|
|
{ setData(Qt::TextAlignmentRole, alignment); }
|
|
|
|
#if QT_DEPRECATED_SINCE(5, 13)
|
|
QT_DEPRECATED_X ("Use QListWidgetItem::background() instead")
|
|
inline QColor backgroundColor() const
|
|
{ return qvariant_cast<QColor>(data(Qt::BackgroundRole)); }
|
|
#endif
|
|
// no QT_DEPRECATED_SINCE because it is a virtual function
|
|
QT_DEPRECATED_X ("Use QListWidgetItem::setBackground() instead")
|
|
virtual void setBackgroundColor(const QColor &color)
|
|
{ setData(Qt::BackgroundRole, color); }
|
|
|
|
inline QBrush background() const
|
|
{ return qvariant_cast<QBrush>(data(Qt::BackgroundRole)); }
|
|
inline void setBackground(const QBrush &brush)
|
|
{ setData(Qt::BackgroundRole, brush.style() != Qt::NoBrush ? QVariant(brush) : QVariant()); }
|
|
|
|
#if QT_DEPRECATED_SINCE(5, 13)
|
|
QT_DEPRECATED_X ("Use QListWidgetItem::foreground() instead")
|
|
inline QColor textColor() const
|
|
{ return qvariant_cast<QColor>(data(Qt::ForegroundRole)); }
|
|
QT_DEPRECATED_X ("Use QListWidgetItem::setForeground() instead")
|
|
inline void setTextColor(const QColor &color)
|
|
{ setData(Qt::ForegroundRole, color); }
|
|
#endif
|
|
|
|
inline QBrush foreground() const
|
|
{ return qvariant_cast<QBrush>(data(Qt::ForegroundRole)); }
|
|
inline void setForeground(const QBrush &brush)
|
|
{ setData(Qt::ForegroundRole, brush.style() != Qt::NoBrush ? QVariant(brush) : QVariant()); }
|
|
|
|
inline Qt::CheckState checkState() const
|
|
{ return static_cast<Qt::CheckState>(data(Qt::CheckStateRole).toInt()); }
|
|
inline void setCheckState(Qt::CheckState state)
|
|
{ setData(Qt::CheckStateRole, static_cast<int>(state)); }
|
|
|
|
inline QSize sizeHint() const
|
|
{ return qvariant_cast<QSize>(data(Qt::SizeHintRole)); }
|
|
inline void setSizeHint(const QSize &size)
|
|
{ setData(Qt::SizeHintRole, size.isValid() ? QVariant(size) : QVariant()); }
|
|
|
|
virtual QVariant data(int role) const;
|
|
virtual void setData(int role, const QVariant &value);
|
|
|
|
virtual bool operator<(const QListWidgetItem &other) const;
|
|
|
|
#ifndef QT_NO_DATASTREAM
|
|
virtual void read(QDataStream &in);
|
|
virtual void write(QDataStream &out) const;
|
|
#endif
|
|
QListWidgetItem &operator=(const QListWidgetItem &other);
|
|
|
|
inline int type() const { return rtti; }
|
|
|
|
private:
|
|
QListModel *listModel() const;
|
|
int rtti;
|
|
QVector<void *> dummy;
|
|
QListWidget *view;
|
|
QListWidgetItemPrivate *d;
|
|
Qt::ItemFlags itemFlags;
|
|
};
|
|
|
|
inline void QListWidgetItem::setText(const QString &atext)
|
|
{ setData(Qt::DisplayRole, atext); }
|
|
|
|
inline void QListWidgetItem::setIcon(const QIcon &aicon)
|
|
{ setData(Qt::DecorationRole, aicon); }
|
|
|
|
inline void QListWidgetItem::setStatusTip(const QString &astatusTip)
|
|
{ setData(Qt::StatusTipRole, astatusTip); }
|
|
|
|
#ifndef QT_NO_TOOLTIP
|
|
inline void QListWidgetItem::setToolTip(const QString &atoolTip)
|
|
{ setData(Qt::ToolTipRole, atoolTip); }
|
|
#endif
|
|
|
|
#if QT_CONFIG(whatsthis)
|
|
inline void QListWidgetItem::setWhatsThis(const QString &awhatsThis)
|
|
{ setData(Qt::WhatsThisRole, awhatsThis); }
|
|
#endif
|
|
|
|
inline void QListWidgetItem::setFont(const QFont &afont)
|
|
{ setData(Qt::FontRole, afont); }
|
|
|
|
#ifndef QT_NO_DATASTREAM
|
|
Q_WIDGETS_EXPORT QDataStream &operator<<(QDataStream &out, const QListWidgetItem &item);
|
|
Q_WIDGETS_EXPORT QDataStream &operator>>(QDataStream &in, QListWidgetItem &item);
|
|
#endif
|
|
|
|
class QListWidgetPrivate;
|
|
|
|
class Q_WIDGETS_EXPORT QListWidget : public QListView
|
|
{
|
|
Q_OBJECT
|
|
Q_PROPERTY(int count READ count)
|
|
Q_PROPERTY(int currentRow READ currentRow WRITE setCurrentRow NOTIFY currentRowChanged USER true)
|
|
Q_PROPERTY(bool sortingEnabled READ isSortingEnabled WRITE setSortingEnabled)
|
|
|
|
friend class QListWidgetItem;
|
|
friend class QListModel;
|
|
public:
|
|
explicit QListWidget(QWidget *parent = nullptr);
|
|
~QListWidget();
|
|
|
|
void setSelectionModel(QItemSelectionModel *selectionModel) override;
|
|
|
|
QListWidgetItem *item(int row) const;
|
|
int row(const QListWidgetItem *item) const;
|
|
void insertItem(int row, QListWidgetItem *item);
|
|
void insertItem(int row, const QString &label);
|
|
void insertItems(int row, const QStringList &labels);
|
|
inline void addItem(const QString &label) { insertItem(count(), label); }
|
|
inline void addItem(QListWidgetItem *item);
|
|
inline void addItems(const QStringList &labels) { insertItems(count(), labels); }
|
|
QListWidgetItem *takeItem(int row);
|
|
int count() const;
|
|
|
|
QListWidgetItem *currentItem() const;
|
|
void setCurrentItem(QListWidgetItem *item);
|
|
void setCurrentItem(QListWidgetItem *item, QItemSelectionModel::SelectionFlags command);
|
|
|
|
int currentRow() const;
|
|
void setCurrentRow(int row);
|
|
void setCurrentRow(int row, QItemSelectionModel::SelectionFlags command);
|
|
|
|
QListWidgetItem *itemAt(const QPoint &p) const;
|
|
inline QListWidgetItem *itemAt(int x, int y) const;
|
|
QRect visualItemRect(const QListWidgetItem *item) const;
|
|
|
|
void sortItems(Qt::SortOrder order = Qt::AscendingOrder);
|
|
void setSortingEnabled(bool enable);
|
|
bool isSortingEnabled() const;
|
|
|
|
void editItem(QListWidgetItem *item);
|
|
void openPersistentEditor(QListWidgetItem *item);
|
|
void closePersistentEditor(QListWidgetItem *item);
|
|
using QAbstractItemView::isPersistentEditorOpen;
|
|
bool isPersistentEditorOpen(QListWidgetItem *item) const;
|
|
|
|
QWidget *itemWidget(QListWidgetItem *item) const;
|
|
void setItemWidget(QListWidgetItem *item, QWidget *widget);
|
|
inline void removeItemWidget(QListWidgetItem *item);
|
|
|
|
#if QT_DEPRECATED_SINCE(5, 13)
|
|
QT_DEPRECATED_X ("Use QListWidgetItem::isSelected() instead")
|
|
bool isItemSelected(const QListWidgetItem *item) const;
|
|
QT_DEPRECATED_X ("Use QListWidgetItem::setSelected() instead")
|
|
void setItemSelected(const QListWidgetItem *item, bool select);
|
|
#endif
|
|
QList<QListWidgetItem*> selectedItems() const;
|
|
QList<QListWidgetItem*> findItems(const QString &text, Qt::MatchFlags flags) const;
|
|
|
|
#if QT_DEPRECATED_SINCE(5, 13)
|
|
QT_DEPRECATED_X ("Use QListWidgetItem::isHidden() instead")
|
|
bool isItemHidden(const QListWidgetItem *item) const;
|
|
QT_DEPRECATED_X ("Use QListWidgetItem::setHidden() instead")
|
|
void setItemHidden(const QListWidgetItem *item, bool hide);
|
|
#endif
|
|
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
|
|
protected:
|
|
#endif
|
|
#if QT_CONFIG(draganddrop)
|
|
void dropEvent(QDropEvent *event) override;
|
|
#endif
|
|
public Q_SLOTS:
|
|
void scrollToItem(const QListWidgetItem *item, QAbstractItemView::ScrollHint hint = EnsureVisible);
|
|
void clear();
|
|
|
|
Q_SIGNALS:
|
|
void itemPressed(QListWidgetItem *item);
|
|
void itemClicked(QListWidgetItem *item);
|
|
void itemDoubleClicked(QListWidgetItem *item);
|
|
void itemActivated(QListWidgetItem *item);
|
|
void itemEntered(QListWidgetItem *item);
|
|
// ### Qt 6: add changed roles
|
|
void itemChanged(QListWidgetItem *item);
|
|
|
|
void currentItemChanged(QListWidgetItem *current, QListWidgetItem *previous);
|
|
void currentTextChanged(const QString ¤tText);
|
|
void currentRowChanged(int currentRow);
|
|
|
|
void itemSelectionChanged();
|
|
|
|
protected:
|
|
bool event(QEvent *e) override;
|
|
virtual QStringList mimeTypes() const;
|
|
#if QT_VERSION >= QT_VERSION_CHECK(6,0,0)
|
|
virtual QMimeData *mimeData(const QList<QListWidgetItem *> &items) const;
|
|
#else
|
|
virtual QMimeData *mimeData(const QList<QListWidgetItem*> items) const;
|
|
#endif
|
|
#if QT_CONFIG(draganddrop)
|
|
virtual bool dropMimeData(int index, const QMimeData *data, Qt::DropAction action);
|
|
virtual Qt::DropActions supportedDropActions() const;
|
|
#endif
|
|
|
|
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
|
|
public:
|
|
#else
|
|
protected:
|
|
#endif
|
|
QList<QListWidgetItem*> items(const QMimeData *data) const;
|
|
|
|
QModelIndex indexFromItem(const QListWidgetItem *item) const;
|
|
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
|
|
QModelIndex indexFromItem(QListWidgetItem *item) const; // ### Qt 6: remove
|
|
#endif
|
|
QListWidgetItem *itemFromIndex(const QModelIndex &index) const;
|
|
|
|
private:
|
|
void setModel(QAbstractItemModel *model) override;
|
|
Qt::SortOrder sortOrder() const;
|
|
|
|
Q_DECLARE_PRIVATE(QListWidget)
|
|
Q_DISABLE_COPY(QListWidget)
|
|
|
|
Q_PRIVATE_SLOT(d_func(), void _q_emitItemPressed(const QModelIndex &index))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_emitItemClicked(const QModelIndex &index))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_emitItemDoubleClicked(const QModelIndex &index))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_emitItemActivated(const QModelIndex &index))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_emitItemEntered(const QModelIndex &index))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_emitItemChanged(const QModelIndex &index))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_emitCurrentItemChanged(const QModelIndex &previous, const QModelIndex ¤t))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_sort())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight))
|
|
};
|
|
|
|
inline void QListWidget::removeItemWidget(QListWidgetItem *aItem)
|
|
{ setItemWidget(aItem, nullptr); }
|
|
|
|
inline void QListWidget::addItem(QListWidgetItem *aitem)
|
|
{ insertItem(count(), aitem); }
|
|
|
|
inline QListWidgetItem *QListWidget::itemAt(int ax, int ay) const
|
|
{ return itemAt(QPoint(ax, ay)); }
|
|
|
|
inline void QListWidgetItem::setHidden(bool ahide)
|
|
{ if (view) view->setRowHidden(view->row(this), ahide); }
|
|
|
|
inline bool QListWidgetItem::isHidden() const
|
|
{ return (view ? view->isRowHidden(view->row(this)) : false); }
|
|
|
|
QT_END_NAMESPACE
|
|
|
|
#endif // QLISTWIDGET_H
|