include/QtCore/qabstractproxymodel.h

0001 // Copyright (C) 2016 The Qt Company Ltd.
0002 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
0003 // Qt-Security score:significant reason:default
0004
0005 #ifndef QABSTRACTPROXYMODEL_H
0006 #define QABSTRACTPROXYMODEL_H
0007
0008 #include <QtCore/qabstractitemmodel.h>
0009
0010 QT_REQUIRE_CONFIG(proxymodel);
0011
0012 QT_BEGIN_NAMESPACE
0013
0014 class QAbstractProxyModelPrivate;
0015 class QItemSelection;
0016
0017 class Q_CORE_EXPORT QAbstractProxyModel : public QAbstractItemModel
0018 {
0019     Q_OBJECT
0020     Q_PROPERTY(QAbstractItemModel *sourceModel READ sourceModel WRITE setSourceModel
0021                NOTIFY sourceModelChanged BINDABLE bindableSourceModel)
0022
0023 public:
0024     explicit QAbstractProxyModel(QObject *parent = nullptr);
0025     ~QAbstractProxyModel();
0026
0027     virtual void setSourceModel(QAbstractItemModel *sourceModel);
0028     QAbstractItemModel *sourceModel() const;
0029     QBindable<QAbstractItemModel *> bindableSourceModel();
0030
0031     Q_INVOKABLE virtual QModelIndex mapToSource(const QModelIndex &proxyIndex) const = 0;
0032     Q_INVOKABLE virtual QModelIndex mapFromSource(const QModelIndex &sourceIndex) const = 0;
0033
0034     Q_INVOKABLE virtual QItemSelection mapSelectionToSource(const QItemSelection &selection) const;
0035     Q_INVOKABLE virtual QItemSelection mapSelectionFromSource(const QItemSelection &selection) const;
0036
0037     bool submit() override;
0038     void revert() override;
0039
0040     QVariant data(const QModelIndex &proxyIndex, int role = Qt::DisplayRole) const override;
0041     QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
0042     QMap<int, QVariant> itemData(const QModelIndex &index) const override;
0043     Qt::ItemFlags flags(const QModelIndex &index) const override;
0044
0045     bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
0046     bool setItemData(const QModelIndex& index, const QMap<int, QVariant> &roles) override;
0047     bool setHeaderData(int section, Qt::Orientation orientation, const QVariant &value, int role = Qt::EditRole) override;
0048     bool clearItemData(const QModelIndex &index) override;
0049
0050     QModelIndex buddy(const QModelIndex &index) const override;
0051     bool canFetchMore(const QModelIndex &parent) const override;
0052     void fetchMore(const QModelIndex &parent) override;
0053     void sort(int column, Qt::SortOrder order = Qt::AscendingOrder) override;
0054     QSize span(const QModelIndex &index) const override;
0055     bool hasChildren(const QModelIndex &parent = QModelIndex()) const override;
0056     QModelIndex sibling(int row, int column, const QModelIndex &idx) const override;
0057
0058     QMimeData* mimeData(const QModelIndexList &indexes) const override;
0059     bool canDropMimeData(const QMimeData *data, Qt::DropAction action,
0060                          int row, int column, const QModelIndex &parent) const override;
0061     bool dropMimeData(const QMimeData *data, Qt::DropAction action,
0062                       int row, int column, const QModelIndex &parent) override;
0063     QStringList mimeTypes() const override;
0064     Qt::DropActions supportedDragActions() const override;
0065     Qt::DropActions supportedDropActions() const override;
0066     QHash<int, QByteArray> roleNames() const override;
0067
0068 Q_SIGNALS:
0069     void sourceModelChanged(QPrivateSignal);
0070
0071 protected:
0072     QModelIndex createSourceIndex(int row, int col, void *internalPtr) const;
0073     QAbstractProxyModel(QAbstractProxyModelPrivate &, QObject *parent);
0074
0075 private:
0076     Q_DECLARE_PRIVATE(QAbstractProxyModel)
0077     Q_DISABLE_COPY(QAbstractProxyModel)
0078     Q_PRIVATE_SLOT(d_func(), void _q_sourceModelDestroyed())
0079     Q_PRIVATE_SLOT(d_func(), void _q_sourceModelRowsAboutToBeInserted(QModelIndex, int, int))
0080     Q_PRIVATE_SLOT(d_func(), void _q_sourceModelRowsInserted(QModelIndex, int, int))
0081     Q_PRIVATE_SLOT(d_func(), void _q_sourceModelRowsRemoved(QModelIndex, int, int))
0082     Q_PRIVATE_SLOT(d_func(), void _q_sourceModelColumnsAboutToBeInserted(QModelIndex, int, int))
0083     Q_PRIVATE_SLOT(d_func(), void _q_sourceModelColumnsInserted(QModelIndex, int, int))
0084     Q_PRIVATE_SLOT(d_func(), void _q_sourceModelColumnsRemoved(QModelIndex, int, int))
0085 };
0086
0087 QT_END_NAMESPACE
0088
0089 #endif // QABSTRACTPROXYMODEL_H