KisTagResourceModel Class Reference

The KisTagResourceModel class makes it possible to retrieve the resources for certain tags or the tags for certain resources. If the filter for tags or resources is empty, all tags or resources that match for the active/inactive/all filters will match. More...

#include <KisTagResourceModel.h>

Inheritance diagram for KisTagResourceModel:

Classes
struct	Private

Public Types
enum	TagFilter { ShowInactiveTags = 0 , ShowActiveTags , ShowAllTags }
Public Types inherited from KisAbstractResourceModel
enum	Columns {   Id = 0 , StorageId , Name , Filename ,   Tooltip , Thumbnail , Status , Location ,   ResourceType , Tags , MD5 , LargeThumbnail ,   Dirty , MetaData , ResourceActive , StorageActive ,   BrokenStatus , BrokenStatusMessage }
	The Columns enum indexes the columns in the model. To get the thumbnail for a particular resource, create the index with QModelIndex(row, Thumbnail). More...
Public Types inherited from KisAbstractResourceFilterInterface
enum	ResourceFilter { ShowInactiveResources = 0 , ShowActiveResources , ShowAllResources }
enum	StorageFilter { ShowInactiveStorages = 0 , ShowActiveStorages , ShowAllStorages }

Public Member Functions
bool	addResource (KoResourceSP resource, const QString &storageId) override
	addResource adds the given resource to the database and storage. If the resource already exists in the given storage with md5, filename or name, the existing resource will be updated instead. If the existing resource was inactive, it will be active (undeleted).
bool	exportResource (KoResourceSP resource, QIODevice *device) override
	exportResource exports a resource into a QIODevice
QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override
KoResourceSP	importResource (const QString &filename, QIODevice *device, const bool allowOverwrite, const QString &storageId=QString()) override
	importResource imports a resource from a QIODevice
KoResourceSP	importResourceFile (const QString &filename, const bool allowOverwrite, const QString &storageId=QString()) override
	importResourceFile
bool	importWillOverwriteResource (const QString &fileName, const QString &storageLocation) const override
	importWillOverwriteResource checks is importing a resource with this filename will overwrite anything
QModelIndex	indexForResource (KoResourceSP resource) const override
	indexFromResource
QModelIndex	indexForResourceId (int resourceId) const override
	indexFromResource
int	isResourceTagged (const KisTagSP tag, const int resourceId) override
	isResourceTagged
	KisTagResourceModel (const QString &resourceType, QObject *parent=0)
bool	reloadResource (KoResourceSP resource) override
	reloadResource
bool	renameResource (KoResourceSP resource, const QString &name) override
	renameResource name the given resource. The resource will have its name field reset, will be saved to the storage and there will be a new version created in the database.
KoResourceSP	resourceForIndex (QModelIndex index) const override
	resourceForIndex returns a properly versioned and id'ed resource object
bool	setResourceActive (const QModelIndex &index, bool value) override
	setResourceActive changes 'active' state of the resource
void	setResourceFilter (ResourceFilter filter) override
bool	setResourceMetaData (KoResourceSP resource, QMap< QString, QVariant > metadata) override
	setResourceMetaData
void	setResourcesFilter (const QVector< int > resourceIds)
void	setResourcesFilter (const QVector< KoResourceSP > resources)
void	setStorageFilter (StorageFilter filter) override
void	setTagFilter (TagFilter filter)
void	setTagsFilter (const QVector< int > tagIds)
void	setTagsFilter (const QVector< KisTagSP > tags)
bool	tagResources (const KisTagSP tag, const QVector< int > &resourceIds) override
bool	untagResources (const KisTagSP tag, const QVector< int > &resourceIds) override
bool	updateResource (KoResourceSP resource) override
	updateResource creates a new version of the resource in the storage and in the database. This will also set the resource to active if it was inactive.
	~KisTagResourceModel () override
Public Member Functions inherited from KisAbstractTagResourceModel
virtual	~KisAbstractTagResourceModel ()
Public Member Functions inherited from KisAbstractResourceModel
bool	setResourceInactive (const QModelIndex &index)
virtual	~KisAbstractResourceModel ()
Public Member Functions inherited from KisAbstractResourceFilterInterface
virtual	~KisAbstractResourceFilterInterface ()

