ItemsModel

#include <quickitemsmodel.h>

Inheritance diagram for ItemsModel:

[legend]

Public Types
enum	LinkId { AutoDetectLinkId = -1 , FirstLinkId = 1 }

enum	Roles { NameRole = Qt::UserRole + 1 , UniqueIdRole , CategoryRole , HomepageRole , AuthorRole , LicenseRole , ShortSummaryRole , SummaryRole , ChangelogRole , VersionRole , ReleaseDateRole , UpdateVersionRole , UpdateReleaseDateRole , PayloadRole , PreviewsSmallRole , PreviewsRole , InstalledFilesRole , UnInstalledFilesRole , RatingRole , NumberOfCommentsRole , DownloadCountRole , NumberFansRole , NumberKnowledgebaseEntriesRole , KnowledgebaseLinkRole , DownloadLinksRole , DonationLinkRole , ProviderIdRole , SourceRole , CommentsModelRole , EntryRole }

Public Types inherited from QAbstractItemModel
enum	CheckIndexOption

typedef	CheckIndexOptions

enum	LayoutChangeHint

Public Types inherited from QObject
typedef	QObjectList

Properties
Engine *	engine

Properties inherited from QObject
	objectName

Public Member Functions
	ItemsModel (QObject *parent=nullptr)

bool	canFetchMore (const QModelIndex &parent) const override

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override

Engine *	engine () const

Q_SIGNAL void	engineChanged ()

Q_SIGNAL void	entryChanged (const KNSCore::Entry &entry)

void	fetchMore (const QModelIndex &parent) override

Q_INVOKABLE int	indexOfEntry (const KNSCore::Entry &e)

Q_INVOKABLE int	indexOfEntryId (const QString &providerId, const QString &entryId)

QHash< int, QByteArray >	roleNames () const override

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

void	setEngine (Engine *newEngine)

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

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

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

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

virtual QModelIndex	sibling (int row, int column, const QModelIndex &idx) const const override

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

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

virtual bool	clearItemData (const QModelIndex &index)

virtual int	columnCount (const QModelIndex &parent) const const=0

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	hasChildren (const QModelIndex &parent) const const

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

virtual QVariant	headerData (int section, Qt::Orientation orientation, int role) 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

virtual QModelIndex	parent (const QModelIndex &index) const const=0

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 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

Additional Inherited Members
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

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)

Detailed Description

A model which shows the contents found in an Engine.

Use an instance of this model to show the content items represented by the configuration file passed to an engine. The following sample assumes you are using the Engine component, however it is also possible to pass a KNSCore::EngineBase instance created from C++ to this property, if you have specific requirements not covered by the convenience component.

Most data in the model is simple, but the DownloadLinks role will return a list of DownloadLinkInfo entries, which you will need to manage in some way.

You might also look at NewStuffList, NewStuffItem, and the other items, to see some more detail on what can be done with the data.

See also: NewStuffList; NewStuffItem; NewStuffPage; NewStuffEntryDetails; NewStuffEntryComments

import org.kde.newstuff as NewStuff
Item {
    NewStuff.ItemsModel {
        id: newStuffModel
        engine: newStuffEngine
    }
    NewStuff.Engine {
        id: newStuffEngine
        configFile: "/some/filesystem/location/wallpaper.knsrc"
        onBusyMessageChanged: () => console.log("KNS Message: " + newStuffEngine.busyMessage)
        onErrorCode: (code, message, metadata) => console.log("KNS Error: " + message)
    }
}

Definition at line 55 of file quickitemsmodel.h.

Member Enumeration Documentation

◆ LinkId

enum ItemsModel::LinkId

Definition at line 103 of file quickitemsmodel.h.

◆ Roles

enum ItemsModel::Roles

Enumerator
PreviewsRole	< this will return a list here, rather than be tied so tightly to the remote api
InstalledFilesRole	< this will return a list here, rather than be tied so tightly to the remote api

Definition at line 66 of file quickitemsmodel.h.

Property Documentation

◆ engine

Engine * ItemsModel::engine

readwrite

The NewStuffQuickEngine to show items from.

Definition at line 61 of file quickitemsmodel.h.

Constructor & Destructor Documentation

◆ ItemsModel()

ItemsModel::ItemsModel ( QObject * parent = nullptr )

explicit

Definition at line 91 of file quickitemsmodel.cpp.

Member Function Documentation

◆ canFetchMore()

bool ItemsModel::canFetchMore ( const QModelIndex & parent ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 282 of file quickitemsmodel.cpp.

◆ data()

QVariant ItemsModel::data	(	const QModelIndex &	index,
		int	role = Qt::DisplayRole ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 148 of file quickitemsmodel.cpp.

◆ engine()

Engine * ItemsModel::engine ( ) const

Definition at line 295 of file quickitemsmodel.cpp.

◆ entryChanged()

Q_SIGNAL void ItemsModel::entryChanged ( const KNSCore::Entry & entry )

Fired when an entry's data changes.

Parameters

entry The entry which has changed

◆ fetchMore()

void ItemsModel::fetchMore ( const QModelIndex & parent )

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 287 of file quickitemsmodel.cpp.

◆ indexOfEntry()

Q_INVOKABLE int ItemsModel::indexOfEntry ( const KNSCore::Entry & e )

inline

Definition at line 128 of file quickitemsmodel.h.

◆ indexOfEntryId()

int ItemsModel::indexOfEntryId	(	const QString &	providerId,
		const QString &	entryId )

Get the index of an entry based on that entry's unique ID.

Parameters

providerId	The provider inside of which you wish to search for an entry
entryId	The unique ID within the given provider of the entry you want to know the index of

Returns: The index of the entry. In case the entry is not found, -1 is returned

See also: KNSCore::Entry::uniqueId()

Since: 5.79

Definition at line 314 of file quickitemsmodel.cpp.

◆ roleNames()

QHash< int, QByteArray > ItemsModel::roleNames ( ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 99 of file quickitemsmodel.cpp.

◆ rowCount()

int ItemsModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 137 of file quickitemsmodel.cpp.

◆ setEngine()

void ItemsModel::setEngine ( Engine * newEngine )

Definition at line 300 of file quickitemsmodel.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KNewStuff

ItemsModel

Public Types

Properties

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ LinkId

◆ Roles

Property Documentation

◆ engine

Constructor & Destructor Documentation

◆ ItemsModel()

Member Function Documentation

◆ canFetchMore()

◆ data()

◆ engine()

◆ entryChanged()

◆ fetchMore()

◆ indexOfEntry()

◆ indexOfEntryId()

◆ roleNames()

◆ rowCount()

◆ setEngine()