KisResourceLoaderBase Class Reference

The KisResourceLoader class is an abstract interface class that must be implemented by actual resource classes and registered with the KisResourceLoaderRegistry. More...

#include <KisResourceLoader.h>

Inheritance diagram for KisResourceLoaderBase:

Public Member Functions
virtual KoResourceSP	create (const QString &name)=0
QStringList	filters () const
QString	id () const
	For registration in KisResourceLoaderRegistry.
	KisResourceLoaderBase (const QString &resourceSubType, const QString &resourceType, const QString &name, const QStringList &mimetypes)
KoResourceSP	load (const QString &name, QIODevice &dev, KisResourcesInterfaceSP resourcesInterface)
bool	load (KoResourceSP resource, QIODevice &dev, KisResourcesInterfaceSP resourcesInterface)
QStringList	mimetypes () const
QString	name () const
	The user-friendly name of the category.
QString	resourceSubType () const
QString	resourceType () const
virtual	~KisResourceLoaderBase ()

Private Attributes
QStringList	m_mimetypes
QString	m_name
QString	m_resourceSubType
QString	m_resourceType

Detailed Description

The KisResourceLoader class is an abstract interface class that must be implemented by actual resource classes and registered with the KisResourceLoaderRegistry.

Definition at line 26 of file KisResourceLoader.h.

Constructor & Destructor Documentation

KisResourceLoaderBase()

KisResourceLoaderBase::KisResourceLoaderBase ( const QString & resourceSubType, const QString & resourceType, const QString & name, const QStringList & mimetypes )

inline

Definition at line 30 of file KisResourceLoader.h.

    {
        m_resourceSubType = resourceSubType;
        m_resourceType = resourceType;
        m_mimetypes = mimetypes;
        m_name = name;
    }

~KisResourceLoaderBase()

virtual KisResourceLoaderBase::~KisResourceLoaderBase ( )

inlinevirtual

Definition at line 38 of file KisResourceLoader.h.

    {
    }

Member Function Documentation

create()

virtual KoResourceSP KisResourceLoaderBase::create ( const QString & name )

pure virtual

Implemented in KisResourceLoader< T >.

filters()

QStringList KisResourceLoaderBase::filters

(

)

const

Returns

a set of filters ("*.bla,*.foo") that is suitable for filtering the contents of a directory.

Definition at line 14 of file KisResourceLoader.cpp.

{
    QStringList filters;
    Q_FOREACH(const QString &mimeType, mimetypes()) {
        QStringList suffixes = KisMimeDatabase::suffixesForMimeType(mimeType);
        Q_FOREACH(const QString &suffix, suffixes) {
                filters << "*." + suffix;
        }
    }
 
    return filters;
}

References filters(), mimetypes(), and KisMimeDatabase::suffixesForMimeType().

id()

QString KisResourceLoaderBase::id ( ) const

inline

For registration in KisResourceLoaderRegistry.

Definition at line 71 of file KisResourceLoader.h.

    {
        return m_resourceSubType;
    }

load() [1/2]

KoResourceSP KisResourceLoaderBase::load ( const QString & name, QIODevice & dev, KisResourcesInterfaceSP resourcesInterface )

inline

Load this resource.

Returns

a resource if loading the resource succeeded, 0 otherwise

Definition at line 94 of file KisResourceLoader.h.

    {
        KoResourceSP resource = create(name);
        return load(resource, dev, resourcesInterface) ? resource : 0;
    }

load() [2/2]

bool KisResourceLoaderBase::load ( KoResourceSP resource, QIODevice & dev, KisResourcesInterfaceSP resourcesInterface )

inline

Definition at line 84 of file KisResourceLoader.h.

    {
        Q_ASSERT(dev.isOpen() && dev.isReadable());
        return resource->loadFromDevice(&dev, resourcesInterface);
    }

mimetypes()

QStringList KisResourceLoaderBase::mimetypes ( ) const

inline

Returns

the mimetypes this resource can load

Definition at line 51 of file KisResourceLoader.h.

    {
        return m_mimetypes;
    }

name()

QString KisResourceLoaderBase::name ( ) const

inline

The user-friendly name of the category.

Definition at line 77 of file KisResourceLoader.h.

    {
        return m_name;
    }

resourceSubType()

QString KisResourceLoaderBase::resourceSubType ( ) const

inline

Definition at line 65 of file KisResourceLoader.h.

    {
        return id();
    }

resourceType()

QString KisResourceLoaderBase::resourceType ( ) const

inline

Returns

the folder in the resource storage where resources of this type are located

Definition at line 60 of file KisResourceLoader.h.

    {
        return m_resourceType;
    }

Member Data Documentation

m_mimetypes

QStringList KisResourceLoaderBase::m_mimetypes

private

Definition at line 104 of file KisResourceLoader.h.

m_name

QString KisResourceLoaderBase::m_name

private

Definition at line 105 of file KisResourceLoader.h.

m_resourceSubType

QString KisResourceLoaderBase::m_resourceSubType

private

Definition at line 102 of file KisResourceLoader.h.

m_resourceType

QString KisResourceLoaderBase::m_resourceType

private

Definition at line 103 of file KisResourceLoader.h.

---

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

• libs/resources/KisResourceLoader.h
• libs/resources/KisResourceLoader.cpp