KisTagFilterResourceProxyModel Class Reference

The KisTagFilterResourceProxyModel class filters the resources by tag or resource name. More...

#include <KisTagFilterResourceProxyModel.h>

Inheritance diagram for KisTagFilterResourceProxyModel:

Classes
struct	Private

Signals
void	afterFilterChanged ()
void	beforeFilterChanges ()

Public Member Functions
virtual bool	additionalResourceNameChecks (const QModelIndex &index, const KisResourceSearchBoxFilter *filter) const
	additionalResourceNameChecks Some resources, like fonts, have multiple names that need to be tested. Implementers should override this function if they want additional checks on the name.
bool	addResource (KoResourceSP resource, const QString &storageId=QString()) 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	addResourceDeduplicateFileName (KoResourceSP resource, const QString &storageId=QString()) override
	addResource adds the given resource to the database and storage. If the resource already exists in the given storage with the same filename, the resource will be renamed.
KisTagSP	currentTagFilter () const
	currentTagFilter
bool	exportResource (KoResourceSP resource, QIODevice *device) override
	exportResource exports a resource into a QIODevice
bool	filterInCurrentTag () const
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)
	KisTagFilterResourceProxyModel (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=QModelIndex()) const override
	resourceForIndex returns a properly versioned and id'ed resource object
void	setFilterInCurrentTag (bool filterInCurrentTag)
void	setMetaDataFilter (QMap< QString, QVariant > metaDataMap)
	setMetaDataFilter provides a set of metadata to filter on, for instance by paintop id category.
bool	setResourceActive (const QModelIndex &index, bool value) override
	setResourceActive changes 'active' state of the resource
void	setResourceFilter (const KoResourceSP resource)
	setResourceFilter sets the resource to filter with
void	setResourceFilter (ResourceFilter filter) override
bool	setResourceMetaData (KoResourceSP resource, QMap< QString, QVariant > metadata) override
	setResourceMetaData
void	setResourceModel (KisResourceModel *resourceModel)
void	setSearchText (const QString &searchText)
void	setStorageFilter (bool useFilter, int storageId)
void	setStorageFilter (StorageFilter filter) override
void	setTagFilter (const KisTagSP tag)
	setTagFilter sets the tag to filter with
bool	tagResources (const KisTagSP tag, const QVector< int > &resourceIds)
bool	untagResources (const KisTagSP tag, const QVector< int > &resourceIds)
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.
	~KisTagFilterResourceProxyModel () override
Public Member Functions inherited from KisAbstractResourceModel
bool	setResourceInactive (const QModelIndex &index)
virtual	~KisAbstractResourceModel ()
Public Member Functions inherited from KisAbstractResourceFilterInterface
virtual	~KisAbstractResourceFilterInterface ()

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

Private Member Functions
void	updateTagFilter ()

Private Attributes
Private *const	d

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

Detailed Description

The KisTagFilterResourceProxyModel class filters the resources by tag or resource name.

Definition at line 25 of file KisTagFilterResourceProxyModel.h.

Constructor & Destructor Documentation

KisTagFilterResourceProxyModel()

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

Definition at line 43 of file KisTagFilterResourceProxyModel.cpp.

    : QSortFilterProxyModel(parent)
    , d(new Private)
{
    d->resourceType = resourceType;
    d->resourceModel = new KisResourceModel(resourceType);
    d->tagResourceModel = new KisTagResourceModel(resourceType);
 
    setSourceModel(d->resourceModel);
}

References d, KisTagFilterResourceProxyModel::Private::resourceModel, KisTagFilterResourceProxyModel::Private::resourceType, and KisTagFilterResourceProxyModel::Private::tagResourceModel.

~KisTagFilterResourceProxyModel()

KisTagFilterResourceProxyModel::~KisTagFilterResourceProxyModel ( )

override

Definition at line 54 of file KisTagFilterResourceProxyModel.cpp.

{
    delete d->resourceModel;
    delete d->tagResourceModel;
    delete d;
}

References d, KisTagFilterResourceProxyModel::Private::resourceModel, and KisTagFilterResourceProxyModel::Private::tagResourceModel.

Member Function Documentation

additionalResourceNameChecks()

bool KisTagFilterResourceProxyModel::additionalResourceNameChecks ( const QModelIndex & index, const KisResourceSearchBoxFilter * filter ) const

virtual

additionalResourceNameChecks Some resources, like fonts, have multiple names that need to be tested. Implementers should override this function if they want additional checks on the name.

Parameters

