#include <KisReferenceImageCollection.h>

Public Member Functions
	KisReferenceImageCollection ()=default

	KisReferenceImageCollection (const QVector< KisReferenceImage * > &references)

bool	load (QIODevice *io)

const QVector< KisReferenceImage * > &	referenceImages () const

bool	save (QIODevice *io)

Private Attributes
QVector< KisReferenceImage * >	references

Detailed Description

Definition at line 15 of file KisReferenceImageCollection.h.

Constructor & Destructor Documentation

◆ KisReferenceImageCollection() [1/2]

KisReferenceImageCollection::KisReferenceImageCollection ( )

explicitdefault

◆ KisReferenceImageCollection() [2/2]

KisReferenceImageCollection::KisReferenceImageCollection ( const QVector< KisReferenceImage * > & references )

explicit

Definition at line 17 of file KisReferenceImageCollection.cpp.

18 : references(references)

19{}

KisReferenceImageCollection::references

QVector< KisReferenceImage * > references

Definition KisReferenceImageCollection.h:27

Member Function Documentation

◆ load()

bool KisReferenceImageCollection::load ( QIODevice * io )

Definition at line 59 of file KisReferenceImageCollection.cpp.

{
    QScopedPointer<KoStore> store(KoStore::createStore(io, KoStore::Read, "application/x-krita-reference-images", KoStore::Zip));
    if (!store || store->bad()) {
        return false;
    }
 
    if (!store->hasFile(METADATA_FILE) || !store->open(METADATA_FILE)) {
        return false;
    }
 
    QByteArray xml = store->device()->readAll();
    store->close();
 
    QDomDocument doc;
    doc.setContent(xml);
    QDomElement root = doc.documentElement();
 
    QStringList failures;
 
    QDomElement element = root.firstChildElement("referenceimage");
    while (!element.isNull()) {
        KisReferenceImage *reference = KisReferenceImage::fromXml(element);
 
        if (reference->loadImage(store.data())) {
            references.append(reference);
        } else {
            failures << (reference->embed() ? reference->internalFile() : reference->filename());
            delete reference;
        }
        element = element.nextSiblingElement("referenceimage");
    }
 
    if (!failures.isEmpty()) {
        QMessageBox::warning(
                0,
                i18nc("@title:window", "Krita"),
                i18n("The following reference images could not be loaded:\n%1", failures.join('\n')),
                QMessageBox::Ok, QMessageBox::Ok
        );
 
    }
 
    return true;
}

References KoStore::createStore(), KisReferenceImage::embed(), KisReferenceImage::filename(), KisReferenceImage::fromXml(), KisReferenceImage::internalFile(), KisReferenceImage::loadImage(), METADATA_FILE, KoStore::Read, references, and KoStore::Zip.

◆ referenceImages()

const QVector< KisReferenceImage * > & KisReferenceImageCollection::referenceImages ( ) const

Definition at line 21 of file KisReferenceImageCollection.cpp.

{
    return references;
}

References references.

◆ save()

bool KisReferenceImageCollection::save ( QIODevice * io )

Definition at line 26 of file KisReferenceImageCollection.cpp.

{
    QScopedPointer<KoStore> store(KoStore::createStore(io, KoStore::Write, "application/x-krita-reference-images]", KoStore::Zip));
    if (store.isNull()) return false;
 
    QDomDocument doc;
    QDomElement root = doc.createElement("referenceimages");
    doc.insertBefore(root, QDomNode());
 
    std::sort(references.begin(), references.end(), KoShape::compareShapeZIndex);
 
    int nextId = 0;
    Q_FOREACH(KisReferenceImage *reference, references) {
        reference->saveXml(doc, root, nextId++);
 
        if (reference->embed()) {
            bool ok = reference->saveImage(store.data());
            if (!ok) return false;
        }
    }
 
    if (!store->open(METADATA_FILE)) {
        return false;
    }
 
    KoStoreDevice xmlDev(store.data());
    xmlDev.write(doc.toByteArray());
    xmlDev.close();
    store->close();
 
    return true;
}

References KoStoreDevice::close(), KoShape::compareShapeZIndex(), KoStore::createStore(), KisReferenceImage::embed(), METADATA_FILE, references, KisReferenceImage::saveImage(), KisReferenceImage::saveXml(), KoStore::Write, and KoStore::Zip.

Member Data Documentation

◆ references

QVector<KisReferenceImage*> KisReferenceImageCollection::references

private

Definition at line 27 of file KisReferenceImageCollection.h.

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

plugins/tools/defaulttool/referenceimagestool/KisReferenceImageCollection.h
plugins/tools/defaulttool/referenceimagestool/KisReferenceImageCollection.cpp

Public Member Functions

Private Attributes