KoSvgSymbolCollectionResource Class Reference

#include <KoSvgSymbolCollectionResource.h>

Inheritance diagram for KoSvgSymbolCollectionResource:

Classes
struct	Private

Public Member Functions
KoResourceSP	clone () const override
QString	creator () const
QString	defaultFileExtension () const override
QString	description () const
	KoSvgSymbolCollectionResource ()
	Create an empty color set.
	KoSvgSymbolCollectionResource (const KoSvgSymbolCollectionResource &rhs)
	KoSvgSymbolCollectionResource (const QString &filename)
QString	language () const
QString	license () const
bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface) override
KoSvgSymbolCollectionResource &	operator= (const KoSvgSymbolCollectionResource &rhs)=delete
QStringList	permits () const
QPair< QString, QString >	resourceType () const override
QString	rights () const
bool	saveToDevice (QIODevice *dev) const override
QStringList	subjects () const
QVector< KoSvgSymbol * >	symbols () const
QString	title () const
	~KoSvgSymbolCollectionResource () override
Public Member Functions inherited from KoResource
bool	active () const
void	addMetaData (QString key, QVariant value)
	store the given key, value pair in the resource
virtual void	clearSideLoadedResources ()
virtual QList< KoResourceLoadResult >	embeddedResources (KisResourcesInterfaceSP globalResourcesInterface) const
QString	filename () const
QImage	image () const
bool	isDirty () const
virtual bool	isEphemeral () const
virtual bool	isSerializable () const
	KoResource ()
	KoResource (const KoResource &rhs)
	KoResource (const QString &filename)
virtual QList< KoResourceLoadResult >	linkedResources (KisResourcesInterfaceSP globalResourcesInterface) const
bool	load (KisResourcesInterfaceSP resourcesInterface)
QString	md5Sum (bool generateIfEmpty=true) const
QMap< QString, QVariant >	metadata () const
	get a map with all the metadata
virtual QString	name () const
KoResource &	operator= (const KoResource &rhs)=delete
bool	permanent () const
virtual QList< int >	requiredCanvasResources () const
QList< KoResourceLoadResult >	requiredResources (KisResourcesInterfaceSP globalResourcesInterface) const
int	resourceId () const
bool	save ()
void	setActive (bool active)
void	setDirty (bool value)
	Mark the preset as modified but not saved.
void	setFilename (const QString &filename)
void	setImage (const QImage &image)
void	setMD5Sum (const QString &md5sum)
	Set the md5sum of this resource. It must be in hex-encoded string format.
void	setName (const QString &name)
void	setPermanent (bool permanent)
void	setResourceId (int id)
void	setStorageLocation (const QString &location)
void	setValid (bool valid)
void	setVersion (int version)
virtual QList< KoResourceLoadResult >	sideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface) const
KoResourceSignature	signature () const
QString	storageLocation () const
QList< KoResourceLoadResult >	takeSideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface)
virtual QImage	thumbnail () const
	thumbnail the thumbnail image to use in resource selectors
virtual QString	thumbnailPath () const
	thumbnailPath returns the path to a separate thumbnail image, outside the actual resource file itself. If the path is relative, it is supposed start in the same location as the resource itself. If it's absolute, that is, it starts with "/", it is from the root of the storage.
virtual void	updateThumbnail ()
	updateThumbnail updates the thumbnail for this resource. Reimplement if your thumbnail is something else than the image set with setImage.
bool	valid () const
int	version () const
	Get the version of the resource.
virtual	~KoResource ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Private Attributes
const QScopedPointer< Private >	d

Additional Inherited Members
Public Attributes inherited from KoResource
bool	active {true}
QString	filename
QImage	image
QString	md5sum
QMap< QString, QVariant >	metadata
bool	modified {false}
QString	name
bool	permanent {false}
int	resourceId {-1}
QString	storageLocation
bool	valid {false}
int	version {-1}
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Detailed Description

Loads an svg file that contains "symbol" objects and creates a collection of those objects.

