#include <KoShapeSavingContext.h>

Public Types
enum	ShapeSavingOption { PresentationShape = 1 , DrawId = 2 , AutoStyleInStyleXml = 4 , UniqueMasterPages = 8 , ZIndex = 16 }
	The Style used for saving the shape. More...

Public Member Functions
void	addLayerForSaving (const KoShapeLayer *layer)

void	addOption (ShapeSavingOption option)
	add an option to the set of options stored on this context, will leave the other options intact.

void	addShapeOffset (const KoShape *shape, const QTransform &matrix)

void	addSharedData (const QString &id, KoSharedSavingData *data)

void	clearLayers ()

QMap< qint64, QString >	imagesToSave ()

bool	isSet (ShapeSavingOption option) const
	Check if an option is set.

	KoShapeSavingContext (KoXmlWriter &xmlWriter)
	Constructor.

QString	markerRef (const KoMarker *marker)

ShapeSavingOptions	options () const
	Get the options used.

void	removeOption (ShapeSavingOption option)
	remove an option, will leave the other options intact.

void	removeShapeOffset (const KoShape *shape)

void	saveLayerSet (KoXmlWriter &xmlWriter) const

void	setOptions (ShapeSavingOptions options)
	Set the options to use.

void	setXmlWriter (KoXmlWriter &xmlWriter)
	Set the xml writer.

QTransform	shapeOffset (const KoShape *shape) const

KoSharedSavingData *	sharedData (const QString &id) const

KoXmlWriter &	xmlWriter ()
	Get the xml writer.

virtual	~KoShapeSavingContext ()

Private Attributes
KoShapeSavingContextPrivate *const	d

Detailed Description

The set of data for the ODF file format used during saving of a shape.

Definition at line 31 of file KoShapeSavingContext.h.

Member Enumeration Documentation

◆ ShapeSavingOption

enum KoShapeSavingContext::ShapeSavingOption

The Style used for saving the shape.

Enumerator
PresentationShape	If set the style of family presentation is used, when not set the family graphic is used. See OpenDocument 9.2.15 Common Drawing Shape Attributes / Style
DrawId	Save the draw:id used for referencing the shape. If draw:id is saved, xml:id is also saved. See OpenDocument 9.2.15 Common Drawing Shape Attributes / ID
AutoStyleInStyleXml	If set the automatic style will be marked as being needed in styles.xml
UniqueMasterPages	If set duplicate master pages will be merged to one
ZIndex	If set the z-index is saved in the shape

Definition at line 35 of file KoShapeSavingContext.h.

                           {
        PresentationShape = 1,
        DrawId = 2,
        AutoStyleInStyleXml = 4,
        UniqueMasterPages = 8,
        ZIndex = 16
    };

Constructor & Destructor Documentation

◆ KoShapeSavingContext()

KoShapeSavingContext::KoShapeSavingContext ( KoXmlWriter & xmlWriter )

Constructor.

Parameters

xmlWriter	used for writing the xml
mainStyles	for saving the styles
embeddedSaver	for saving embedded documents

Definition at line 61 of file KoShapeSavingContext.cpp.

    : d(new KoShapeSavingContextPrivate(xmlWriter))
{
    // by default allow saving of draw:id + xml:id
    addOption(KoShapeSavingContext::DrawId);
}

References addOption(), and DrawId.

◆ ~KoShapeSavingContext()

KoShapeSavingContext::~KoShapeSavingContext ( )

virtual

Definition at line 68 of file KoShapeSavingContext.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ addLayerForSaving()

void KoShapeSavingContext::addLayerForSaving ( const KoShapeLayer * layer )

Adds a layer to save into a layer-set in styles.xml according to 9.1.2/9.1.3 odf spec

Parameters

layer the layer to save

Definition at line 109 of file KoShapeSavingContext.cpp.

{
    if (layer && ! d->layers.contains(layer))
        d->layers.append(layer);
}

References d, and KoShapeSavingContextPrivate::layers.

◆ addOption()

void KoShapeSavingContext::addOption ( ShapeSavingOption option )

add an option to the set of options stored on this context, will leave the other options intact.

Definition at line 98 of file KoShapeSavingContext.cpp.

