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
|
/*
serverproxymodel.h
This file is part of GammaRay, the Qt application inspection and manipulation tool.
SPDX-FileCopyrightText: 2014 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
Author: Volker Krause <volker.krause@kdab.com>
SPDX-License-Identifier: GPL-2.0-or-later
Contact KDAB at <info@kdab.com> for commercial licensing options.
*/
#ifndef GAMMARAY_SERVERPROXYMODEL_H
#define GAMMARAY_SERVERPROXYMODEL_H
#include <common/modelevent.h>
#include <QCoreApplication>
#include <QPointer>
#include <QSortFilterProxyModel>
#include <QVector>
namespace GammaRay {
template<typename BaseProxy>
void init(BaseProxy *)
{
}
template<>
inline void init<QSortFilterProxyModel>(QSortFilterProxyModel *proxy)
{
proxy->setRecursiveFilteringEnabled(true);
proxy->setAutoAcceptChildRows(true);
}
/** Sort/filter proxy model for server-side use to pass through extra roles in itemData().
* Every remoted proxy model should be wrapped into this template, unless you already have
* a special implementation for itemData() handling this.
*/
template<typename BaseProxy>
class ServerProxyModel : public BaseProxy
{
public:
explicit ServerProxyModel(QObject *parent = nullptr)
: BaseProxy(parent)
, m_sourceModel(nullptr)
, m_active(false)
{
init<BaseProxy>(this);
}
/** Additional roles used from the source model for transfer to the client. */
void addRole(int role)
{
m_extraRoles.push_back(role);
}
/** Additional roles used from the proxy model itself for transfer to the client.
* This is useful if BaseProxy overrides data().
*/
void addProxyRole(int role)
{
m_extraProxyRoles.push_back(role);
}
QMap<int, QVariant> itemData(const QModelIndex &index) const override
{
const QModelIndex sourceIndex = BaseProxy::mapToSource(index);
auto d = BaseProxy::sourceModel()->itemData(sourceIndex);
for (int role : m_extraRoles)
d.insert(role, sourceIndex.data(role));
for (int role : m_extraProxyRoles)
d.insert(role, index.data(role));
return d;
}
void setSourceModel(QAbstractItemModel *sourceModel) override
{
m_sourceModel = sourceModel;
if (m_active && sourceModel) {
Model::used(sourceModel);
BaseProxy::setSourceModel(sourceModel);
}
}
QModelIndex index(int row, int column,
const QModelIndex &parent = QModelIndex()) const override
{
if (!m_active)
Model::used(this);
return BaseProxy::index(row, column, parent);
}
protected:
void customEvent(QEvent *event) override
{
if (event->type() == ModelEvent::eventType()) {
auto mev = static_cast<ModelEvent *>(event);
m_active = mev->used();
if (m_sourceModel) {
QCoreApplication::sendEvent(m_sourceModel, event);
if (mev->used() && BaseProxy::sourceModel() != m_sourceModel)
BaseProxy::setSourceModel(m_sourceModel);
else if (!mev->used())
BaseProxy::setSourceModel(nullptr);
}
}
BaseProxy::customEvent(event);
}
private:
QVector<int> m_extraRoles;
QVector<int> m_extraProxyRoles;
QPointer<QAbstractItemModel> m_sourceModel;
bool m_active;
};
}
#endif // GAMMARAY_SERVERPROXYMODEL_H
|