Definition at line 56 of file KoSvgSymbolCollectionResource.h.

Constructor & Destructor Documentation

KoSvgSymbolCollectionResource() [1/3]

KoSvgSymbolCollectionResource::KoSvgSymbolCollectionResource ( const QString & filename )

explicit

Definition at line 78 of file KoSvgSymbolCollectionResource.cpp.

    : KoResource(filename)
    , d(new Private())
{
}

KoSvgSymbolCollectionResource() [2/3]

KoSvgSymbolCollectionResource::KoSvgSymbolCollectionResource

(

)

Create an empty color set.

Definition at line 84 of file KoSvgSymbolCollectionResource.cpp.

    : KoResource(QString())
    , d(new Private())
{
}

~KoSvgSymbolCollectionResource()

KoSvgSymbolCollectionResource::~KoSvgSymbolCollectionResource ( )

override

Definition at line 108 of file KoSvgSymbolCollectionResource.cpp.

{
    qDeleteAll(d->symbols);
}

References d.

KoSvgSymbolCollectionResource() [3/3]

KoSvgSymbolCollectionResource::KoSvgSymbolCollectionResource

(

const KoSvgSymbolCollectionResource &

rhs

)

Definition at line 90 of file KoSvgSymbolCollectionResource.cpp.

    : KoResource(QString())
    , d(new Private(*rhs.d))
{
    setFilename(rhs.filename());
 
    Q_FOREACH(KoSvgSymbol *symbol, rhs.d->symbols) {
        d->symbols << new KoSvgSymbol(*symbol);
    }
 
    setValid(true);
}

References d, KoResource::filename, KoResource::setFilename(), and KoResource::setValid().

Member Function Documentation

clone()

KoResourceSP KoSvgSymbolCollectionResource::clone ( ) const

overridevirtual

Implements KoResource.

Definition at line 103 of file KoSvgSymbolCollectionResource.cpp.

{
    return KoResourceSP(new KoSvgSymbolCollectionResource(*this));
}

References KoSvgSymbolCollectionResource().

creator()

QString KoSvgSymbolCollectionResource::creator

(

)

const

Definition at line 194 of file KoSvgSymbolCollectionResource.cpp.

{
    return "";
}

defaultFileExtension()

QString KoSvgSymbolCollectionResource::defaultFileExtension ( ) const

overridevirtual

Returns

the default file extension which should be used when saving the resource

Reimplemented from KoResource.

Definition at line 179 of file KoSvgSymbolCollectionResource.cpp.

{
    return QString(".svg");
}

description()

QString KoSvgSymbolCollectionResource::description

(

)

const

Definition at line 189 of file KoSvgSymbolCollectionResource.cpp.

{
    return d->description;
}

References d.

language()

QString KoSvgSymbolCollectionResource::language

(

)

const

Definition at line 204 of file KoSvgSymbolCollectionResource.cpp.

{
    return "";
}

license()

QString KoSvgSymbolCollectionResource::license

(

)

const

Definition at line 214 of file KoSvgSymbolCollectionResource.cpp.

{
    return "";
}

loadFromDevice()

bool KoSvgSymbolCollectionResource::loadFromDevice ( QIODevice * dev, KisResourcesInterfaceSP resourcesInterface )

overridevirtual

Implements KoResource.

Definition at line 113 of file KoSvgSymbolCollectionResource.cpp.

