SvgWriter Class Reference

Implements exporting shapes to SVG. More...

#include <SvgWriter.h>

Public Member Functions
bool	save (const QString &filename, const QSizeF &pageSize, bool writeInlineImages)
	Writes svg to the specified file.
bool	save (QIODevice &outputDevice, const QSizeF &pageSize)
	Writes svg to specified output device.
bool	saveDetached (QIODevice &outputDevice)
bool	saveDetached (SvgSavingContext &savingContext)
void	setDocumentDescription (QString description)
void	setDocumentTitle (QString title)
	SvgWriter (const QList< KoShape * > &toplevelShapes)
	Creates svg writer to export specified shapes.
	SvgWriter (const QList< KoShapeLayer * > &layers)
	Creates svg writer to export specified layers.
virtual	~SvgWriter ()
	Destroys the svg writer.

Private Member Functions
void	saveGeneric (KoShape *shape, SvgSavingContext &context)
void	saveGroup (KoShapeGroup *group, SvgSavingContext &context)
void	saveLayer (KoShapeLayer *layer, SvgSavingContext &context)
void	savePath (KoPathShape *path, SvgSavingContext &context)
void	saveShape (KoShape *shape, SvgSavingContext &context)
void	saveShapes (const QList< KoShape * > shapes, SvgSavingContext &savingContext)

Private Attributes
QString	m_documentDescription
QString	m_documentTitle
QList< KoShape * >	m_toplevelShapes
bool	m_writeInlineImages

Detailed Description

Implements exporting shapes to SVG.

Definition at line 32 of file SvgWriter.h.

Constructor & Destructor Documentation

SvgWriter() [1/2]

SvgWriter::SvgWriter

(

const QList< KoShapeLayer * > &

layers

)

Creates svg writer to export specified layers.

Definition at line 47 of file SvgWriter.cpp.

    : m_writeInlineImages(true)
{
    Q_FOREACH (KoShapeLayer *layer, layers)
        m_toplevelShapes.append(layer);
}

References m_toplevelShapes.

SvgWriter() [2/2]

SvgWriter::SvgWriter

(

const QList< KoShape * > &

toplevelShapes

)

Creates svg writer to export specified shapes.

Definition at line 54 of file SvgWriter.cpp.

    : m_toplevelShapes(toplevelShapes)
    , m_writeInlineImages(true)
{
}

~SvgWriter()

SvgWriter::~SvgWriter ( )

virtual

Destroys the svg writer.

Definition at line 60 of file SvgWriter.cpp.

{
 
}

Member Function Documentation

save() [1/2]

bool SvgWriter::save	(	const QString &	filename,
		const QSizeF &	pageSize,
		bool	writeInlineImages )

Writes svg to the specified file.

Definition at line 65 of file SvgWriter.cpp.

{
    QFile fileOut(filename);
    if (!fileOut.open(QIODevice::WriteOnly))
        return false;
 
    m_writeInlineImages = writeInlineImages;
 
    const bool success = save(fileOut, pageSize);
 
    m_writeInlineImages = true;
 
    fileOut.close();
 
    return success;
}

References m_writeInlineImages, and save().

save() [2/2]

bool SvgWriter::save	(	QIODevice &	outputDevice,
		const QSizeF &	pageSize )

Writes svg to specified output device.

Definition at line 82 of file SvgWriter.cpp.

{
    if (m_toplevelShapes.isEmpty()) {
        return false;
    }
 
    QTextStream svgStream(&outputDevice);
    KisPortingUtils::setUtf8OnStream(svgStream);
 
    // standard header:
    svgStream << "<?xml version=\"1.0\" standalone=\"no\"?>" << Qt::endl;
    svgStream << "<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 20010904//EN\" ";
    svgStream << "\"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd\">" << Qt::endl;
 
    // add some PR.  one line is more than enough.
    svgStream << "<!-- Created using Krita: https://krita.org -->" << Qt::endl;
 
    svgStream << "<svg xmlns=\"http://www.w3.org/2000/svg\" \n";
    svgStream << "    xmlns:xlink=\"http://www.w3.org/1999/xlink\"\n";
    svgStream << QString("    xmlns:krita=\"%1\"\n").arg(KoXmlNS::krita);
    svgStream << "    xmlns:sodipodi=\"http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd\"\n";
    svgStream << "    width=\"" << pageSize.width() << "pt\"\n";
    svgStream << "    height=\"" << pageSize.height() << "pt\"\n";
    svgStream << "    viewBox=\"0 0 "
              << pageSize.width() << " " << pageSize.height()
              << "\"";
    svgStream << ">" << Qt::endl;
 
    if (!m_documentTitle.isNull() && !m_documentTitle.isEmpty()) {
        svgStream << "<title>" << m_documentTitle << "</title>" << Qt::endl;
    }
 
    if (!m_documentDescription.isNull() && !m_documentDescription.isEmpty()) {
        svgStream << "<desc>" << m_documentDescription << "</desc>" << Qt::endl;
    }
 
    {
        SvgSavingContext savingContext(outputDevice, m_writeInlineImages);
        saveShapes(m_toplevelShapes, savingContext);
    }
 
    // end tag:
    svgStream << Qt::endl << "</svg>" << Qt::endl;
 
    return true;
}