resource	the resource index to test, this is provided by the model while testing each row.
filter,this	is the class that handles tokenisation, also provided by the model.

Returns

should return whether the current resource should be accepted by the given filter.

Reimplemented in FontFamilyTagFilterModel.

Definition at line 216 of file KisTagFilterResourceProxyModel.cpp.

{
    Q_UNUSED(index)
    Q_UNUSED(filter)
    return false;
}

addResource()

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

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 162 of file KisTagFilterResourceProxyModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->addResource(resource, storageId);
    }
    return false;
}

References source().

addResourceDeduplicateFileName()

bool KisTagFilterResourceProxyModel::addResourceDeduplicateFileName ( KoResourceSP resource, const QString & storageId = QString() )

overridevirtual

addResource adds the given resource to the database and storage. If the resource already exists in the given storage with the same filename, the resource will be renamed.

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 171 of file KisTagFilterResourceProxyModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->addResourceDeduplicateFileName(resource, storageId);
    }
    return false;
}

References source().

afterFilterChanged

void KisTagFilterResourceProxyModel::afterFilterChanged ( )

signal

beforeFilterChanges

void KisTagFilterResourceProxyModel::beforeFilterChanges ( )

signal

currentTagFilter()

KisTagSP KisTagFilterResourceProxyModel::currentTagFilter

(

)

const

currentTagFilter

Returns

return the current tag that's being used to filter.

Definition at line 237 of file KisTagFilterResourceProxyModel.cpp.

{
    return d->currentTagFilter;
}

References KisTagFilterResourceProxyModel::Private::currentTagFilter, and d.

exportResource()

bool KisTagFilterResourceProxyModel::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 152 of file KisTagFilterResourceProxyModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    bool res = false;
    if (source) {
        res = source->exportResource(resource, device);
    }
    return res;
}

References source().

filterAcceptsColumn()

bool KisTagFilterResourceProxyModel::filterAcceptsColumn ( int source_column, const QModelIndex & source_parent ) const

overrideprotected

Definition at line 351 of file KisTagFilterResourceProxyModel.cpp.

{
    return true;
}

filterAcceptsRow()

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

overrideprotected

Definition at line 356 of file KisTagFilterResourceProxyModel.cpp.

{
    // if both filters are empty, just accept everything
    if (d->filter->isEmpty() && d->metaDataMapFilter.isEmpty() && !d->useStorageIdFilter) {
        return true;
    }
 
    // If there's a tag set to filter on, we use the tagResourceModel, so that already filters for the tag
    // Here, we only have to filter by the search string.
    QModelIndex idx = sourceModel()->index(source_row, 0, source_parent);
 
    if (!idx.isValid()) {
        return false;
    }
 
    // checking the storage filter
    if (d->useStorageIdFilter) {
        int storageId = sourceModel()->data(idx, Qt::UserRole + KisAbstractResourceModel::StorageId).toInt();
        if (storageId != d->storageId) {
            return false;
        }
    }
 
    KisResourceMetaDataModel *metaDataModel = KisResourceModelProvider::resourceMetadataModel();
    const int resourceId = sourceModel()->data(idx, Qt::UserRole + KisAbstractResourceModel::Id).toInt();
    Q_FOREACH(const QString &key, d->metaDataMapFilter.keys()) {
        const QVariant value = metaDataModel->metaDataValue(resourceId, key);
        if (value.isValid() && value != d->metaDataMapFilter[key]) {
                return false;
        }
    }
 
    QString resourceName = sourceModel()->data(idx, Qt::UserRole + KisAbstractResourceModel::Name).toString();
    if (sourceModel()->data(idx, Qt::UserRole + KisAbstractResourceModel::ResourceType).toString() == ResourceType::PaintOpPresets) {
        resourceName = resourceName.replace("_", " ");
    }
    QStringList resourceTags = sourceModel()->data(idx, Qt::UserRole + KisAbstractResourceModel::Tags).toStringList();
    bool resourceNameMatches = d->filter->matchesResource(resourceName, resourceTags);
    if (!resourceNameMatches) {
        resourceNameMatches = additionalResourceNameChecks(idx, d->filter.data());
    }
 
 
    return resourceNameMatches;
}

References additionalResourceNameChecks(), d, KisTagFilterResourceProxyModel::Private::filter, KisAbstractResourceModel::Id, KisTagFilterResourceProxyModel::Private::metaDataMapFilter, KisResourceMetaDataModel::metaDataValue(), KisAbstractResourceModel::Name, ResourceType::PaintOpPresets, KisResourceModelProvider::resourceMetadataModel(), KisAbstractResourceModel::ResourceType, KisAbstractResourceModel::StorageId, KisTagFilterResourceProxyModel::Private::storageId, KisAbstractResourceModel::Tags, KisTagFilterResourceProxyModel::Private::useStorageIdFilter, and value().

