Plasma5Support::DataModel

#include <datamodel.h>

Inheritance diagram for Plasma5Support::DataModel:

[legend]

Properties
int	count

QML_ELEMENTQObject *	dataSource

QString	keyRoleFilter

QString	sourceFilter

Properties inherited from QObject
	objectName

Signals
void	countChanged ()

void	filterRegExpChanged (const QString &)

void	sourceModelChanged (QObject *)

Public Member Functions
	DataModel (QObject *parent=nullptr)

int	columnCount (const QModelIndex &parent=QModelIndex()) const override

int	count () const

QVariant	data (const QModelIndex &index, int role) const override

QObject *	dataSource () const

Q_INVOKABLE QVariantMap	get (int i) const

QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override

QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const override

QString	keyRoleFilter () const

QModelIndex	parent (const QModelIndex &child) const override

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

void	setDataSource (QObject *source)

void	setKeyRoleFilter (const QString &key)

void	setSourceFilter (const QString &key)

QString	sourceFilter () const

Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent)

virtual QModelIndex	buddy (const QModelIndex &index) const const

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const

virtual bool	canFetchMore (const QModelIndex &parent) const const

bool	checkIndex (const QModelIndex &index, CheckIndexOptions options) const const

virtual bool	clearItemData (const QModelIndex &index)

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	columnsInserted (const QModelIndex &parent, int first, int last)

void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsRemoved (const QModelIndex &parent, int first, int last)

void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles)

virtual bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)

virtual void	fetchMore (const QModelIndex &parent)

virtual Qt::ItemFlags	flags (const QModelIndex &index) const const

virtual bool	hasChildren (const QModelIndex &parent) const const

bool	hasIndex (int row, int column, const QModelIndex &parent) const const

void	headerDataChanged (Qt::Orientation orientation, int first, int last)

bool	insertColumn (int column, const QModelIndex &parent)

virtual bool	insertColumns (int column, int count, const QModelIndex &parent)

bool	insertRow (int row, const QModelIndex &parent)

virtual bool	insertRows (int row, int count, const QModelIndex &parent)

virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const const

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const const

virtual QStringList	mimeTypes () const const

void	modelAboutToBeReset ()

void	modelReset ()

bool	moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)

bool	moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)

virtual void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const const

bool	removeColumn (int column, const QModelIndex &parent)

virtual bool	removeColumns (int column, int count, const QModelIndex &parent)

bool	removeRow (int row, const QModelIndex &parent)

virtual bool	removeRows (int row, int count, const QModelIndex &parent)

virtual void	revert ()

void	rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	rowsInserted (const QModelIndex &parent, int first, int last)

void	rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsRemoved (const QModelIndex &parent, int first, int last)

virtual bool	setData (const QModelIndex &index, const QVariant &value, int role)

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)

virtual QModelIndex	sibling (int row, int column, const QModelIndex &index) const const

virtual void	sort (int column, Qt::SortOrder order)

virtual QSize	span (const QModelIndex &index) const const

virtual bool	submit ()

virtual Qt::DropActions	supportedDragActions () const const

virtual Qt::DropActions	supportedDropActions () const const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Protected Member Functions
int	countItems () const

QHash< int, QByteArray >	roleNames () const override

void	setItems (const QString &sourceName, const QVariantList &list)

Protected Member Functions inherited from QAbstractItemModel
void	beginInsertColumns (const QModelIndex &parent, int first, int last)

void	beginInsertRows (const QModelIndex &parent, int first, int last)

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)

void	beginRemoveRows (const QModelIndex &parent, int first, int last)

void	beginResetModel ()

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndex	createIndex (int row, int column, const void *ptr) const const

QModelIndex	createIndex (int row, int column, quintptr id) const const

void	endInsertColumns ()

void	endInsertRows ()

void	endMoveColumns ()

void	endMoveRows ()

void	endRemoveColumns ()

void	endRemoveRows ()

void	endResetModel ()

QModelIndexList	persistentIndexList () const const

virtual void	resetInternalData ()

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from QAbstractItemModel
enum	CheckIndexOption

typedef	CheckIndexOptions

enum	LayoutChangeHint

Public Types inherited from QObject
typedef	QObjectList

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QAbstractItemModel
	DoNotUseParent

	HorizontalSortHint

	IndexIsValid

	NoLayoutChangeHint

	NoOption

	ParentIsInvalid

	VerticalSortHint

Detailed Description

DataSource data as a model.

