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 QtCore 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 
40 #ifndef QABSTRACTPROXYMODEL_H
41 #define QABSTRACTPROXYMODEL_H
42 
43 #include <QtCore/qabstractitemmodel.h>
44 
45 QT_REQUIRE_CONFIG(proxymodel);
46 
47 QT_BEGIN_NAMESPACE
48 
49 class QAbstractProxyModelPrivate;
50 class QItemSelection;
51 
52 class Q_CORE_EXPORT QAbstractProxyModel : public QAbstractItemModel
53 {
54     Q_OBJECT
55     Q_PROPERTY(QAbstractItemModel* sourceModel READ sourceModel WRITE setSourceModel NOTIFY sourceModelChanged)
56 
57 public:
58     explicit QAbstractProxyModel(QObject *parent = nullptr);
59     ~QAbstractProxyModel();
60 
61     virtual void setSourceModel(QAbstractItemModel *sourceModel);
62     QAbstractItemModel *sourceModel() const;
63 
64     Q_INVOKABLE virtual QModelIndex mapToSource(const QModelIndex &proxyIndex) const = 0;
65     Q_INVOKABLE virtual QModelIndex mapFromSource(const QModelIndex &sourceIndex) const = 0;
66 
67     Q_INVOKABLE virtual QItemSelection mapSelectionToSource(const QItemSelection &selection) const;
68     Q_INVOKABLE virtual QItemSelection mapSelectionFromSource(const QItemSelection &selection) const;
69 
70     bool submit() override;
71     void revert() override;
72 
73     QVariant data(const QModelIndex &proxyIndex, int role = Qt::DisplayRole) const override;
74     QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
75     QMap<int, QVariant> itemData(const QModelIndex &index) const override;
76     Qt::ItemFlags flags(const QModelIndex &index) const override;
77 
78     bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
79     bool setItemData(const QModelIndex& index, const QMap<int, QVariant> &roles) override;
80     bool setHeaderData(int section, Qt::Orientation orientation, const QVariant &value, int role = Qt::EditRole) override;
81 #if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
82     bool clearItemData(const QModelIndex &index) override;
83 #endif
84 
85     QModelIndex buddy(const QModelIndex &index) const override;
86     bool canFetchMore(const QModelIndex &parent) const override;
87     void fetchMore(const QModelIndex &parent) override;
88     void sort(int column, Qt::SortOrder order = Qt::AscendingOrder) override;
89     QSize span(const QModelIndex &index) const override;
90     bool hasChildren(const QModelIndex &parent = QModelIndex()) const override;
91     QModelIndex sibling(int row, int column, const QModelIndex &idx) const override;
92 
93     QMimeData* mimeData(const QModelIndexList &indexes) const override;
94     bool canDropMimeData(const QMimeData *data, Qt::DropAction action,
95                          int row, int column, const QModelIndex &parent) const override;
96     bool dropMimeData(const QMimeData *data, Qt::DropAction action,
97                       int row, int column, const QModelIndex &parent) override;
98     QStringList mimeTypes() const override;
99     Qt::DropActions supportedDragActions() const override;
100     Qt::DropActions supportedDropActions() const override;
101 
102 Q_SIGNALS:
103     void sourceModelChanged(QPrivateSignal);
104 
105 protected Q_SLOTS:
106     void resetInternalData();
107 
108 protected:
109     QAbstractProxyModel(QAbstractProxyModelPrivate &, QObject *parent);
110 
111 private:
112     Q_DECLARE_PRIVATE(QAbstractProxyModel)
113     Q_DISABLE_COPY(QAbstractProxyModel)
114     Q_PRIVATE_SLOT(d_func(), void _q_sourceModelDestroyed())
115 };
116 
117 QT_END_NAMESPACE
118 
119 #endif // QABSTRACTPROXYMODEL_H
120