{
    d->savingOptions = d->savingOptions | option;
}

References d, and KoShapeSavingContextPrivate::savingOptions.

◆ addShapeOffset()

void KoShapeSavingContext::addShapeOffset	(	const KoShape *	shape,
		const QTransform &	matrix )

Add an offset that will be applied to the shape position when saved

This is needed e.g. for shapes anchored to a text shape as the position is saved as offset to the anchor.

Parameters

shape	The shape for which the offset should be added.
matrix	The offset which should be applied on saving the position.

Definition at line 167 of file KoShapeSavingContext.cpp.

{
    d->shapeOffsets.insert(shape, m);
}

References d, and KoShapeSavingContextPrivate::shapeOffsets.

◆ addSharedData()

void KoShapeSavingContext::addSharedData	(	const QString &	id,
		KoSharedSavingData *	data )

Add shared data

This can be use to pass data between shapes on saving. E.g. The presentation page layout styles. With that e.g. the styles only need to be saved once and can be used everywhere without creating them again.

The ownership of the added data is passed to the context. The KoShapeSavingContext will delete the added data when it is destroyed.

Data inserted for a specific id will not be overwritten by calling addSharedData with the same id again.

You get an assertion when the id is already existing.

See also: KoSharedSavingData

Definition at line 145 of file KoShapeSavingContext.cpp.

{
    QMap<QString, KoSharedSavingData*>::iterator it(d->sharedData.find(id));
    // data will not be overwritten
    if (it == d->sharedData.end()) {
        d->sharedData.insert(id, data);
    } else {
        warnFlake << "The id" << id << "is already registered. Data not inserted";
        Q_ASSERT(it == d->sharedData.end());
    }
}

References d, KoShapeSavingContextPrivate::sharedData, and warnFlake.

◆ clearLayers()

void KoShapeSavingContext::clearLayers ( )

remove all layers

This can be used for saving different layer sets per page.

Definition at line 130 of file KoShapeSavingContext.cpp.

{
    d->layers.clear();
}

References d, and KoShapeSavingContextPrivate::layers.

◆ imagesToSave()

QMap< qint64, QString > KoShapeSavingContext::imagesToSave ( )

Get the images that needs to be saved to the store

Definition at line 135 of file KoShapeSavingContext.cpp.

{
    return d->imageNames;
}

References d, and KoShapeSavingContextPrivate::imageNames.

◆ isSet()

bool KoShapeSavingContext::isSet ( ShapeSavingOption option ) const

Check if an option is set.

Returns: true if the option is set, false otherwise

Definition at line 83 of file KoShapeSavingContext.cpp.

{
    return d->savingOptions & option;
}

References d, and KoShapeSavingContextPrivate::savingOptions.

◆ markerRef()

QString KoShapeSavingContext::markerRef ( const KoMarker * marker )

Get the reference to use for the marker lookup

Definition at line 140 of file KoShapeSavingContext.cpp.

{
    return QString();
}

◆ options()

KoShapeSavingContext::ShapeSavingOptions KoShapeSavingContext::options ( ) const

Get the options used.

Returns: options used

Definition at line 93 of file KoShapeSavingContext.cpp.

{
    return d->savingOptions;
}

References d, and KoShapeSavingContextPrivate::savingOptions.

◆ removeOption()

void KoShapeSavingContext::removeOption ( ShapeSavingOption option )

remove an option, will leave the other options intact.

Definition at line 103 of file KoShapeSavingContext.cpp.

{
    if (isSet(option))
        d->savingOptions = d->savingOptions ^ option; // xor to remove it.
}

References d, isSet(), and KoShapeSavingContextPrivate::savingOptions.

◆ removeShapeOffset()

void KoShapeSavingContext::removeShapeOffset ( const KoShape * shape )

Remove an offset from the saved offset list

Parameters

shape The shape for which the offset should be removed.

Definition at line 172 of file KoShapeSavingContext.cpp.

{
    d->shapeOffsets.remove(shape);
}

References d, and KoShapeSavingContextPrivate::shapeOffsets.

◆ saveLayerSet()

void KoShapeSavingContext::saveLayerSet ( KoXmlWriter & xmlWriter ) const

