plasma-framework/declarativeimports/core/datamodel.h

226 lines
6.5 KiB
C
Raw Normal View History

/*
* Copyright 2010 by Marco MArtin <mart@kde.org>
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Library General Public License as
* published by the Free Software Foundation; either version 2, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details
*
* You should have received a copy of the GNU Library General Public
* License along with this program; if not, write to the
* Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef DATAMODEL_H
#define DATAMODEL_H
#include <QAbstractItemModel>
#include <QSortFilterProxyModel>
#include <QVector>
#include <Plasma/DataEngine>
class QTimer;
namespace Plasma
{
class DataSource;
class DataModel;
class SortFilterModel : public QSortFilterProxyModel
{
Q_OBJECT
2011-12-23 12:17:48 +01:00
/**
* The source model of this sorting proxy model. It has to inherit QAbstractItemModel (ListModel is not supported)
*/
Q_PROPERTY(QObject *sourceModel READ sourceModel WRITE setModel NOTIFY sourceModelChanged)
2011-12-23 12:17:48 +01:00
/**
* The regular expression for the filter, only items with their filterRole matching filterRegExp will be displayed
*/
Q_PROPERTY(QString filterRegExp READ filterRegExp WRITE setFilterRegExp NOTIFY filterRegExpChanged)
2011-12-23 12:17:48 +01:00
/**
* The role of the sourceModel on which filterRegExp must be applied.
*/
Q_PROPERTY(QString filterRole READ filterRole WRITE setFilterRole)
2011-12-23 12:17:48 +01:00
/**
* The role of the sourceModel that will be used for sorting. if empty the order will be left unaltered
*/
Q_PROPERTY(QString sortRole READ sortRole WRITE setSortRole)
2011-12-23 12:17:48 +01:00
/**
* One of Qt.Ascending or Qt.Descending
*/
Q_PROPERTY(Qt::SortOrder sortOrder READ sortOrder WRITE setSortOrder)
2011-12-23 12:17:48 +01:00
/**
* How many items are in this model
*/
Q_PROPERTY(int count READ count NOTIFY countChanged)
friend class DataModel;
public:
SortFilterModel(QObject* parent=0);
~SortFilterModel();
//FIXME: find a way to make QML understnd QAbstractItemModel
void setModel(QObject *source);
void setFilterRegExp(const QString &exp);
QString filterRegExp() const;
void setFilterRole(const QString &role);
QString filterRole() const;
void setSortRole(const QString &role);
QString sortRole() const;
void setSortOrder(const Qt::SortOrder order);
int count() const {return QSortFilterProxyModel::rowCount();}
2011-12-23 12:17:48 +01:00
/**
* Returns the item at index in the list model.
* This allows the item data to be accessed (but not modified) from JavaScript.
* It returns an Object with a property for each role.
*
* @arg int i the row we want
*/
Q_INVOKABLE QVariantHash get(int i) const;
Q_INVOKABLE int mapRowToSource(int i) const;
Q_INVOKABLE int mapRowFromSource(int i) const;
Q_SIGNALS:
void countChanged();
void sourceModelChanged(QObject *);
void filterRegExpChanged(const QString &);
protected:
int roleNameToId(const QString &name);
protected Q_SLOTS:
void syncRoleNames();
private:
QString m_filterRole;
QString m_sortRole;
QHash<QString, int> m_roleIds;
};
class DataModel : public QAbstractItemModel
{
Q_OBJECT
2011-12-23 12:17:48 +01:00
/**
* The instance of DataSource to construct this model on
*/
Q_PROPERTY(QObject *dataSource READ dataSource WRITE setDataSource)
2011-12-23 12:17:48 +01:00
/**
* It's a regular expression. Only data with keys that match this filter expression will be inserted in the model
*/
Q_PROPERTY(QString keyRoleFilter READ keyRoleFilter WRITE setKeyRoleFilter)
2011-12-23 12:17:48 +01:00
/**
* it's a regular expression. If the DataSource is connected to more than one source, only inserts data from sources matching this filter expression in the model.
* If we want to have a source watch all sources beginning with say "name:", the required regexp would be sourceFilter: "name:.*"
*/
Q_PROPERTY(QString sourceFilter READ sourceFilter WRITE setSourceFilter)
2011-12-23 12:17:48 +01:00
/**
* How many items are in this model
*/
Q_PROPERTY(int count READ count NOTIFY countChanged)
public:
DataModel(QObject* parent=0);
~DataModel();
void setDataSource(QObject *source);
QObject *dataSource() const;
/**
* Include only items with a key that matches this regexp in the model
*/
2011-04-03 15:29:54 +02:00
void setKeyRoleFilter(const QString& key);
QString keyRoleFilter() const;
/**
* Include only sources that matches this regexp in the model
*/
void setSourceFilter(const QString& key);
QString sourceFilter() const;
int roleNameToId(const QString &name);
//Reimplemented
QVariant data(const QModelIndex &index, int role) const;
QVariant headerData(int section, Qt::Orientation orientation,
int role = Qt::DisplayRole) const;
QModelIndex index(int row, int column,
const QModelIndex &parent = QModelIndex()) const;
QModelIndex parent(const QModelIndex &child) const;
int rowCount(const QModelIndex &parent = QModelIndex()) const;
int columnCount(const QModelIndex &parent = QModelIndex()) const;
int count() const {return countItems();}
2011-12-23 12:17:48 +01:00
/**
* Returns the item at index in the list model.
* This allows the item data to be accessed (but not modified) from JavaScript.
* It returns an Object with a property for each role.
*
* @arg int i the row we want
*/
Q_INVOKABLE QVariantHash get(int i) const;
protected:
void setItems(const QString &sourceName, const QVariantList &list);
inline int countItems() const;
Q_SIGNALS:
void countChanged();
void sourceModelChanged(QObject *);
void filterRegExpChanged(const QString &);
private Q_SLOTS:
void dataUpdated(const QString &sourceName, const Plasma::DataEngine::Data &data);
void removeSource(const QString &sourceName);
private:
DataSource *m_dataSource;
QString m_keyRoleFilter;
QRegExp m_keyRoleFilterRE;
QString m_sourceFilter;
QRegExp m_sourceFilterRE;
QMap<QString, QVector<QVariant> > m_items;
QHash<int, QByteArray> m_roleNames;
QHash<QString, int> m_roleIds;
int m_maxRoleId;
};
int DataModel::countItems() const
{
int count = 0;
foreach (const QVector<QVariant> &v, m_items) {
count += v.count();
}
return count;
}
}
#endif