SvgSavingContext Class Reference

Context for saving svg files. More...

#include <SvgSavingContext.h>

Inheritance diagram for SvgSavingContext:

Public Member Functions
QString	createFileName (const QString &extension)
	Create a filename suitable for saving external data.
QString	createUID (const QString &base)
	Create a unique id from the specified base text.
QString	getID (const KoShape *obj)
	Returns the unique id for the given shape.
bool	isSavingInlineImages () const
	Returns if image should be saved inline.
	Private (QIODevice *_mainDevice, QIODevice *_styleDevice)
QString	saveImage (const QImage &image)
	Saves given image and returns the href used.
void	setStrippedTextMode (bool value)
KoXmlWriter &	shapeWriter ()
	Provides access to the shape writer.
bool	strippedTextMode () const
KoXmlWriter &	styleWriter ()
	Provides access to the style writer.
	SvgSavingContext (QIODevice &outputDevice, bool saveInlineImages=true)
	Creates a new svg saving context on the specified output device.
	SvgSavingContext (QIODevice &shapesDevice, QIODevice &styleDevice, bool saveInlineImages=true)
QTransform	userSpaceTransform () const
	Returns the transformation used to transform into user space.
	~Private ()
virtual	~SvgSavingContext ()
	Virtual destructor.

Public Attributes
QIODevice *	mainDevice
bool	saveInlineImages
QBuffer	shapeBuffer
QHash< const KoShape *, QString >	shapeIds
QScopedPointer< KoXmlWriter >	shapeWriter
bool	strippedTextMode = false
QBuffer	styleBuffer
QIODevice *	styleDevice
QScopedPointer< KoXmlWriter >	styleWriter
QHash< QString, int >	uniqueNames
QTransform	userSpaceMatrix

Private Attributes
Private *const	d
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

Context for saving svg files.

Definition at line 25 of file SvgSavingContext.cpp.

Constructor & Destructor Documentation

~Private()

SvgSavingContext::~Private ( )

inline

Definition at line 43 of file SvgSavingContext.cpp.

    {
    }

SvgSavingContext() [1/2]

SvgSavingContext::SvgSavingContext ( QIODevice & outputDevice, bool saveInlineImages = true )

explicit

Creates a new svg saving context on the specified output device.

Definition at line 61 of file SvgSavingContext.cpp.

    : d(new Private(&outputDevice, 0))
{
    d->saveInlineImages = saveInlineImages;
}

References d, and saveInlineImages.

SvgSavingContext() [2/2]

SvgSavingContext::SvgSavingContext ( QIODevice & shapesDevice, QIODevice & styleDevice, bool saveInlineImages = true )

explicit

Definition at line 67 of file SvgSavingContext.cpp.

    : d(new Private(&shapesDevice, &styleDevice))
{
    d->saveInlineImages = saveInlineImages;
}

References d, and saveInlineImages.

~SvgSavingContext()

SvgSavingContext::~SvgSavingContext ( )

virtual

Virtual destructor.

Definition at line 73 of file SvgSavingContext.cpp.

{
    d->styleWriter->endElement();
 
    if (d->styleDevice) {
        d->styleDevice->write(d->styleBuffer.data());
    } else {
        d->mainDevice->write(d->styleBuffer.data());
        d->mainDevice->write("\n");
    }
 
    d->mainDevice->write(d->shapeBuffer.data());
 
    delete d;
}

References d.

Member Function Documentation

createFileName()

QString SvgSavingContext::createFileName

(

const QString &

extension

)

Create a filename suitable for saving external data.

Definition at line 159 of file SvgSavingContext.cpp.

{
    QFile *file = qobject_cast<QFile*>(d->mainDevice);
    if (!file)
        return QString();
 
    QFileInfo fi(file->fileName());
    QString path = fi.absolutePath();
    QString dstBaseFilename = fi.completeBaseName();
 
    // create a filename for the image file at the destination directory
    QString fname = dstBaseFilename + '_' + createUID("file");
 
    // check if file exists already
    int i = 0;
    QString counter;
    // change filename as long as the filename already exists
    while (QFile(path + fname + counter + extension).exists()) {
        counter = QString("_%1").arg(++i);
    }
 
    return fname + counter + extension;
}

References createUID(), and d.

createUID()

QString SvgSavingContext::createUID

(

const QString &

base

)

Create a unique id from the specified base text.

Definition at line 99 of file SvgSavingContext.cpp.

{
    QString idBase = base.isEmpty() ? "defitem" : base;
    int counter = d->uniqueNames.value(idBase);
    QString res;
    do {
        res = idBase + QString::number(counter);
        counter++;
    } while (d->uniqueNames.contains(res));
 
    d->uniqueNames.insert(idBase, counter);
    d->uniqueNames.insert(res, 1);
    return res;
}

References d.

getID()

QString SvgSavingContext::getID

(

const KoShape *

obj

)

Returns the unique id for the given shape.

Definition at line 114 of file SvgSavingContext.cpp.

