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
|
/*
objectmodelbase.h
This file is part of GammaRay, the Qt application inspection and manipulation tool.
SPDX-FileCopyrightText: 2010 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.
*/
/**
@file
This file is part of the GammaRay Plugin API and declares a template for an ObjectModelBase class.
@brief
Declares a template for an ObjectModelBase class.
@author Volker Krause \<volker.krause@kdab.com\>
*/
#ifndef GAMMARAY_OBJECTMODELBASE_H
#define GAMMARAY_OBJECTMODELBASE_H
#include "util.h"
#include "objectdataprovider.h"
#include <common/objectid.h>
#include <common/objectmodel.h>
#include <common/sourcelocation.h>
#include <QCoreApplication>
#include <QModelIndex>
#include <QObject>
namespace GammaRay {
/*! A container for a generic Object Model derived from some Base. */
template<typename Base>
class ObjectModelBase : public Base
{
public:
/*!
* Constructor.
* @param parent is the parent object for this instance.
*/
explicit ObjectModelBase(QObject *parent)
: Base(parent)
{
}
/*!
* Returns the number of columns in the specified model (currently this is
* always 2).
* @param parent is the model QModelIndex.
* @return the column count for specified model.
*/
int columnCount(const QModelIndex &parent = QModelIndex()) const override
{
Q_UNUSED(parent);
return 2;
}
/*!
* Returns the data for the specified object.
* @param object is a pointer to a QObject.
* @param index is the model QModelIndex.
* @param role is the Qt role.
*
* @return on success, a QVariant containing the data for the specified QObject;
* QVariant() if some anamoly occurs.
*/
QVariant dataForObject(QObject *object, const QModelIndex &index, int role) const
{
if (role == Qt::DisplayRole) {
if (index.column() == 0)
return Util::shortDisplayString(object);
else if (index.column() == 1)
return ObjectDataProvider::typeName(object);
} else if (role == ObjectModel::ObjectRole) {
return QVariant::fromValue(object);
} else if (role == ObjectModel::ObjectIdRole) {
return QVariant::fromValue(ObjectId(object));
} else if (role == Qt::ToolTipRole) {
return Util::tooltipForObject(object);
} else if (role == ObjectModel::DecorationIdRole && index.column() == 0) {
const int id = Util::iconIdForObject(object);
return id >= 0 ? QVariant(id) : QVariant();
} else if (role == ObjectModel::CreationLocationRole) {
const auto loc = ObjectDataProvider::creationLocation(object);
if (loc.isValid())
return QVariant::fromValue(loc);
} else if (role == ObjectModel::DeclarationLocationRole) {
const auto loc = ObjectDataProvider::declarationLocation(object);
if (loc.isValid())
return QVariant::fromValue(loc);
}
return QVariant();
}
QMap<int, QVariant> itemData(const QModelIndex &index) const override
{
QMap<int, QVariant> map = Base::itemData(index);
map.insert(ObjectModel::ObjectIdRole, this->data(index, ObjectModel::ObjectIdRole));
map.insert(ObjectModel::DecorationIdRole, this->data(index, ObjectModel::DecorationIdRole));
map.insert(ObjectModel::IsFavoriteRole, this->data(index, ObjectModel::IsFavoriteRole));
return map;
}
/*!
* Returns the header data for the Object, given a section (column),
* orientation and role.
* @param section an integer (either 0 or 1) corresponding to the section (column).
* @param orientation is the Qt::Orientation.
* @param role is the Qt role.
*
* @return on success, a QVariant containing the header data;
* QVariant() if some anamoly occurs.
*
*/
QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override
{
if (role == Qt::DisplayRole && orientation == Qt::Horizontal) {
switch (section) {
case 0:
return qApp->translate("GammaRay::ObjectModelBase", "Object");
case 1:
return qApp->translate("GammaRay::ObjectModelBase", "Type");
}
}
return Base::headerData(section, orientation, role);
}
};
}
#endif
|