filterInCurrentTag()

bool KisTagFilterResourceProxyModel::filterInCurrentTag

(

)

const

Definition at line 331 of file KisTagFilterResourceProxyModel.cpp.

{
    return d->filteringWithinCurrentTag;
}

References d, and KisTagFilterResourceProxyModel::Private::filteringWithinCurrentTag.

importResource()

KoResourceSP KisTagFilterResourceProxyModel::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 136 of file KisTagFilterResourceProxyModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    KoResourceSP res;
    if (source) {
        res = source->importResource(filename, device, allowOverwrite, storageId);
    }
    return res;
}

References source().

importResourceFile()

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

overridevirtual

importResourceFile

Parameters

filename

Returns

Implements KisAbstractResourceModel.

Definition at line 126 of file KisTagFilterResourceProxyModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    KoResourceSP res;
    if (source) {
        res = source->importResourceFile(filename, allowOverwrite, storageId);
    }
    return res;
}

References source().

importWillOverwriteResource()

bool KisTagFilterResourceProxyModel::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 146 of file KisTagFilterResourceProxyModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    return source && source->importWillOverwriteResource(fileName, storageLocation);
}

References source().

indexForResource()

QModelIndex KisTagFilterResourceProxyModel::indexForResource ( KoResourceSP resource ) const

overridevirtual

indexFromResource

Parameters

resource

Returns

Implements KisAbstractResourceModel.

Definition at line 93 of file KisTagFilterResourceProxyModel.cpp.

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

indexForResourceId()

QModelIndex KisTagFilterResourceProxyModel::indexForResourceId ( int resourceId ) const

overridevirtual

indexFromResource

Parameters

resourceId

resource id for which we want to get an index

Returns

Implements KisAbstractResourceModel.

Definition at line 107 of file KisTagFilterResourceProxyModel.cpp.

{
    if (resourceId < 0) return QModelIndex();
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return mapFromSource(source->indexForResourceId(resourceId));
    }
    return QModelIndex();
}

References source().

isResourceTagged()

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

Definition at line 346 of file KisTagFilterResourceProxyModel.cpp.

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

References d, KisTagResourceModel::isResourceTagged(), and KisTagFilterResourceProxyModel::Private::tagResourceModel.

lessThan()

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

overrideprotected

Definition at line 402 of file KisTagFilterResourceProxyModel.cpp.

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

References KisAbstractResourceModel::Name.

reloadResource()

bool KisTagFilterResourceProxyModel::reloadResource ( KoResourceSP resource )

overridevirtual

reloadResource

Parameters

resource

Returns

Implements KisAbstractResourceModel.

Definition at line 189 of file KisTagFilterResourceProxyModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->reloadResource(resource);
    }
    return false;
}

References source().

renameResource()

bool KisTagFilterResourceProxyModel::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 198 of file KisTagFilterResourceProxyModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->renameResource(resource, name);
    }
    return false;
}

References source().

resourceForIndex()

KoResourceSP KisTagFilterResourceProxyModel::resourceForIndex ( QModelIndex index = QModelIndex() ) const

overridevirtual

resourceForIndex returns a properly versioned and id'ed resource object

Implements KisAbstractResourceModel.

Definition at line 84 of file KisTagFilterResourceProxyModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->resourceForIndex(mapToSource(index));
    }
    return 0;
}

References source().

setFilterInCurrentTag()

void KisTagFilterResourceProxyModel::setFilterInCurrentTag

(

bool

filterInCurrentTag

)

Definition at line 325 of file KisTagFilterResourceProxyModel.cpp.

{
    d->filteringWithinCurrentTag = filterInCurrentTag;
    updateTagFilter();
}

References d, filterInCurrentTag(), KisTagFilterResourceProxyModel::Private::filteringWithinCurrentTag, and updateTagFilter().

setMetaDataFilter()

void KisTagFilterResourceProxyModel::setMetaDataFilter

(

QMap< QString, QVariant >

metaDataMap

)

setMetaDataFilter provides a set of metadata to filter on, for instance by paintop id category.

Parameters

metaDataMap

Definition at line 223 of file KisTagFilterResourceProxyModel.cpp.

