• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

Nepomuk

  • Nepomuk
  • Utils
  • ResourceModel
Public Types | Public Member Functions | List of all members
Nepomuk::Utils::ResourceModel Class Referenceabstract

#include <Nepomuk/Utils/ResourceModel>

Inheritance diagram for Nepomuk::Utils::ResourceModel:
Inheritance graph
[legend]

Public Types

enum  ResourceModelColumns { ResourceColumn = 0, ResourceTypeColumn = 1, ResourceModelColumnCount = 2 }
 
enum  ResourceRoles { ResourceRole = 7766897, ResourceTypeRole = 687585, ResourceCreationDateRole = 7766898 }
 

Public Member Functions

 ResourceModel (QObject *parent=0)
 
virtual ~ResourceModel ()
 
virtual int columnCount (const QModelIndex &parent) const
 
virtual QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const
 
virtual Qt::ItemFlags flags (const QModelIndex &index) const
 
virtual QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
 
virtual QModelIndex indexForResource (const Resource &res) const =0
 
virtual QMimeData * mimeData (const QModelIndexList &indexes) const
 
virtual QStringList mimeTypes () const
 
virtual QModelIndex parent (const QModelIndex &child) const
 
virtual Resource resourceForIndex (const QModelIndex &index) const =0
 
virtual bool setData (const QModelIndex &index, const QVariant &value, int role)
 
- Public Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QObject *parent)
 
virtual  ~QAbstractItemModel ()
 
virtual QModelIndex buddy (const QModelIndex &index) const
 
virtual bool canFetchMore (const QModelIndex &parent) const
 
virtual int columnCount (const QModelIndex &parent) const =0
 
void columnsAboutToBeInserted (const QModelIndex &parent, int start, int end)
 
void columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
 
void columnsAboutToBeRemoved (const QModelIndex &parent, int start, int end)
 
void columnsInserted (const QModelIndex &parent, int start, int end)
 
void columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
 
void columnsRemoved (const QModelIndex &parent, int start, int end)
 
virtual QVariant data (const QModelIndex &index, int role) const =0
 
void dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight)
 
virtual bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
 
virtual void fetchMore (const QModelIndex &parent)
 
virtual bool hasChildren (const QModelIndex &parent) const
 
bool hasIndex (int row, int column, const QModelIndex &parent) const
 
void headerDataChanged (Qt::Orientation orientation, int first, int last)
 
virtual QModelIndex index (int row, int column, const QModelIndex &parent) const =0
 
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
 
void layoutAboutToBeChanged ()
 
void layoutChanged ()
 
virtual QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits, QFlags< Qt::MatchFlag > flags) const
 
void modelAboutToBeReset ()
 
void modelReset ()
 
virtual QModelIndex parent (const QModelIndex &index) 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 ()
 
const QHash< int, QByteArray > & roleNames () const
 
virtual int rowCount (const QModelIndex &parent) const =0
 
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 start, int end)
 
void rowsInserted (const QModelIndex &parent, int start, int end)
 
void rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
 
void rowsRemoved (const QModelIndex &parent, int start, int end)
 
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 (QFlags< Qt::DropAction > actions)
 
QModelIndex sibling (int row, int column, const QModelIndex &index) const
 
virtual void sort (int column, Qt::SortOrder order)
 
virtual QSize span (const QModelIndex &index) const
 
virtual bool submit ()
 
Qt::DropActions supportedDragActions () const
 
virtual Qt::DropActions supportedDropActions () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
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)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- 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, void *ptr) const
 
QModelIndex createIndex (int row, int column, int id) const
 
QModelIndex createIndex (int row, int column, quint32 id) const
 
void endInsertColumns ()
 
void endInsertRows ()
 
void endMoveColumns ()
 
void endMoveRows ()
 
void endRemoveColumns ()
 
void endRemoveRows ()
 
void endResetModel ()
 
QModelIndexList persistentIndexList () const
 
void reset ()
 
void resetInternalData ()
 
void setRoleNames (const QHash< int, QByteArray > &roleNames)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Base class for all models providing a plain list of resources.

The ResourceModel is a base class for models that handle a set of Nepomuk Resource instances. This can be a simple list as in SimpleResourceModel or a set of query results as in ResultModel. It could also be a dynamic list which is updated while the user scrolls it.