References KoXmlNS::krita, m_documentDescription, m_documentTitle, m_toplevelShapes, m_writeInlineImages, saveShapes(), and KisPortingUtils::setUtf8OnStream().

saveDetached() [1/2]

bool SvgWriter::saveDetached

(

QIODevice &

outputDevice

)

Definition at line 129 of file SvgWriter.cpp.

{
    if (m_toplevelShapes.isEmpty())
        return false;
 
    SvgSavingContext savingContext(outputDevice, m_writeInlineImages);
    saveShapes(m_toplevelShapes, savingContext);
 
    return true;
}

References m_toplevelShapes, m_writeInlineImages, and saveShapes().

saveDetached() [2/2]

bool SvgWriter::saveDetached

(

SvgSavingContext &

savingContext

)

Definition at line 140 of file SvgWriter.cpp.

{
    if (m_toplevelShapes.isEmpty())
        return false;
 
    saveShapes(m_toplevelShapes, savingContext);
 
    return true;
}

References m_toplevelShapes, and saveShapes().

saveGeneric()

void SvgWriter::saveGeneric ( KoShape * shape, SvgSavingContext & context )

private

HACK ALERT: Qt (and Krita 3.x) has a weird bug, it assumes that all font sizes are defined in 96 ppi resolution, even though your the resolution in QSvgGenerator is manually set to 72 ppi. So here we do a tricky thing: we set a fake resolution to (72 * 72 / 96) = 54 ppi, which guarantees that the text, when painted in 96 ppi, will be actually painted in 72 ppi.

BUG: 389802

Definition at line 242 of file SvgWriter.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(shape);
 
    const QRectF bbox = shape->boundingRect();
 
    // paint shape to the image
    KoShapePainter painter;
    painter.setShapes(QList<KoShape*>()<< shape);
 
    // generate svg from shape
    QBuffer svgBuffer;
    QSvgGenerator svgGenerator;
    svgGenerator.setOutputDevice(&svgBuffer);
 
    if (shape->shapeId() == "TextShapeID") {
        svgGenerator.setResolution(54);
    }
 
    QPainter svgPainter;
    svgPainter.begin(&svgGenerator);
    painter.paint(svgPainter, SvgUtil::toUserSpace(bbox).toRect(), bbox);
    svgPainter.end();
 
    // remove anything before the start of the svg element from the buffer
    int startOfContent = svgBuffer.buffer().indexOf("<svg");
    if(startOfContent>0) {
        svgBuffer.buffer().remove(0, startOfContent);
    }
 
    // check if painting to svg produced any output
    if (svgBuffer.buffer().isEmpty()) {
        // prepare a transparent image, make it twice as big as the original size
        QImage image(2*bbox.size().toSize(), QImage::Format_ARGB32);
        image.fill(0);
        painter.paint(image);
 
        context.shapeWriter().startElement("image");
        context.shapeWriter().addAttribute("id", context.getID(shape));
        context.shapeWriter().addAttribute("x", bbox.x());
        context.shapeWriter().addAttribute("y", bbox.y());
        context.shapeWriter().addAttribute("width", bbox.width());
        context.shapeWriter().addAttribute("height", bbox.height());
        context.shapeWriter().addAttribute("xlink:href", context.saveImage(image));
        context.shapeWriter().endElement(); // image
 
    } else {
        context.shapeWriter().addCompleteElement(&svgBuffer);
    }
 
    // TODO: once we support saving single (flat) odf files
    // we can embed these here to have full support for generic shapes
}

References KoShape::boundingRect(), SvgSavingContext::getID(), KIS_SAFE_ASSERT_RECOVER_RETURN, KoShapePainter::paint(), SvgSavingContext::saveImage(), KoShapePainter::setShapes(), KoShape::shapeId(), SvgSavingContext::shapeWriter, and SvgUtil::toUserSpace().

saveGroup()

void SvgWriter::saveGroup ( KoShapeGroup * group, SvgSavingContext & context )

private

Definition at line 186 of file SvgWriter.cpp.

{
    context.shapeWriter().startElement("g");
    context.shapeWriter().addAttribute("id", context.getID(group));
 
    SvgUtil::writeTransformAttributeLazy("transform", group->transformation(), context.shapeWriter());
 
 
    SvgStyleWriter::saveMetadata(group, context);
 
    SvgStyleWriter::saveSvgStyle(group, context);
 
    QList<KoShape*> sortedShapes = group->shapes();
    std::sort(sortedShapes.begin(), sortedShapes.end(), KoShape::compareShapeZIndex);
 
    Q_FOREACH (KoShape * shape, sortedShapes) {
        KoShapeGroup * childGroup = dynamic_cast<KoShapeGroup*>(shape);
        if (childGroup)
            saveGroup(childGroup, context);
        else
            saveShape(shape, context);
    }
 
    context.shapeWriter().endElement();
}

References KoShape::compareShapeZIndex(), SvgSavingContext::getID(), saveGroup(), SvgStyleWriter::saveMetadata(), saveShape(), SvgStyleWriter::saveSvgStyle(), KoShapeContainer::shapes(), SvgSavingContext::shapeWriter, KoShape::transformation(), and SvgUtil::writeTransformAttributeLazy().

saveLayer()

void SvgWriter::saveLayer ( KoShapeLayer * layer, SvgSavingContext & context )

private

Definition at line 167 of file SvgWriter.cpp.

{
    context.shapeWriter().startElement("g");
    context.shapeWriter().addAttribute("id", context.getID(layer));
 
    QList<KoShape*> sortedShapes = layer->shapes();
    std::sort(sortedShapes.begin(), sortedShapes.end(), KoShape::compareShapeZIndex);
 
    Q_FOREACH (KoShape * shape, sortedShapes) {
        KoShapeGroup * group = dynamic_cast<KoShapeGroup*>(shape);
        if (group)
            saveGroup(group, context);
        else
            saveShape(shape, context);
    }
 
    context.shapeWriter().endElement();
}

References KoShape::compareShapeZIndex(), SvgSavingContext::getID(), saveGroup(), saveShape(), KoShapeContainer::shapes(), and SvgSavingContext::shapeWriter.

savePath()

void SvgWriter::savePath ( KoPathShape * path, SvgSavingContext & context )

private

Definition at line 227 of file SvgWriter.cpp.

{
    context.shapeWriter().startElement("path");
    context.shapeWriter().addAttribute("id", context.getID(path));
 
    SvgUtil::writeTransformAttributeLazy("transform", path->transformation(), context.shapeWriter());
    SvgStyleWriter::saveMetadata(path, context);
 
    SvgStyleWriter::saveSvgStyle(path, context);
 
    context.shapeWriter().addAttribute("d", path->toString(context.userSpaceTransform()));
    context.shapeWriter().addAttribute("sodipodi:nodetypes", path->nodeTypes());
    context.shapeWriter().endElement();
}

References SvgSavingContext::getID(), SvgStyleWriter::saveMetadata(), SvgStyleWriter::saveSvgStyle(), SvgSavingContext::shapeWriter, SvgSavingContext::userSpaceTransform(), and SvgUtil::writeTransformAttributeLazy().

saveShape()

void SvgWriter::saveShape ( KoShape * shape, SvgSavingContext & context )

private

Definition at line 212 of file SvgWriter.cpp.

{
    SvgShape *svgShape = dynamic_cast<SvgShape*>(shape);
    if (svgShape && svgShape->saveSvg(context))
        return;
 
    KoPathShape * path = dynamic_cast<KoPathShape*>(shape);
    if (path) {
        savePath(path, context);
    } else {
        // generic saving of shape via a switch element
        saveGeneric(shape, context);
    }
}

References saveGeneric(), savePath(), and SvgShape::saveSvg().

saveShapes()

void SvgWriter::saveShapes ( const QList< KoShape * > shapes, SvgSavingContext & savingContext )

private

Definition at line 150 of file SvgWriter.cpp.

{
    // top level shapes
    Q_FOREACH (KoShape *shape, shapes) {
        KoShapeLayer *layer = dynamic_cast<KoShapeLayer*>(shape);
        if(layer) {
            saveLayer(layer, savingContext);
        } else {
            KoShapeGroup *group = dynamic_cast<KoShapeGroup*>(shape);
            if (group)
                saveGroup(group, savingContext);
            else
                saveShape(shape, savingContext);
        }
    }
}

References saveGroup(), saveLayer(), and saveShape().

setDocumentDescription()

void SvgWriter::setDocumentDescription

(

QString

description

)

Definition at line 310 of file SvgWriter.cpp.

{
    m_documentDescription = description;
}

References m_documentDescription.

setDocumentTitle()

void SvgWriter::setDocumentTitle

(

QString

title

)

Definition at line 305 of file SvgWriter.cpp.

{
    m_documentTitle = title;
}

References m_documentTitle.

Member Data Documentation

m_documentDescription

QString SvgWriter::m_documentDescription

private

Definition at line 69 of file SvgWriter.h.

m_documentTitle

QString SvgWriter::m_documentTitle

private

Definition at line 68 of file SvgWriter.h.

m_toplevelShapes

QList<KoShape*> SvgWriter::m_toplevelShapes

private

Definition at line 66 of file SvgWriter.h.

m_writeInlineImages

bool SvgWriter::m_writeInlineImages

private

Definition at line 67 of file SvgWriter.h.

---

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

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