Saves the layers added with addLayerForSaving to the xml writer

Definition at line 115 of file KoShapeSavingContext.cpp.

{
    xmlWriter.startElement("draw:layer-set");
    Q_FOREACH (const KoShapeLayer * layer, d->layers) {
        xmlWriter.startElement("draw:layer");
        xmlWriter.addAttribute("draw:name", layer->name());
        if (layer->isGeometryProtected())
            xmlWriter.addAttribute("draw:protected", "true");
        if (! layer->isVisible(false))
            xmlWriter.addAttribute("draw:display", "none");
        xmlWriter.endElement();  // draw:layer
    }
    xmlWriter.endElement();  // draw:layer-set
}

References KoXmlWriter::addAttribute(), d, KoXmlWriter::endElement(), KoShape::isGeometryProtected(), KoShape::isVisible(), KoShapeSavingContextPrivate::layers, KoShape::name(), KoXmlWriter::startElement(), and xmlWriter().

◆ setOptions()

void KoShapeSavingContext::setOptions ( ShapeSavingOptions options )

Set the options to use.

Parameters

options to use

Definition at line 88 of file KoShapeSavingContext.cpp.

{
    d->savingOptions = options;
}

References d, options(), and KoShapeSavingContextPrivate::savingOptions.

◆ setXmlWriter()

void KoShapeSavingContext::setXmlWriter ( KoXmlWriter & xmlWriter )

Set the xml writer.

Change the xmlWriter that is used in the Context e.g. for saving to styles.xml instead of content.xml

Parameters

xmlWriter to use

Definition at line 78 of file KoShapeSavingContext.cpp.

{
    d->xmlWriter = &xmlWriter;
}

References d, KoShapeSavingContextPrivate::xmlWriter, and xmlWriter().

◆ shapeOffset()

QTransform KoShapeSavingContext::shapeOffset ( const KoShape * shape ) const

Get the offset that will be applied to the shape position when saved.

Parameters

shape The shape for which the offset should be get.

Returns: the saved offset or QTransform() when offset is not set.

Definition at line 177 of file KoShapeSavingContext.cpp.

{
    return d->shapeOffsets.value(shape, QTransform());
}

References d, and KoShapeSavingContextPrivate::shapeOffsets.

◆ sharedData()

KoSharedSavingData * KoShapeSavingContext::sharedData ( const QString & id ) const

Get the shared data.

See also: KoSharedLoadingData

Parameters

id	The id used to identify the shared data.

Returns: The shared data for the id or 0 if there is no shared data for the id.

Definition at line 157 of file KoShapeSavingContext.cpp.

{
    KoSharedSavingData * data = 0;
    QMap<QString, KoSharedSavingData*>::const_iterator it(d->sharedData.constFind(id));
    if (it != d->sharedData.constEnd()) {
        data = it.value();
    }
    return data;
}

References d, and KoShapeSavingContextPrivate::sharedData.

◆ xmlWriter()

KoXmlWriter & KoShapeSavingContext::xmlWriter ( )

Get the xml writer.

Returns: xmlWriter

Definition at line 73 of file KoShapeSavingContext.cpp.

{
    return *d->xmlWriter;
}

References d, and KoShapeSavingContextPrivate::xmlWriter.

Member Data Documentation

◆ d

KoShapeSavingContextPrivate* const KoShapeSavingContext::d

private

Definition at line 200 of file KoShapeSavingContext.h.

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

libs/flake/KoShapeSavingContext.h
libs/flake/KoShapeSavingContext.cpp

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ShapeSavingOption

Constructor & Destructor Documentation

◆ KoShapeSavingContext()

◆ ~KoShapeSavingContext()

Member Function Documentation

◆ addLayerForSaving()

◆ addOption()

◆ addShapeOffset()

◆ addSharedData()

◆ clearLayers()

◆ imagesToSave()

◆ isSet()

◆ markerRef()

◆ options()

◆ removeOption()

◆ removeShapeOffset()

◆ saveLayerSet()

◆ setOptions()

◆ setXmlWriter()

◆ shapeOffset()

◆ sharedData()

◆ xmlWriter()

Member Data Documentation

◆ d