ResourceModel cannot be instanciated by itself. Use one of the subclasses or derive your own subclass from it.

At least the following methods need to be implemented in a subclass:

  • resourceForIndex()
  • indexForResource(),
  • QAbstractItemModel::rowCount()
  • QAbstractItemModel::index()
Author
Sebastian Trueg trueg.nosp@m.@kde.nosp@m..org
Since
4.6

Definition at line 57 of file resourcemodel.h.

Member Enumeration Documentation

enum Nepomuk::Utils::ResourceModel::ResourceModelColumns

The columns supported by ResourceModel are identified by this enumeration.

Enumerator
ResourceColumn 

The first column displays the label of the resource and its icon.

ResourceTypeColumn 

The second column displays the resource's type.

ResourceModelColumnCount 

The number of columns.

Definition at line 76 of file resourcemodel.h.

enum Nepomuk::Utils::ResourceModel::ResourceRoles

Custom roles that can be accessed for example in delegates.

Enumerator
ResourceRole 

The resource itself, provided as a Nepomuk::Resource instance.

ResourceTypeRole 

The type of the resource, provided as a Nepomuk::Types::Class instance.

ResourceCreationDateRole 

The creation date of the resource.

Definition at line 90 of file resourcemodel.h.

Constructor & Destructor Documentation

Nepomuk::Utils::ResourceModel::ResourceModel ( QObject *  parent = 0)

Constructor.

virtual Nepomuk::Utils::ResourceModel::~ResourceModel ( )
virtual

Destructor.

Member Function Documentation

virtual int Nepomuk::Utils::ResourceModel::columnCount ( const QModelIndex &  parent) const
virtual

The default implementation returns 2 with the first column representing the resource itself and the second one showing the type.

virtual QVariant Nepomuk::Utils::ResourceModel::data ( const QModelIndex &  index,
int  role = Qt::DisplayRole 
) const
virtual

Handles most roles typically used in applications like Qt::DisplayRole, Qt::ToolTipRole, and Qt::DecorationRole.

Additionally KCategorizedSortFilterProxyModel roles are supported categorizing by resource types.

virtual Qt::ItemFlags Nepomuk::Utils::ResourceModel::flags ( const QModelIndex &  index) const
virtual

Reimplemented to support dragging of resources out of the model.

Reimplemented from QAbstractItemModel.

virtual QVariant Nepomuk::Utils::ResourceModel::headerData ( int  section,
Qt::Orientation  orientation,
int  role = Qt::DisplayRole 
) const
virtual

Provides header data for the supported columns.

Reimplemented from QAbstractItemModel.

virtual QModelIndex Nepomuk::Utils::ResourceModel::indexForResource ( const Resource &  res) const
pure virtual

Get the index for a resource.

Returns
The index which corresponds to res of an invalid QModelIndex if res is not part of this model.

Implemented in Nepomuk::Utils::SimpleResourceModel.

virtual QMimeData* Nepomuk::Utils::ResourceModel::mimeData ( const QModelIndexList &  indexes) const
virtual

Stores the resource URIs via KUrl::List::populateMimeData() and as a specific "application/x-nepomuk-resource-uri" mime type to indicate that these are URIs corresponding to actual Nepomuk resources.

Reimplemented from QAbstractItemModel.

virtual QStringList Nepomuk::Utils::ResourceModel::mimeTypes ( ) const
virtual
Returns
The KUrl mime types and "application/x-nepomuk-resource-uri".

Reimplemented from QAbstractItemModel.

virtual QModelIndex Nepomuk::Utils::ResourceModel::parent ( const QModelIndex &  child) const
virtual

The default implementation returns an invalid QModelIndex, thus providing a plain list.

virtual Resource Nepomuk::Utils::ResourceModel::resourceForIndex ( const QModelIndex &  index) const
pure virtual

Get the Resource which corresponds to index.

Returns
The Resource which corresponds to index or an invalid Resource if index is invalid.

Implemented in Nepomuk::Utils::SimpleResourceModel.

virtual bool Nepomuk::Utils::ResourceModel::setData ( const QModelIndex &  index,
const QVariant &  value,
int  role 
)
virtual

Provided for future extensions.

Reimplemented from QAbstractItemModel.


The documentation for this class was generated from the following file:
  • resourcemodel.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:23:05 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Nepomuk

Skip menu "Nepomuk"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal