KisResourceLoaderRegistry Class Reference

The KisResourceLoaderRegistry class manages the loader plugins for resources. Every resource can be loaded by a KisResourceLoader instance. A loader corresponds to a particular file type. Resources are organized in folders that represent the main type of a certain resource (brushes) and subtypes, that identify a particular resource format (gbr, gih, png, svg). More...

#include <KisResourceLoaderRegistry.h>

Inheritance diagram for KisResourceLoaderRegistry:

Classes
struct	Private
struct	ResourceCacheFixup

Public Member Functions
QStringList	executeAllFixups ()
QStringList	filters (const QString &resourceType) const
KisResourceLoaderBase *	loader (const QString &resourceType, const QString &mimetype) const
QStringList	mimeTypes (const QString &resourceType) const
void	registerFixup (int priority, ResourceCacheFixup *fixup)
void	registerLoader (KisResourceLoaderBase *loader)
QVector< KisResourceLoaderBase * >	resourceTypeLoaders (const QString &resourceType) const
QStringList	resourceTypes () const
	~KisResourceLoaderRegistry () override
Public Member Functions inherited from KoGenericRegistry< KisResourceLoaderBase * >
void	add (const QString &id, KisResourceLoaderBase * item)
void	add (KisResourceLoaderBase * item)
void	addAlias (const QString &alias, const QString &id)
QHash< QString, KisResourceLoaderBase * >::const_iterator	constBegin () const
QHash< QString, KisResourceLoaderBase * >::const_iterator	constEnd () const
bool	contains (const QString &id) const
int	count () const
QList< KisResourceLoaderBase * >	doubleEntries () const
KisResourceLoaderBase *	get (const QString &id) const
QList< QString >	keys () const
	KoGenericRegistry ()
void	remove (const QString &id)
void	removeAlias (const QString &alias)
const KisResourceLoaderBase *	value (const QString &id) const
QList< KisResourceLoaderBase * >	values () const
virtual	~KoGenericRegistry ()

Static Public Member Functions
static KisResourceLoaderRegistry *	instance ()

Private Member Functions
	KisResourceLoaderRegistry (const KisResourceLoaderRegistry &)
	KisResourceLoaderRegistry (QObject *parent)
KisResourceLoaderRegistry	operator= (const KisResourceLoaderRegistry &)

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

The KisResourceLoaderRegistry class manages the loader plugins for resources. Every resource can be loaded by a KisResourceLoader instance. A loader corresponds to a particular file type. Resources are organized in folders that represent the main type of a certain resource (brushes) and subtypes, that identify a particular resource format (gbr, gih, png, svg).

KisResourceLoaderRegistry has full knowledge of all resource types that are defined for Krita.

Definition at line 26 of file KisResourceLoaderRegistry.h.

Constructor & Destructor Documentation

~KisResourceLoaderRegistry()

KisResourceLoaderRegistry::~KisResourceLoaderRegistry ( )

override

Definition at line 27 of file KisResourceLoaderRegistry.cpp.

{
    qDeleteAll(values());
    qDeleteAll(m_d->fixups);
}

References m_d, and KoGenericRegistry< KisResourceLoaderBase * >::values().

KisResourceLoaderRegistry() [1/2]

KisResourceLoaderRegistry::KisResourceLoaderRegistry ( QObject * parent )

private

Definition at line 21 of file KisResourceLoaderRegistry.cpp.

    : QObject(parent),
      m_d(new Private)
{
}

KisResourceLoaderRegistry() [2/2]

KisResourceLoaderRegistry::KisResourceLoaderRegistry ( const KisResourceLoaderRegistry & )

private

Member Function Documentation

executeAllFixups()

QStringList KisResourceLoaderRegistry::executeAllFixups

(

)

Definition at line 74 of file KisResourceLoaderRegistry.cpp.

{
    QStringList errorMessages;
 
    Q_FOREACH (ResourceCacheFixup *fixup, m_d->fixups) {
        errorMessages << fixup->executeFix();
    }
 
    return errorMessages;
}

References KisResourceLoaderRegistry::ResourceCacheFixup::executeFix(), and m_d.

filters()

QStringList KisResourceLoaderRegistry::filters

(

const QString &

resourceType

)

const

Returns

a list of filename extensions that can be present for the given resource type

Definition at line 85 of file KisResourceLoaderRegistry.cpp.

{
    QStringList r;
    Q_FOREACH(KisResourceLoaderBase *loader, resourceTypeLoaders(resourceType)) {
        r.append(loader->filters());
    }
    r.removeDuplicates();
    r.sort();
    return r;
}

References KisResourceLoaderBase::filters(), loader(), and resourceTypeLoaders().

instance()

KisResourceLoaderRegistry * KisResourceLoaderRegistry::instance ( )

static

Definition at line 33 of file KisResourceLoaderRegistry.cpp.

{
    KisResourceLoaderRegistry *reg = qApp->findChild<KisResourceLoaderRegistry *>(QString());
    if (!reg) {
        reg = new KisResourceLoaderRegistry(qApp);
    }
    return reg;
}

References KisResourceLoaderRegistry().

loader()

KisResourceLoaderBase * KisResourceLoaderRegistry::loader	(	const QString &	resourceType,
		const QString &	mimetype ) const

Returns

the first loader for the given resource type and mimetype

Definition at line 47 of file KisResourceLoaderRegistry.cpp.

{
    Q_FOREACH(KisResourceLoaderBase *loader, resourceTypeLoaders(resourceType)) {
 
        if (loader->mimetypes().contains(mimetype)) {
            return loader;
        }
    }
    return 0;
}

References loader(), KisResourceLoaderBase::mimetypes(), and resourceTypeLoaders().

mimeTypes()

QStringList KisResourceLoaderRegistry::mimeTypes

(

const QString &

resourceType

)

const

Returns

a list of mimetypes that can be loaded for the given resource type

Definition at line 96 of file KisResourceLoaderRegistry.cpp.

{
    QStringList extensions = KisResourceLoaderRegistry::instance()->filters(resourceType);
    QStringList mimeTypes;
    Q_FOREACH(const QString &extension, extensions) {
        mimeTypes << KisMimeDatabase::mimeTypeForSuffix(extension);
    }
    mimeTypes.removeDuplicates();
    mimeTypes.sort();
 
    return mimeTypes;
}

References filters(), instance(), KisMimeDatabase::mimeTypeForSuffix(), and mimeTypes().

operator=()

KisResourceLoaderRegistry KisResourceLoaderRegistry::operator= ( const KisResourceLoaderRegistry & )

private

registerFixup()

void KisResourceLoaderRegistry::registerFixup	(	int	priority,
		ResourceCacheFixup *	fixup )

Definition at line 69 of file KisResourceLoaderRegistry.cpp.

{
    m_d->fixups.insert(priority, fixup);
}

References m_d.

registerLoader()

void KisResourceLoaderRegistry::registerLoader

(

KisResourceLoaderBase *

loader

)

Adds the given loader and registers its type in the database, if it hasn't been registered yet.

Definition at line 42 of file KisResourceLoaderRegistry.cpp.

{
    add(loader);
}

References KoGenericRegistry< KisResourceLoaderBase * >::add(), and loader().

resourceTypeLoaders()

QVector< KisResourceLoaderBase * > KisResourceLoaderRegistry::resourceTypeLoaders

(

const QString &

resourceType

)

const

Returns

a list of loader plugins that can handle the resources stored in the folder. A folder can contain multiple subtypes.

Definition at line 58 of file KisResourceLoaderRegistry.cpp.

{
    QVector<KisResourceLoaderBase *> r;
    Q_FOREACH(KisResourceLoaderBase *loader, values()) {
        if (loader->resourceType() == resourceType) {
            r << loader;
        }
    }
    return r;
}

References loader(), KisResourceLoaderBase::resourceType(), and KoGenericRegistry< KisResourceLoaderBase * >::values().

resourceTypes()

QStringList KisResourceLoaderRegistry::resourceTypes

(

)

const

Returns

the list of folders for which resource loaders have been registered

Definition at line 111 of file KisResourceLoaderRegistry.cpp.

{
    QStringList r;
    Q_FOREACH(KisResourceLoaderBase *loader, values()) {
        r << loader->resourceType();
    }
    r.removeDuplicates();
    r.sort();
 
    return r;
}

References loader(), KisResourceLoaderBase::resourceType(), and KoGenericRegistry< KisResourceLoaderBase * >::values().

Member Data Documentation

m_d

QScopedPointer<Private> KisResourceLoaderRegistry::m_d

private

Definition at line 84 of file KisResourceLoaderRegistry.h.

---

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

• libs/resources/KisResourceLoaderRegistry.h
• libs/resources/KisResourceLoaderRegistry.cpp