{
    Q_EMIT beforeFilterChanges();
    d->metaDataMapFilter = metaDataMap;
    invalidateFilter();
    Q_EMIT afterFilterChanged();
}

References afterFilterChanged(), beforeFilterChanges(), d, and KisTagFilterResourceProxyModel::Private::metaDataMapFilter.

setResourceActive()

bool KisTagFilterResourceProxyModel::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 117 of file KisTagFilterResourceProxyModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->setResourceActive(mapToSource(index), value);
    }
    return false;
}

References source(), and value().

setResourceFilter() [1/2]

void KisTagFilterResourceProxyModel::setResourceFilter

(

const KoResourceSP

resource

)

setResourceFilter sets the resource to filter with

Parameters

resource

a valid resource with a valid id, or 0 to clear the filter

Definition at line 313 of file KisTagFilterResourceProxyModel.cpp.

{
    d->currentResourceFilter = resource;
    updateTagFilter();
}

References KisTagFilterResourceProxyModel::Private::currentResourceFilter, d, and updateTagFilter().

setResourceFilter() [2/2]

void KisTagFilterResourceProxyModel::setResourceFilter ( ResourceFilter filter )

overridevirtual

Select status of the resources that should be shown

Implements KisAbstractResourceFilterInterface.

Definition at line 61 of file KisTagFilterResourceProxyModel.cpp.

{
    Q_EMIT beforeFilterChanges();
    d->resourceModel->setResourceFilter(filter);
    d->tagResourceModel->setResourceFilter(filter);
    invalidateFilter();
    Q_EMIT afterFilterChanged();
}

References afterFilterChanged(), beforeFilterChanges(), d, KisTagFilterResourceProxyModel::Private::resourceModel, KisResourceModel::setResourceFilter(), KisTagResourceModel::setResourceFilter(), and KisTagFilterResourceProxyModel::Private::tagResourceModel.

setResourceMetaData()

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

overridevirtual

setResourceMetaData

Parameters

metadata

Returns

Implements KisAbstractResourceModel.

Definition at line 207 of file KisTagFilterResourceProxyModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->setResourceMetaData(resource, metadata);
    }
    return false;
}

References source().

setResourceModel()

void KisTagFilterResourceProxyModel::setResourceModel

(

KisResourceModel *

resourceModel

)

Definition at line 79 of file KisTagFilterResourceProxyModel.cpp.

{
    d->resourceModel = resourceModel;
}

References d, and KisTagFilterResourceProxyModel::Private::resourceModel.

setSearchText()

void KisTagFilterResourceProxyModel::setSearchText

(

const QString &

searchText

)

Definition at line 319 of file KisTagFilterResourceProxyModel.cpp.

{
    d->filter->setFilter(searchText);
    updateTagFilter();
}

References d, KisTagFilterResourceProxyModel::Private::filter, and updateTagFilter().

setStorageFilter() [1/2]

void KisTagFilterResourceProxyModel::setStorageFilter	(	bool	useFilter,
		int	storageId )

Definition at line 242 of file KisTagFilterResourceProxyModel.cpp.

{
    Q_EMIT beforeFilterChanges();
    d->useStorageIdFilter = useFilter;
    if (useFilter) {
        d->storageId = storageId;
    }
    invalidateFilter();
    Q_EMIT afterFilterChanged();
}

References afterFilterChanged(), beforeFilterChanges(), d, KisTagFilterResourceProxyModel::Private::storageId, and KisTagFilterResourceProxyModel::Private::useStorageIdFilter.

setStorageFilter() [2/2]

void KisTagFilterResourceProxyModel::setStorageFilter ( StorageFilter filter )

overridevirtual

Select status of the storages that should be shown

Implements KisAbstractResourceFilterInterface.

Definition at line 70 of file KisTagFilterResourceProxyModel.cpp.

{
    Q_EMIT beforeFilterChanges();
    d->resourceModel->setStorageFilter(filter);
    d->tagResourceModel->setStorageFilter(filter);
    invalidateFilter();
    Q_EMIT afterFilterChanged();
}

References afterFilterChanged(), beforeFilterChanges(), d, KisTagFilterResourceProxyModel::Private::resourceModel, KisResourceModel::setStorageFilter(), KisTagResourceModel::setStorageFilter(), and KisTagFilterResourceProxyModel::Private::tagResourceModel.

setTagFilter()

void KisTagFilterResourceProxyModel::setTagFilter

(

const KisTagSP

tag

)

setTagFilter sets the tag to filter with

Parameters

tag	a valid tag with a valid id, or 0 to clear the filter