Protected Slots
void	storageChanged (const QString &location)

Protected Member Functions
bool	filterAcceptsRow (int source_row, const QModelIndex &source_parent) const override
bool	lessThan (const QModelIndex &source_left, const QModelIndex &source_right) const override

Private Attributes
Private *const	d

Detailed Description

The KisTagResourceModel class makes it possible to retrieve the resources for certain tags or the tags for certain resources. If the filter for tags or resources is empty, all tags or resources that match for the active/inactive/all filters will match.

Definition at line 104 of file KisTagResourceModel.h.

Member Enumeration Documentation

TagFilter

enum KisTagResourceModel::TagFilter

Enumerator
ShowInactiveTags
ShowActiveTags
ShowAllTags

Definition at line 118 of file KisTagResourceModel.h.

                   {
        ShowInactiveTags = 0,
        ShowActiveTags,
        ShowAllTags
    };

Constructor & Destructor Documentation

KisTagResourceModel()

KisTagResourceModel::KisTagResourceModel	(	const QString &	resourceType,
		QObject *	parent = 0 )

Definition at line 730 of file KisTagResourceModel.cpp.

    : QSortFilterProxyModel(parent)
    , d(new Private())
{
    d->resourceType = resourceType;
    d->sourceModel = KisResourceModelProvider::tagResourceModel(resourceType);
    setSourceModel(d->sourceModel);
 
    connect(KisResourceLocator::instance(), SIGNAL(storageAdded(const QString &)), this, SLOT(storageChanged(const QString &)));
    connect(KisResourceLocator::instance(), SIGNAL(storageRemoved(const QString &)), this, SLOT(storageChanged(const QString &)));
    connect(KisStorageModel::instance(), SIGNAL(storageEnabled(const QString &)), this, SLOT(storageChanged(const QString &)));
    connect(KisStorageModel::instance(), SIGNAL(storageDisabled(const QString &)), this, SLOT(storageChanged(const QString &)));
}

References connect(), d, KisResourceLocator::instance(), KisStorageModel::instance(), KisTagResourceModel::Private::resourceType, KisTagResourceModel::Private::sourceModel, storageChanged(), and KisResourceModelProvider::tagResourceModel().

~KisTagResourceModel()

KisTagResourceModel::~KisTagResourceModel ( )

override

Definition at line 744 of file KisTagResourceModel.cpp.

{
    delete d;
}

References d.

Member Function Documentation

addResource()

bool KisTagResourceModel::addResource ( KoResourceSP resource, const QString & storageId )

overridevirtual

addResource adds the given resource to the database and storage. If the resource already exists in the given storage with md5, filename or name, the existing resource will be updated instead. If the existing resource was inactive, it will be active (undeleted).

Parameters

