summaryrefslogtreecommitdiffstats
path: root/src/corelib/itemmodels/qabstractproxymodel_p.h
blob: 350735afd15f2c58c7f3bbc9fb04056f5256259e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtCore 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 QABSTRACTPROXYMODEL_P_H
#define QABSTRACTPROXYMODEL_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists for the convenience
// of QAbstractItemModel*.  This header file may change from version
// to version without notice, or even be removed.
//
// We mean it.
//
//

#include "private/qabstractitemmodel_p.h"
#include "private/qproperty_p.h"

QT_REQUIRE_CONFIG(proxymodel);

QT_BEGIN_NAMESPACE

class QAbstractProxyModelBindable : public QUntypedBindable
{
public:
    explicit QAbstractProxyModelBindable(QUntypedPropertyData *d,
                                         const QtPrivate::QBindableInterface *i)
        : QUntypedBindable(d, i)
    {
    }
};

class Q_CORE_EXPORT QAbstractProxyModelPrivate : public QAbstractItemModelPrivate
{
    Q_DECLARE_PUBLIC(QAbstractProxyModel)
public:
    QAbstractProxyModelPrivate() : QAbstractItemModelPrivate() { }
    void setModelForwarder(QAbstractItemModel *sourceModel)
    {
        q_func()->setSourceModel(sourceModel);
    }
    void modelChangedForwarder()
    {
        Q_EMIT q_func()->sourceModelChanged(QAbstractProxyModel::QPrivateSignal());
    }
    Q_OBJECT_COMPAT_PROPERTY_WITH_ARGS(QAbstractProxyModelPrivate, QAbstractItemModel *, model,
                                       &QAbstractProxyModelPrivate::setModelForwarder,
                                       &QAbstractProxyModelPrivate::modelChangedForwarder, nullptr)
    virtual void _q_sourceModelDestroyed();
    void mapDropCoordinatesToSource(int row, int column, const QModelIndex &parent,
                                    int *source_row, int *source_column, QModelIndex *source_parent) const;

    using ModelPropertyType = decltype(model);
};

namespace QtPrivate {

/*!
    The biggest trick for adding new QProperty binding support here is the
    getter for the sourceModel property (QAbstractProxyModel::sourceModel),
    which returns nullptr, while internally using a global staticEmptyModel()
    instance.
    This lead to inconsistency while binding to a proxy model without source
    model. The bound object would point to staticEmptyModel() instance, while
    sourceModel() getter returns nullptr.
    To solve this issue we need to implement a custom QBindableInterface, with
    custom getter and makeBinding methods, that would introduce the required
    logic.
*/

inline QAbstractItemModel *normalizePotentiallyEmptyModel(QAbstractItemModel *model)
{
    if (model == QAbstractItemModelPrivate::staticEmptyModel())
        return nullptr;
    return model;
}

class QBindableInterfaceForSourceModel
{
    using PropertyType = QAbstractProxyModelPrivate::ModelPropertyType;
    using Parent = QBindableInterfaceForProperty<PropertyType>;
    using T = typename PropertyType::value_type;

public:
    static constexpr QBindableInterface iface = {
        [](const QUntypedPropertyData *d, void *value) -> void {
            const auto val = static_cast<const PropertyType *>(d)->value();
            *static_cast<T *>(value) = normalizePotentiallyEmptyModel(val);
        },
        Parent::iface.setter,
        Parent::iface.getBinding,
        Parent::iface.setBinding,
        [](const QUntypedPropertyData *d,
           const QPropertyBindingSourceLocation &location) -> QUntypedPropertyBinding {
            return Qt::makePropertyBinding(
                    [d]() -> T {
                        return normalizePotentiallyEmptyModel(
                                static_cast<const PropertyType *>(d)->value());
                    },
                    location);
        },
        Parent::iface.setObserver,
        Parent::iface.metaType
    };
};

} // namespace QtPrivate

QT_END_NAMESPACE

#endif // QABSTRACTPROXYMODEL_P_H