Definition at line 231 of file KisTagFilterResourceProxyModel.cpp.

{
    d->currentTagFilter = tag;
    updateTagFilter();
}

References KisTagFilterResourceProxyModel::Private::currentTagFilter, d, and updateTagFilter().

tagResources()

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

Definition at line 336 of file KisTagFilterResourceProxyModel.cpp.

{
    return d->tagResourceModel->tagResources(tag, resourceIds);
}

References d, KisTagFilterResourceProxyModel::Private::tagResourceModel, and KisTagResourceModel::tagResources().

untagResources()

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

Definition at line 341 of file KisTagFilterResourceProxyModel.cpp.

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

References d, KisTagFilterResourceProxyModel::Private::tagResourceModel, and KisTagResourceModel::untagResources().

updateResource()

bool KisTagFilterResourceProxyModel::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 180 of file KisTagFilterResourceProxyModel.cpp.

{
    KisAbstractResourceModel *source = dynamic_cast<KisAbstractResourceModel*>(sourceModel());
    if (source) {
        return source->updateResource(resource);
    }
    return false;
}

References source().

updateTagFilter()

void KisTagFilterResourceProxyModel::updateTagFilter ( )

private

Definition at line 253 of file KisTagFilterResourceProxyModel.cpp.

{
    Q_EMIT beforeFilterChanges();
    const bool ignoreTagFiltering =
        !d->filteringWithinCurrentTag && !d->filter->isEmpty();
 
    QAbstractItemModel *desiredModel = 0;
 
    if (d->currentResourceFilter) {
        QVector<KisTagSP> filter;
 
        if (d->currentTagFilter &&
            !ignoreTagFiltering &&
            d->currentTagFilter->url() != KisAllTagsModel::urlAll() &&
            d->currentTagFilter->url() != KisAllTagsModel::urlAllUntagged()) {
 
            filter << d->currentTagFilter;
        } else {
            // combination with for untagged resources in not implemented
            // in KisTagResourceModel
            KIS_SAFE_ASSERT_RECOVER_NOOP(!d->currentTagFilter ||
                                         d->currentTagFilter->url() != KisAllTagsModel::urlAllUntagged());
        }
 
        d->tagResourceModel->setTagsFilter(filter);
        d->tagResourceModel->setResourcesFilter({d->currentResourceFilter});
        desiredModel = d->tagResourceModel;
 
    } else {
        d->tagResourceModel->setResourcesFilter(QVector<KoResourceSP>());
        if (ignoreTagFiltering ||
                !d->currentTagFilter ||
                d->currentTagFilter->url() == KisAllTagsModel::urlAll()) {
 
            d->tagResourceModel->setTagsFilter(QVector<KisTagSP>());
            desiredModel = d->resourceModel;
            d->resourceModel->showOnlyUntaggedResources(false);
        }
        else {
            if (d->currentTagFilter->url() == KisAllTagsModel::urlAllUntagged()) {
                desiredModel = d->resourceModel;
                d->resourceModel->showOnlyUntaggedResources(true);
            }
            else {
                desiredModel = d->tagResourceModel;
                d->tagResourceModel->setTagsFilter(QVector<KisTagSP>() << d->currentTagFilter);
            }
        }
    }
 
    // TODO: when model changes the current selection in the
    //       view disappears. We should try to keep it somehow.
    if (sourceModel() != desiredModel) {
        setSourceModel(desiredModel);
    }
 
    invalidateFilter();
    Q_EMIT afterFilterChanged();
}

References afterFilterChanged(), beforeFilterChanges(), KisTagFilterResourceProxyModel::Private::currentResourceFilter, KisTagFilterResourceProxyModel::Private::currentTagFilter, d, KisTagFilterResourceProxyModel::Private::filter, KisTagFilterResourceProxyModel::Private::filteringWithinCurrentTag, KIS_SAFE_ASSERT_RECOVER_NOOP, KisTagFilterResourceProxyModel::Private::resourceModel, KisTagResourceModel::setResourcesFilter(), KisTagResourceModel::setTagsFilter(), KisResourceModel::showOnlyUntaggedResources(), KisTagFilterResourceProxyModel::Private::tagResourceModel, KisAllTagsModel::urlAll(), and KisAllTagsModel::urlAllUntagged().

Member Data Documentation

d

Private* const KisTagFilterResourceProxyModel::d

private

Definition at line 124 of file KisTagFilterResourceProxyModel.h.

---

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

• libs/resources/KisTagFilterResourceProxyModel.h
• libs/resources/KisTagFilterResourceProxyModel.cpp