{
    QString id;
    // do we have already an id for this object ?
    if (d->shapeIds.contains(obj)) {
        // use existing id
        id = d->shapeIds[obj];
    } else {
        // initialize from object name
        id = obj->name();
        // if object name is not empty and was not used already
        // we can use it as is
        if (!id.isEmpty() && !d->uniqueNames.contains(id)) {
            // add to unique names so it does not get reused
            d->uniqueNames.insert(id, 1);
        } else {
            if (id.isEmpty()) {
                // differentiate a little between shape types
                if (dynamic_cast<const KoShapeGroup*>(obj))
                    id = "group";
                else if (dynamic_cast<const KoShapeLayer*>(obj))
                    id = "layer";
                else
                    id = "shape";
            }
            // create a completely new id based on object name
            // or a generic name
            id = createUID(id);
        }
        // record id for this shape
        d->shapeIds.insert(obj, id);
    }
    return id;
}

References createUID(), d, and KoShape::name().

isSavingInlineImages()

bool SvgSavingContext::isSavingInlineImages

(

)

const

Returns if image should be saved inline.

Definition at line 154 of file SvgSavingContext.cpp.

{
    return d->saveInlineImages;
}

References d.

Private()

SvgSavingContext::Private ( QIODevice * _mainDevice, QIODevice * _styleDevice )

inline

Definition at line 28 of file SvgSavingContext.cpp.

        : mainDevice(_mainDevice)
        , styleDevice(_styleDevice)
        , styleWriter(0)
        , shapeWriter(0)
        , saveInlineImages(true)
    {
        styleWriter.reset(new KoXmlWriter(&styleBuffer, 1));
        styleWriter->startElement("defs");
        shapeWriter.reset(new KoXmlWriter(&shapeBuffer, 1));
 
        const qreal scaleToUserSpace = SvgUtil::toUserSpace(1.0);
        userSpaceMatrix.scale(scaleToUserSpace, scaleToUserSpace);
    }

References SvgUtil::toUserSpace().

saveImage()

QString SvgSavingContext::saveImage

(

const QImage &

image

)

Saves given image and returns the href used.

Definition at line 183 of file SvgSavingContext.cpp.

{
    if (isSavingInlineImages()) {
        QBuffer buffer;
        buffer.open(QIODevice::WriteOnly);
        if (image.save(&buffer, "PNG")) {
            const QString header("data:image/x-png;base64,");
            return header + buffer.data().toBase64();
        }
    } else {
        // write to a temp file first
        QTemporaryFile imgFile;
        if (image.save(&imgFile, "PNG")) {
            QString dstFilename = createFileName(".png");
            if (QFile::copy(imgFile.fileName(), dstFilename)) {
                return dstFilename;
            }
            else {
                QFile f(imgFile.fileName());
                f.remove();
            }
        }
    }
 
    return QString();
}

References createFileName(), and isSavingInlineImages().

setStrippedTextMode()

void SvgSavingContext::setStrippedTextMode

(

bool

value

)

Definition at line 210 of file SvgSavingContext.cpp.

{
    d->strippedTextMode = value;
}

References d, and value().

shapeWriter()

KoXmlWriter & SvgSavingContext::shapeWriter

(

)

Provides access to the shape writer.

strippedTextMode()

bool SvgSavingContext::strippedTextMode

(

)

const

styleWriter()

KoXmlWriter & SvgSavingContext::styleWriter

(

)

Provides access to the style writer.

userSpaceTransform()

QTransform SvgSavingContext::userSpaceTransform

(

)

const

Returns the transformation used to transform into user space.

Definition at line 149 of file SvgSavingContext.cpp.

{
    return d->userSpaceMatrix;
}

References d.

Member Data Documentation

d

Private* const SvgSavingContext::d

private

Definition at line 64 of file SvgSavingContext.h.

mainDevice

QIODevice* SvgSavingContext::mainDevice

Definition at line 47 of file SvgSavingContext.cpp.

saveInlineImages

bool SvgSavingContext::saveInlineImages

Definition at line 57 of file SvgSavingContext.cpp.

shapeBuffer

QBuffer SvgSavingContext::shapeBuffer

Definition at line 50 of file SvgSavingContext.cpp.

shapeIds

QHash<const KoShape*, QString> SvgSavingContext::shapeIds

Definition at line 55 of file SvgSavingContext.cpp.

shapeWriter

KoXmlWriter & SvgSavingContext::shapeWriter

Definition at line 52 of file SvgSavingContext.cpp.

strippedTextMode

bool SvgSavingContext::strippedTextMode = false

Definition at line 58 of file SvgSavingContext.cpp.

styleBuffer

QBuffer SvgSavingContext::styleBuffer

Definition at line 49 of file SvgSavingContext.cpp.

styleDevice

QIODevice* SvgSavingContext::styleDevice

Definition at line 48 of file SvgSavingContext.cpp.

styleWriter

KoXmlWriter & SvgSavingContext::styleWriter

Definition at line 51 of file SvgSavingContext.cpp.

uniqueNames

QHash<QString, int> SvgSavingContext::uniqueNames

Definition at line 54 of file SvgSavingContext.cpp.

userSpaceMatrix

QTransform SvgSavingContext::userSpaceMatrix

Definition at line 56 of file SvgSavingContext.cpp.

---

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

• libs/flake/svg/SvgSavingContext.cpp
• libs/flake/svg/SvgSavingContext.h