{
    Q_UNUSED(resourcesInterface);
 
    if (!dev->isOpen()) {
        dev->open(QIODevice::ReadOnly);
    }
 
    d->data = dev->readAll();
    setMD5Sum(KoMD5Generator::generateHash(d->data));
 
    dev->seek(0);
 
    QString errorMsg;
    int errorLine = 0;
    int errorColumn;
 
    QDomDocument doc = SvgParser::createDocumentFromSvg(dev, &errorMsg, &errorLine, &errorColumn);
    if (doc.isNull()) {
 
        errKrita << "Parsing error in " << filename() << "! Aborting!" << Qt::endl
        << " In line: " << errorLine << ", column: " << errorColumn << Qt::endl
        << " Error message: " << errorMsg << Qt::endl;
        errKrita << i18n("Parsing error in the main document at line %1, column %2\nError message: %3"
                         , errorLine , errorColumn , errorMsg);
        return false;
    }
 
    KoDocumentResourceManager manager;
    SvgParser parser(&manager);
    parser.setResolution(QRectF(0,0,100,100), 72); // initialize with default values
    QSizeF fragmentSize;
    // We're not interested in the shapes themselves
    qDeleteAll(parser.parseSvg(doc.documentElement(), &fragmentSize));
    d->symbols = parser.takeSymbols();
//    debugFlake << "Loaded" << filename() << "\n\t"
//             << "Title" << parser.documentTitle() << "\n\t"
//             << "Description" << parser.documentDescription()
//             << "\n\tgot" << d->symbols.size() << ResourceType::Symbols
//             << d->symbols[0]->shape->outlineRect()
//             << d->symbols[0]->shape->size();
 
    d->title = parser.documentTitle();
    if (d->title.isEmpty()) {
        d->title = filename();
    }
    setName(d->title);
    d->description = parser.documentDescription();
 
    if (d->symbols.size() < 1) {
        setValid(false);
        return false;
    }
    setValid(true);
    setImage(d->symbols[0]->icon(256));
    return true;
}

References SvgParser::createDocumentFromSvg(), d, SvgParser::documentDescription(), SvgParser::documentTitle(), errKrita, KoResource::filename, KoMD5Generator::generateHash(), SvgParser::parseSvg(), KoResource::setImage(), KoResource::setMD5Sum(), KoResource::setName(), SvgParser::setResolution(), KoResource::setValid(), and SvgParser::takeSymbols().

operator=()

KoSvgSymbolCollectionResource & KoSvgSymbolCollectionResource::operator= ( const KoSvgSymbolCollectionResource & rhs )

delete

permits()

QStringList KoSvgSymbolCollectionResource::permits

(

)

const

Definition at line 219 of file KoSvgSymbolCollectionResource.cpp.

{
    return QStringList();
}

resourceType()

QPair< QString, QString > KoSvgSymbolCollectionResource::resourceType ( ) const

inlineoverridevirtual

Returns

the resource type

Implements KoResource.

Definition at line 77 of file KoSvgSymbolCollectionResource.h.

    {
        return QPair<QString, QString>(ResourceType::Symbols, "");
    }

References ResourceType::Symbols.

rights()

QString KoSvgSymbolCollectionResource::rights

(

)

const

Definition at line 199 of file KoSvgSymbolCollectionResource.cpp.

{
    return "";
}

saveToDevice()

bool KoSvgSymbolCollectionResource::saveToDevice ( QIODevice * dev ) const

overridevirtual

Reimplemented from KoResource.

Definition at line 171 of file KoSvgSymbolCollectionResource.cpp.

{
    dev->open(QIODevice::WriteOnly);
    dev->write(d->data);
    dev->close();
    return true;
}

References d.

subjects()

QStringList KoSvgSymbolCollectionResource::subjects

(

)

const

Definition at line 209 of file KoSvgSymbolCollectionResource.cpp.

{
    return QStringList();
}

symbols()

QVector< KoSvgSymbol * > KoSvgSymbolCollectionResource::symbols

(

)

const

Definition at line 224 of file KoSvgSymbolCollectionResource.cpp.

{
    return d->symbols;
}

References d.

title()

QString KoSvgSymbolCollectionResource::title

(

)

const

Definition at line 184 of file KoSvgSymbolCollectionResource.cpp.

{
    return d->title;
}

References d.

Member Data Documentation

d

const QScopedPointer<Private> KoSvgSymbolCollectionResource::d

private

Definition at line 97 of file KoSvgSymbolCollectionResource.h.

---

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

• libs/flake/resources/KoSvgSymbolCollectionResource.h
• libs/flake/resources/KoSvgSymbolCollectionResource.cpp