resource	the resource itself
storageId	the id of the storage (could be "memory" for temporary resources, the document's storage id for document storages or empty to save to the default resources folder

Returns

true if adding the resource succeeded.

Implements KisAbstractResourceModel.

Definition at line 935 of file KisTagResourceModel.cpp.

{
    // Since we're importing the resource, there's no reason to add rows to the tags::resources table,
    // because the resource is untagged.
    KisResourceModel resourceModel(d->resourceType);
    return resourceModel.addResource(resource, storageId);
}

References KisResourceModel::addResource(), d, and KisTagResourceModel::Private::resourceType.

exportResource()

bool KisTagResourceModel::exportResource ( KoResourceSP resource, QIODevice * device )

overridevirtual

exportResource exports a resource into a QIODevice

Exporting a resource as a binary blob is the only way to guarantee that its MD5 checksum is kept persistent. The underlying storage will just copy bytes into the device without doing any conversions

Parameters

resource	the resource to be exported
device	device where the resource should be written to

Returns

true if export operation has been successful

Implements KisAbstractResourceModel.

Definition at line 929 of file KisTagResourceModel.cpp.

{
    KisResourceModel resourceModel(d->resourceType);
    return resourceModel.exportResource(resource, device);
}

References d, KisResourceModel::exportResource(), and KisTagResourceModel::Private::resourceType.

filterAcceptsRow()

bool KisTagResourceModel::filterAcceptsRow ( int source_row, const QModelIndex & source_parent ) const

overrideprotected

Definition at line 817 of file KisTagResourceModel.cpp.

{
    QModelIndex idx = sourceModel()->index(source_row, 0, source_parent);
    if (!idx.isValid()) return false;
 
    int tagId = idx.data(Qt::UserRole + KisAllTagResourceModel::TagId).toInt();
    int resourceId = idx.data(Qt::UserRole + KisAllTagResourceModel::ResourceId).toInt();
    bool tagActive = idx.data(Qt::UserRole + KisAllTagResourceModel::TagActive).toBool();
    bool resourceActive = idx.data(Qt::UserRole + KisAllTagResourceModel::ResourceActive).toBool();
    bool resourceStorageActive = idx.data(Qt::UserRole + KisAllTagResourceModel::ResourceStorageActive).toBool();
 
    if (d->tagFilter == ShowAllTags && d->resourceFilter == ShowAllResources && d->storageFilter == ShowAllStorages) {
        return ((d->tagIds.contains(tagId) || d->tagIds.isEmpty()) &&
                (d->resourceIds.contains(resourceId) || d->resourceIds.isEmpty()));
    }
 
    if ((d->tagFilter == ShowActiveTags && !tagActive)
            || (d->tagFilter == ShowInactiveTags && tagActive)) {
        return false;
    }
 
    if ((d->resourceFilter == ShowActiveResources && !resourceActive)
            || (d->resourceFilter == ShowInactiveResources && resourceActive)) {
        return false;
    }
 
    if ((d->storageFilter == ShowActiveStorages && !resourceStorageActive)
            || (d->storageFilter == ShowInactiveStorages && resourceStorageActive)) {
        return false;
    }
 
    return ((d->tagIds.contains(tagId) || d->tagIds.isEmpty())
            && (d->resourceIds.contains(resourceId) || d->resourceIds.isEmpty()));
}

References d, KisAllTagResourceModel::ResourceActive, KisTagResourceModel::Private::resourceFilter, KisAllTagResourceModel::ResourceId, KisTagResourceModel::Private::resourceIds, KisAllTagResourceModel::ResourceStorageActive, KisAbstractResourceFilterInterface::ShowActiveResources, KisAbstractResourceFilterInterface::ShowActiveStorages, ShowActiveTags, KisAbstractResourceFilterInterface::ShowAllResources, KisAbstractResourceFilterInterface::ShowAllStorages, ShowAllTags, KisAbstractResourceFilterInterface::ShowInactiveResources, KisAbstractResourceFilterInterface::ShowInactiveStorages, ShowInactiveTags, KisTagResourceModel::Private::storageFilter, KisAllTagResourceModel::TagActive, KisTagResourceModel::Private::tagFilter, KisAllTagResourceModel::TagId, and KisTagResourceModel::Private::tagIds.

headerData()

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

override

Definition at line 988 of file KisTagResourceModel.cpp.

{
    return d->sourceModel->headerData(section, orientation, role);
}

References d, KisAllTagResourceModel::headerData(), and KisTagResourceModel::Private::sourceModel.

importResource()

KoResourceSP KisTagResourceModel::importResource ( const QString & filename, QIODevice * device, const bool allowOverwrite, const QString & storageId = QString() )

overridevirtual

importResource imports a resource from a QIODevice

Importing a resource from a binary blob is the only way to guarantee that its MD5 checksum is kept persistent. The underlying storage will just copy bytes into its location.

Parameters

filename	file name of the resource if preset. File name may be used for addressing the resource, so it is usually preferred to preserve it.
device	device where the resource should be read from

Returns

the loaded resource object

Implements KisAbstractResourceModel.

Definition at line 915 of file KisTagResourceModel.cpp.

{
    // Since we're importing the resource, there's no reason to add rows to the tags::resources table,
    // because the resource is untagged.
    KisResourceModel resourceModel(d->resourceType);
    return resourceModel.importResource(filename, device, allowOverwrite, storageId);
}

References d, KisResourceModel::importResource(), and KisTagResourceModel::Private::resourceType.

importResourceFile()

KoResourceSP KisTagResourceModel::importResourceFile ( const QString & filename, const bool allowOverwrite, const QString & storageId = QString() )

overridevirtual

importResourceFile

Parameters

filename

Returns

Implements KisAbstractResourceModel.

Definition at line 907 of file KisTagResourceModel.cpp.

{
    // Since we're importing the resource, there's no reason to add rows to the tags::resources table,
    // because the resource is untagged.
    KisResourceModel resourceModel(d->resourceType);
    return resourceModel.importResourceFile(filename, allowOverwrite, storageId);
}

References d, KisResourceModel::importResourceFile(), and KisTagResourceModel::Private::resourceType.

importWillOverwriteResource()

bool KisTagResourceModel::importWillOverwriteResource ( const QString & fileName, const QString & storageLocation ) const

overridevirtual

importWillOverwriteResource checks is importing a resource with this filename will overwrite anything

If this function returns true, then importResource() is guaranteed to fail with 'allowOverwrite' set to false.

Parameters

filename

file name of the resource if preset. File name may be used for addressing the resource, so it is usually preferred to preserve it.

Returns

true if the some existing will be overwritten while importing

Implements KisAbstractResourceModel.

Definition at line 923 of file KisTagResourceModel.cpp.

{
    KisResourceModel resourceModel(d->resourceType);
    return resourceModel.importWillOverwriteResource(fileName, storageLocation);
}

References d, KisResourceModel::importWillOverwriteResource(), and KisTagResourceModel::Private::resourceType.

indexForResource()

QModelIndex KisTagResourceModel::indexForResource ( KoResourceSP resource ) const

overridevirtual

indexFromResource

Parameters

resource

Returns

Implements KisAbstractResourceModel.

Definition at line 873 of file KisTagResourceModel.cpp.

{
    if (!resource || !resource->valid() || resource->resourceId() < 0) return QModelIndex();
 
    for (int i = 0; i < rowCount(); ++i)  {
        QModelIndex idx = index(i, Qt::UserRole + KisAllTagResourceModel::ResourceId);
        Q_ASSERT(idx.isValid());
        if (idx.data(Qt::UserRole + KisAllTagResourceModel::ResourceId).toInt() == resource->resourceId()) {
            return idx;
        }
    }
    return QModelIndex();
}

References KisAllTagResourceModel::ResourceId.

indexForResourceId()

QModelIndex KisTagResourceModel::indexForResourceId ( int resourceId ) const

overridevirtual

indexFromResource

Parameters

resourceId

resource id for which we want to get an index

Returns

Implements KisAbstractResourceModel.

Definition at line 887 of file KisTagResourceModel.cpp.

{
    if (resourceId < 0) return QModelIndex();
    for (int i = 0; i < rowCount(); ++i)  {
        QModelIndex idx = index(i, Qt::UserRole + KisAllTagResourceModel::ResourceId);
        Q_ASSERT(idx.isValid());
        if (idx.data(Qt::UserRole + KisAllTagResourceModel::ResourceId).toInt() == resourceId) {
            return idx;
        }
    }
    return QModelIndex();
}

References KisAllTagResourceModel::ResourceId.

isResourceTagged()

int KisTagResourceModel::isResourceTagged ( const KisTagSP tag, const int resourceId )

overridevirtual

isResourceTagged

Parameters

tag	the tag to check
resourceId	the id of the resource to check

Returns

-1 if the resource was never tagged before, 0 if the resource was tagged, but then untagged, 1 if the resource is already tagged

Implements KisAbstractTagResourceModel.

Definition at line 778 of file KisTagResourceModel.cpp.

{
    return d->sourceModel->isResourceTagged(tag, resourceId);
}

References d, KisAllTagResourceModel::isResourceTagged(), and KisTagResourceModel::Private::sourceModel.

lessThan()

bool KisTagResourceModel::lessThan ( const QModelIndex & source_left, const QModelIndex & source_right ) const

overrideprotected

Definition at line 852 of file KisTagResourceModel.cpp.

{
    QString nameLeft = sourceModel()->data(source_left, Qt::UserRole + KisAllTagResourceModel::ResourceName).toString();
    QString nameRight = sourceModel()->data(source_right, Qt::UserRole + KisAllTagResourceModel::ResourceName).toString();
    return nameLeft.toLower() < nameRight.toLower();
}

References KisAllTagResourceModel::ResourceName.

reloadResource()

bool KisTagResourceModel::reloadResource ( KoResourceSP resource )

overridevirtual

reloadResource

Parameters

resource

Returns

Implements KisAbstractResourceModel.

Definition at line 956 of file KisTagResourceModel.cpp.

{
    KisResourceModel resourceModel(d->resourceType);
    bool r = resourceModel.reloadResource(resource);
    if (r) {
        QModelIndex index = indexForResource(resource);
        if (index.isValid()) {
            Q_EMIT dataChanged(index, index, {Qt::EditRole});
        }
    }
    return r;
}

References d, indexForResource(), KisResourceModel::reloadResource(), and KisTagResourceModel::Private::resourceType.

renameResource()

bool KisTagResourceModel::renameResource ( KoResourceSP resource, const QString & name )

overridevirtual

renameResource name the given resource. The resource will have its name field reset, will be saved to the storage and there will be a new version created in the database.

Parameters

resource	The resource to rename
name	The new name

Returns

true if the operation succeeded.

Implements KisAbstractResourceModel.

Definition at line 969 of file KisTagResourceModel.cpp.

{
    KisResourceModel resourceModel(d->resourceType);
    bool r = resourceModel.renameResource(resource, name);
    if (r) {
        QModelIndex index = indexForResource(resource);
        if (index.isValid()) {
            Q_EMIT dataChanged(index, index, {Qt::EditRole});
        }
    }
    return r;
}

References d, indexForResource(), KisResourceModel::renameResource(), and KisTagResourceModel::Private::resourceType.

resourceForIndex()

KoResourceSP KisTagResourceModel::resourceForIndex ( QModelIndex index ) const

overridevirtual

resourceForIndex returns a properly versioned and id'ed resource object

Implements KisAbstractResourceModel.

Definition at line 865 of file KisTagResourceModel.cpp.

{
    int id = data(index, Qt::UserRole + KisAllTagResourceModel::ResourceId).toInt();
    if (id < 1)  return nullptr;
    KoResourceSP res = KisResourceLocator::instance()->resourceForId(id);
    return res;
}

References KisResourceLocator::instance(), KisResourceLocator::resourceForId(), and KisAllTagResourceModel::ResourceId.

setResourceActive()

bool KisTagResourceModel::setResourceActive ( const QModelIndex & index, bool value )

overridevirtual

setResourceActive changes 'active' state of the resource

Parameters

index	the index of the resource
value	new 'active' state of the resource

Returns

true if the new state has been assigned successfully

Implements KisAbstractResourceModel.

Definition at line 900 of file KisTagResourceModel.cpp.

{
    KisResourceModel resourceModel(d->resourceType);
    QModelIndex idx = resourceModel.indexForResource(resourceForIndex(index));
    return resourceModel.setResourceActive(idx, value);
}

References d, KisResourceModel::indexForResource(), resourceForIndex(), KisTagResourceModel::Private::resourceType, KisResourceModel::setResourceActive(), and value().

setResourceFilter()

void KisTagResourceModel::setResourceFilter ( ResourceFilter filter )

overridevirtual

Select status of the resources that should be shown

Implements KisAbstractResourceFilterInterface.

Definition at line 755 of file KisTagResourceModel.cpp.

{
    d->resourceFilter = filter;
    invalidateFilter();
}

References d, and KisTagResourceModel::Private::resourceFilter.

setResourceMetaData()

bool KisTagResourceModel::setResourceMetaData ( KoResourceSP resource, QMap< QString, QVariant > metadata )

overridevirtual

setResourceMetaData

Parameters

metadata

Returns

Implements KisAbstractResourceModel.

Definition at line 982 of file KisTagResourceModel.cpp.

{
    KisResourceModel resourceModel(d->resourceType);
    return resourceModel.setResourceMetaData(resource, metadata);
}

References d, KisTagResourceModel::Private::resourceType, and KisResourceModel::setResourceMetaData().

setResourcesFilter() [1/2]

void KisTagResourceModel::setResourcesFilter

(

const QVector< int >

resourceIds

)

Definition at line 789 of file KisTagResourceModel.cpp.

{
    d->resourceIds = resourceIds;
    invalidateFilter();
}

References d, and KisTagResourceModel::Private::resourceIds.

setResourcesFilter() [2/2]

void KisTagResourceModel::setResourcesFilter

(

const QVector< KoResourceSP >

resources

)

Definition at line 806 of file KisTagResourceModel.cpp.

{
    d->resourceIds.clear();
    Q_FOREACH(const KoResourceSP resource, resources) {
        if (resource->valid() && resource->resourceId() > -1) {
            d->resourceIds << resource->resourceId();
        }
    }
    invalidateFilter();
}

References d, and KisTagResourceModel::Private::resourceIds.

setStorageFilter()

void KisTagResourceModel::setStorageFilter ( StorageFilter filter )

overridevirtual

Select status of the storages that should be shown

Implements KisAbstractResourceFilterInterface.

Definition at line 761 of file KisTagResourceModel.cpp.

{
    d->storageFilter = filter;
    invalidateFilter();
}

References d, and KisTagResourceModel::Private::storageFilter.

setTagFilter()

void KisTagResourceModel::setTagFilter

(

KisTagResourceModel::TagFilter

filter

)

Definition at line 749 of file KisTagResourceModel.cpp.

{
    d->tagFilter = filter;
    invalidateFilter();
}

References d, and KisTagResourceModel::Private::tagFilter.

setTagsFilter() [1/2]

void KisTagResourceModel::setTagsFilter

(

const QVector< int >

tagIds

)

Definition at line 783 of file KisTagResourceModel.cpp.

{
    d->tagIds = tagIds;
    invalidateFilter();
}

References d, and KisTagResourceModel::Private::tagIds.

setTagsFilter() [2/2]

void KisTagResourceModel::setTagsFilter

(

const QVector< KisTagSP >

tags

)

Definition at line 795 of file KisTagResourceModel.cpp.

{
    d->tagIds.clear();
    Q_FOREACH(const KisTagSP tag, tags) {
        if (tag && tag->valid() && tag->id() > -1) {
            d->tagIds << tag->id();
        }
    }
    invalidateFilter();
}

References d, and KisTagResourceModel::Private::tagIds.

storageChanged

void KisTagResourceModel::storageChanged ( const QString & location )

protectedslot

Definition at line 859 of file KisTagResourceModel.cpp.

{
    Q_UNUSED(location);
    invalidateFilter();
}

tagResources()

bool KisTagResourceModel::tagResources ( const KisTagSP tag, const QVector< int > & resourceIds )

overridevirtual

Implements KisAbstractTagResourceModel.

Definition at line 767 of file KisTagResourceModel.cpp.

{
    bool r = d->sourceModel->tagResources(tag, resourceIds);
    return r;
}

References d, KisTagResourceModel::Private::sourceModel, and KisAllTagResourceModel::tagResources().

untagResources()

bool KisTagResourceModel::untagResources ( const KisTagSP tag, const QVector< int > & resourceIds )

overridevirtual

Implements KisAbstractTagResourceModel.

Definition at line 773 of file KisTagResourceModel.cpp.

{
    return d->sourceModel->untagResources(tag, resourceIds);
}

References d, KisTagResourceModel::Private::sourceModel, and KisAllTagResourceModel::untagResources().

updateResource()

bool KisTagResourceModel::updateResource ( KoResourceSP resource )

overridevirtual

updateResource creates a new version of the resource in the storage and in the database. This will also set the resource to active if it was inactive.

Note: if the storage does not support versioning, updating the resource will fail.

Parameters

resource

Returns

true if the resource was successful updated,

Implements KisAbstractResourceModel.

Definition at line 943 of file KisTagResourceModel.cpp.

{
    KisResourceModel resourceModel(d->resourceType);
    bool r = resourceModel.updateResource(resource);
    if (r) {
        QModelIndex index = indexForResource(resource);
        if (index.isValid()) {
            Q_EMIT dataChanged(index, index, {Qt::EditRole});
        }
    }
    return r;
}

References d, indexForResource(), KisTagResourceModel::Private::resourceType, and KisResourceModel::updateResource().

Member Data Documentation

d

Private* const KisTagResourceModel::d

private

Definition at line 168 of file KisTagResourceModel.h.

---

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

• libs/resources/KisTagResourceModel.h
• libs/resources/KisTagResourceModel.cpp