Definition at line 159 of file datamodel.h.

Property Documentation

◆ count

int Plasma5Support::DataModel::count

read

How many items are in this model.

Definition at line 186 of file datamodel.h.

◆ dataSource

QML_ELEMENTQObject * Plasma5Support::DataModel::dataSource

readwrite

The instance of DataSource to construct this model on.

Definition at line 167 of file datamodel.h.

◆ keyRoleFilter

QString Plasma5Support::DataModel::keyRoleFilter

readwrite

It's a regular expression.

Only data with keys that match this filter expression will be inserted in the model

Definition at line 173 of file datamodel.h.

◆ sourceFilter

QString Plasma5Support::DataModel::sourceFilter

readwrite

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:.*"

Definition at line 181 of file datamodel.h.

Constructor & Destructor Documentation

◆ DataModel()

Plasma5Support::DataModel::DataModel ( QObject * parent = nullptr )

Definition at line 220 of file datamodel.cpp.

◆ ~DataModel()

Plasma5Support::DataModel::~DataModel ( )

override

Definition at line 236 of file datamodel.cpp.

Member Function Documentation

◆ columnCount()

int Plasma5Support::DataModel::columnCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 529 of file datamodel.cpp.

◆ count()

int Plasma5Support::DataModel::count ( ) const

inline

Definition at line 215 of file datamodel.h.

◆ countItems()

int Plasma5Support::DataModel::countItems ( ) const

inlineprotected

Definition at line 254 of file datamodel.h.

◆ data()

QVariant Plasma5Support::DataModel::data	(	const QModelIndex &	index,
		int	role ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 463 of file datamodel.cpp.

◆ dataSource()

QObject * Plasma5Support::DataModel::dataSource ( ) const

Definition at line 316 of file datamodel.cpp.

◆ get()

QVariantMap Plasma5Support::DataModel::get ( int i ) const

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.

Parameters

i	the row we want

Definition at line 538 of file datamodel.cpp.

◆ headerData()

QVariant Plasma5Support::DataModel::headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role = Qt::DisplayRole ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 493 of file datamodel.cpp.

◆ index()

QModelIndex Plasma5Support::DataModel::index	(	int	row,
		int	column,
		const QModelIndex &	parent = QModelIndex() ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 502 of file datamodel.cpp.

◆ keyRoleFilter()

QString Plasma5Support::DataModel::keyRoleFilter ( ) const

Definition at line 338 of file datamodel.cpp.

◆ parent()

QModelIndex Plasma5Support::DataModel::parent ( const QModelIndex & child ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 511 of file datamodel.cpp.

◆ roleNames()

QHash< int, QByteArray > Plasma5Support::DataModel::roleNames ( ) const

overrideprotectedvirtual

Reimplemented from QAbstractItemModel.

Definition at line 419 of file datamodel.cpp.

◆ rowCount()

int Plasma5Support::DataModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 518 of file datamodel.cpp.

◆ setDataSource()

void Plasma5Support::DataModel::setDataSource ( QObject * source )

Definition at line 289 of file datamodel.cpp.

◆ setItems()

void Plasma5Support::DataModel::setItems	(	const QString &	sourceName,
		const QVariantList &	list )

protected

Definition at line 365 of file datamodel.cpp.

◆ setKeyRoleFilter()

void Plasma5Support::DataModel::setKeyRoleFilter ( const QString & key )

Include only items with a key that matches this regexp in the model.

Definition at line 321 of file datamodel.cpp.

◆ setSourceFilter()

void Plasma5Support::DataModel::setSourceFilter ( const QString & key )

Include only sources that matches this regexp in the model.

Definition at line 343 of file datamodel.cpp.

◆ sourceFilter()

QString Plasma5Support::DataModel::sourceFilter ( ) const

Definition at line 360 of file datamodel.cpp.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Plasma5Support

Plasma5Support::DataModel

Properties

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Property Documentation

◆ count

◆ dataSource

◆ keyRoleFilter

◆ sourceFilter

Constructor & Destructor Documentation

◆ DataModel()

◆ ~DataModel()

Member Function Documentation

◆ columnCount()

◆ count()

◆ countItems()

◆ data()

◆ dataSource()

◆ get()

◆ headerData()

◆ index()

◆ keyRoleFilter()

◆ parent()

◆ roleNames()

◆ rowCount()

◆ setDataSource()

◆ setItems()

◆ setKeyRoleFilter()

◆ setSourceFilter()

◆ sourceFilter()