KisStorageFilterProxyModel Class Reference

#include <KisStorageFilterProxyModel.h>

Inheritance diagram for KisStorageFilterProxyModel:

Classes
struct	Private

Public Types
enum	FilterType { ByFileName = 0 , ByStorageType , ByActive }

Public Member Functions
	KisStorageFilterProxyModel (QObject *parent=0)
void	setFilter (FilterType filterType, QVariant filter)
KisResourceStorageSP	storageForIndex (QModelIndex index=QModelIndex()) const
	~KisStorageFilterProxyModel () override

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 Slots
void	slotModelReset ()

Private Attributes
Private *const	d

Detailed Description

KisStorageFilterProxyModel provides a filtered view on the available storages. It can be used to find the storages that have resource with a particular file name, or storages of particular types.

Filtering by file name takes a string, filtering by storage type a list of untranslated strings (there is a method in KisResourceStorage for retrieving those strings from the ResourceType).

Definition at line 25 of file KisStorageFilterProxyModel.h.

Member Enumeration Documentation

FilterType

enum KisStorageFilterProxyModel::FilterType

Enumerator
ByFileName	Pass a string: all storages whose name contains the string will be returned.
ByStorageType	Pass a string list of storage types.
ByActive	Pass a boolean, false to filter out active bundles, true to filter out inactive bundles

Definition at line 32 of file KisStorageFilterProxyModel.h.

                    {
        ByFileName = 0, 
        ByStorageType,  
        ByActive        
    };

Constructor & Destructor Documentation

KisStorageFilterProxyModel()

KisStorageFilterProxyModel::KisStorageFilterProxyModel

(

QObject *

parent = 0

)

Definition at line 21 of file KisStorageFilterProxyModel.cpp.

    : QSortFilterProxyModel(parent)
    , d(new Private)
{
}

~KisStorageFilterProxyModel()

KisStorageFilterProxyModel::~KisStorageFilterProxyModel ( )

override

Definition at line 27 of file KisStorageFilterProxyModel.cpp.

{
    delete d;
}

References d.

Member Function Documentation

filterAcceptsColumn()

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

overrideprotected

Definition at line 48 of file KisStorageFilterProxyModel.cpp.

{
    return true;
}

filterAcceptsRow()

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

overrideprotected

Definition at line 53 of file KisStorageFilterProxyModel.cpp.

{
    if (d->filter.isNull()) return true;
 
    QModelIndex idx = sourceModel()->index(source_row, KisAbstractResourceModel::Name, source_parent);
 
    switch (d->filterType) {
    case ByFileName:
    {
        QString filename = d->filter.toString();
        return (sourceModel()->data(idx, Qt::UserRole + KisStorageModel::Location).toString().contains(filename));
    }
    case ByStorageType:
    {
        QString storageType = sourceModel()->data(idx, Qt::UserRole + KisStorageModel::StorageType).toString();
        return (d->filter.toStringList().contains(storageType));
    }
    case ByActive:
    {
        bool active = d->filter.toBool();
        bool isActive = sourceModel()->data(idx, Qt::UserRole + KisStorageModel::Active).toBool();
        return (active == isActive);
    }
    default:
        ;
    }
 
    return false;
}

References KisStorageModel::Active, ByActive, ByFileName, ByStorageType, d, KisStorageFilterProxyModel::Private::filter, KisStorageFilterProxyModel::Private::filterType, KisStorageModel::Location, KisAbstractResourceModel::Name, and KisStorageModel::StorageType.

lessThan()

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

overrideprotected

Definition at line 83 of file KisStorageFilterProxyModel.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 < nameRight;
}

References KisAbstractResourceModel::Name.

setFilter()

void KisStorageFilterProxyModel::setFilter	(	KisStorageFilterProxyModel::FilterType	filterType,
		QVariant	filter )

Definition at line 41 of file KisStorageFilterProxyModel.cpp.

{
    d->filter = filter;
    d->filterType = filterType;
}

References d, KisStorageFilterProxyModel::Private::filter, and KisStorageFilterProxyModel::Private::filterType.

slotModelReset

void KisStorageFilterProxyModel::slotModelReset ( )

privateslot

Definition at line 90 of file KisStorageFilterProxyModel.cpp.

{
    invalidateFilter();
}

storageForIndex()

KisResourceStorageSP KisStorageFilterProxyModel::storageForIndex

(

QModelIndex

index = QModelIndex()

)

const

Definition at line 32 of file KisStorageFilterProxyModel.cpp.

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

References source().

Member Data Documentation

d

Private* const KisStorageFilterProxyModel::d

private

Definition at line 56 of file KisStorageFilterProxyModel.h.

---

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

• libs/resources/KisStorageFilterProxyModel.h
• libs/resources/KisStorageFilterProxyModel.cpp