ItemsModel
#include <quickitemsmodel.h>

Public Types | |
enum | EntryType { CatalogEntry = 0, GroupEntry } |
enum | ItemStatus { InvalidStatus, DownloadableStatus, InstalledStatus, UpdateableStatus, DeletedStatus, InstallingStatus, UpdatingStatus } |
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, StatusRole, CommentsModelRole, EntryTypeRole } |
![]() | |
enum | CheckIndexOption |
enum | LayoutChangeHint |
Properties | |
QObject | engine |
bool | isLoadingData |
![]() | |
objectName | |
Public Member Functions | |
ItemsModel (QObject *parent=nullptr) | |
Q_INVOKABLE void | adoptItem (int index) |
bool | canFetchMore (const QModelIndex &parent) const override |
QVariant | data (const QModelIndex &index, int role=Qt::DisplayRole) const override |
QObject * | engine () const |
Q_SIGNAL void | engineChanged () |
Q_SIGNAL void | entryChanged (int index) |
void | fetchMore (const QModelIndex &parent) override |
Q_INVOKABLE int | indexOfEntryId (const QString &providerId, const QString &entryId) |
Q_INVOKABLE void | installItem (int index, int linkId) |
bool | isLoadingData () const |
Q_SIGNAL void | isLoadingDataChanged () |
QHash< int, QByteArray > | roleNames () const override |
int | rowCount (const QModelIndex &parent=QModelIndex()) const override |
void | setEngine (QObject *newEngine) |
Q_INVOKABLE void | uninstallItem (int index) |
Q_INVOKABLE void | updateItem (int index) |
![]() | |
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 |
![]() | |
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, QAbstractItemModel::CheckIndexOptions options) const const |
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 &parent, int start, int end, const QModelIndex &destination, int column) |
void | columnsRemoved (const QModelIndex &parent, int first, int last) |
void | dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector< 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 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 &parent, int start, int end, const QModelIndex &destination, int row) |
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) |
void | setSupportedDragActions (Qt::DropActions actions) |
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 |
![]() | |
QObject (QObject *parent) | |
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 () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
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 QRegExp ®Exp, 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 |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
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_DISABLE_COPY (Class) | |
Q_DISABLE_COPY_MOVE (Class) | |
Q_DISABLE_MOVE (Class) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
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 | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
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 | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds time, Qt::TimerType timerType) |
QThread * | thread () const const |
Additional Inherited Members | |
![]() | |
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) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
![]() | |
typedef | CheckIndexOptions |
DoNotUseParent | |
HorizontalSortHint | |
IndexIsValid | |
NoLayoutChangeHint | |
NoOption | |
ParentIsInvalid | |
VerticalSortHint | |
![]() | |
typedef | QObjectList |
![]() | |
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, quintptr id) const const |
QModelIndex | createIndex (int row, int column, void *ptr) const const |
void | endInsertColumns () |
void | endInsertRows () |
void | endMoveColumns () |
void | endMoveRows () |
void | endRemoveColumns () |
void | endRemoveRows () |
void | endResetModel () |
QModelIndexList | persistentIndexList () const const |
void | reset () |
void | resetInternalData () |
void | setRoleNames (const QHash< int, QByteArray > &roleNames) |
![]() | |
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::Engine 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
Definition at line 54 of file quickitemsmodel.h.
Member Enumeration Documentation
◆ EntryType
Represents whether the current entry is an actual catalog entry, or an entry that represents a set of entries.
- Since
- 5.83
Definition at line 120 of file quickitemsmodel.h.
◆ Roles
enum ItemsModel::Roles |
Definition at line 70 of file quickitemsmodel.h.
Property Documentation
◆ engine
|
readwrite |
The NewStuffQuickEngine to show items from.
Definition at line 60 of file quickitemsmodel.h.
◆ isLoadingData
|
read |
Whether or not the model is fetching information from a remote location.
- Since
- 5.65
Definition at line 65 of file quickitemsmodel.h.
Member Function Documentation
◆ adoptItem()
void ItemsModel::adoptItem | ( | int | index | ) |
Run the adoption command on an already installed item.
- Note
- This will simply fail quietly if the item is not installed
- Parameters
-
index The intex of the item to be adopted
Definition at line 450 of file quickitemsmodel.cpp.
◆ entryChanged()
Q_SIGNAL void ItemsModel::entryChanged | ( | int | index | ) |
Fired when an entry's data changes.
- Parameters
-
index The index of the item which has changed
◆ indexOfEntryId()
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
- Since
- 5.79
Definition at line 405 of file quickitemsmodel.cpp.
◆ installItem()
void ItemsModel::installItem | ( | int | index, |
int | linkId | ||
) |
This will install (or update, if already installed) the item at the given index.
There are no side effects of this function if it is called on an item which cannot be installed or updated (that is, if the status is not one such that these are possible, the function will simply return without performing any actions)
- Parameters
-
index The index of the item to install or update linkId The download item to install. If this is -1, it is assumed to be an update with an unknown payload, and a number of heuristics will be applied by the engine
- See also
- Engine::downloadLinkLoaded implementation for details
- LinkId
Definition at line 425 of file quickitemsmodel.cpp.
◆ isLoadingData()
bool ItemsModel::isLoadingData | ( | ) | const |
Whether or not the model is fetching information from a remote location.
- Since
- 5.65
◆ isLoadingDataChanged()
Q_SIGNAL void ItemsModel::isLoadingDataChanged | ( | ) |
Fired when the isLoadingData value changes.
- Since
- 5.65
◆ uninstallItem()
void ItemsModel::uninstallItem | ( | int | index | ) |
Uninstall an already installed item.
There are no side effects of this function if it is called on an item which cannot be uninstalled (that is, if the status is not one such that this is possible, the function will simply return without performing any actions)
- Parameters
-
index The index of the item to be uninstalled
Definition at line 440 of file quickitemsmodel.cpp.
◆ updateItem()
void ItemsModel::updateItem | ( | int | index | ) |
This will request an update of the given item.
There are no side effects of this function if it is called on an item which is not in an updateable state (that is, nothing will happen if this is called on an item which is not already installed, or on an installed item which does not have updates available).
- Parameters
-
index The index of the item you wish to update
- Since
- 5.69
Definition at line 435 of file quickitemsmodel.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon May 8 2023 04:11:06 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.