Container that holds a list of shapes and shape templates. More...

#include <vmlshapecontainer.hxx>

Collaboration diagram for oox::vml::ShapeContainer:

Public Member Functions
	ShapeContainer (Drawing &rDrawing)

	~ShapeContainer ()

Drawing &	getDrawing ()
	Returns the drawing this shape container is part of. More...

std::shared_ptr< ShapeType >	createShapeType ()
	Creates and returns a new shape template object. More...

template<typename ShapeT >
std::shared_ptr< ShapeT >	createShape ()
	Creates and returns a new shape object of the specified type. More...

void	finalizeFragmentImport ()
	Final processing after import of the drawing fragment. More...

bool	empty () const
	Returns true, if this container does not contain any shapes. More...

const ShapeType *	getShapeTypeById (const OUString &rShapeId) const
	Returns the shape template with the passed identifier. More...

const ShapeBase *	getShapeById (const OUString &rShapeId) const
	Returns the shape with the passed identifier. More...

template<typename Functor >
const ShapeBase *	findShape (const Functor &rFunctor) const
	Searches for a shape by using the passed functor that takes a constant reference of a ShapeBase object. More...

std::shared_ptr< ShapeBase >	takeLastShape ()
	(Word only) Returns the last shape in the collection, if it is after the last mark from pushMark(), and removes it. More...

void	pushMark ()
	Adds a recursion mark to the stack. More...

void	popMark ()
	Removes a recursion mark. More...

void	convertAndInsert (const css::uno::Reference< css::drawing::XShapes > &rxShapes, const ShapeParentAnchor *pParentAnchor=nullptr) const
	Creates and inserts all UNO shapes into the passed container. More...

Private Types
typedef RefVector< ShapeType >	ShapeTypeVector

typedef RefVector< ShapeBase >	ShapeVector

typedef RefMap< OUString, ShapeType >	ShapeTypeMap

typedef RefMap< OUString, ShapeBase >	ShapeMap

Private Attributes
Drawing &	mrDrawing
	The VML drawing page that contains this shape. More...

ShapeTypeVector	maTypes
	All shape templates. More...

ShapeVector	maShapes
	All shape definitions. More...

ShapeTypeMap	maTypesById
	All shape templates mapped by identifier. More...

ShapeMap	maShapesById
	All shape definitions mapped by identifier. More...

std::stack< size_t >	markStack
	Recursion marks from pushMark()/popMark(). More...

Detailed Description

Container that holds a list of shapes and shape templates.

Definition at line 53 of file vmlshapecontainer.hxx.

Member Typedef Documentation

◆ ShapeMap

typedef RefMap< OUString, ShapeBase > oox::vml::ShapeContainer::ShapeMap

private

Definition at line 113 of file vmlshapecontainer.hxx.

◆ ShapeTypeMap

typedef RefMap< OUString, ShapeType > oox::vml::ShapeContainer::ShapeTypeMap

private

Definition at line 112 of file vmlshapecontainer.hxx.

◆ ShapeTypeVector

typedef RefVector< ShapeType > oox::vml::ShapeContainer::ShapeTypeVector

private

Definition at line 110 of file vmlshapecontainer.hxx.

◆ ShapeVector

typedef RefVector< ShapeBase > oox::vml::ShapeContainer::ShapeVector

private

Definition at line 111 of file vmlshapecontainer.hxx.

Constructor & Destructor Documentation

◆ ShapeContainer()

oox::vml::ShapeContainer::ShapeContainer ( Drawing & rDrawing )

explicit

Definition at line 52 of file vmlshapecontainer.cxx.

◆ ~ShapeContainer()

oox::vml::ShapeContainer::~ShapeContainer ( )

Definition at line 57 of file vmlshapecontainer.cxx.

Member Function Documentation

◆ convertAndInsert()

void oox::vml::ShapeContainer::convertAndInsert	(	const css::uno::Reference< css::drawing::XShapes > &	rxShapes,
		const ShapeParentAnchor *	pParentAnchor = `nullptr`
	)		const

Creates and inserts all UNO shapes into the passed container.

Definition at line 130 of file vmlshapecontainer.cxx.

References maShapes.

◆ createShape()

template<typename ShapeT >

std::shared_ptr< ShapeT > oox::vml::ShapeContainer::createShape

Creates and returns a new shape object of the specified type.

Definition at line 125 of file vmlshapecontainer.hxx.

References maShapes, and mrDrawing.

Referenced by oox::vml::ShapeContextBase::createShapeContext().

◆ createShapeType()

std::shared_ptr< ShapeType > oox::vml::ShapeContainer::createShapeType ( )

Creates and returns a new shape template object.

Definition at line 61 of file vmlshapecontainer.cxx.

References maTypes, and mrDrawing.

Referenced by oox::vml::ShapeContextBase::createShapeContext().

◆ empty()

bool oox::vml::ShapeContainer::empty ( ) const

inline

Returns true, if this container does not contain any shapes.

Definition at line 72 of file vmlshapecontainer.hxx.

References maShapes.

◆ finalizeFragmentImport()

void oox::vml::ShapeContainer::finalizeFragmentImport ( )

Final processing after import of the drawing fragment.

Definition at line 68 of file vmlshapecontainer.cxx.

References oox::vml::ShapeBase::finalizeFragmentImport(), oox::RefVector< ObjType >::forEachMem(), maShapes, maShapesById, maTypes, and maTypesById.

◆ findShape()

template<typename Functor >

const ShapeBase * oox::vml::ShapeContainer::findShape ( const Functor & rFunctor ) const

Searches for a shape by using the passed functor that takes a constant reference of a ShapeBase object.

Definition at line 134 of file vmlshapecontainer.hxx.

References oox::RefVector< ObjType >::findIf(), and maShapes.

◆ getDrawing()

Drawing & oox::vml::ShapeContainer::getDrawing ( )

inline

Returns the drawing this shape container is part of.

Definition at line 60 of file vmlshapecontainer.hxx.

References mrDrawing.

Referenced by oox::vml::ControlShapeContext::ControlShapeContext(), and oox::vml::ShapeContextBase::createShapeContext().

◆ getShapeById()

const ShapeBase * oox::vml::ShapeContainer::getShapeById ( const OUString & rShapeId ) const

Returns the shape with the passed identifier.

Searches in all group shapes too.

Definition at line 96 of file vmlshapecontainer.cxx.

References oox::RefMap< KeyType, ObjType, CompType >::get(), oox::vml::ShapeBase::getChildById(), maShapes, and maShapesById.

◆ getShapeTypeById()

const ShapeType * oox::vml::ShapeContainer::getShapeTypeById ( const OUString & rShapeId ) const

Returns the shape template with the passed identifier.

Searches in all group shapes too.

Definition at line 79 of file vmlshapecontainer.cxx.

References oox::RefMap< KeyType, ObjType, CompType >::get(), maShapes, maTypes, and maTypesById.

Referenced by oox::vml::ShapeBase::finalizeFragmentImport().

◆ popMark()

void oox::vml::ShapeContainer::popMark ( )

Removes a recursion mark.

Definition at line 124 of file vmlshapecontainer.cxx.

References markStack.

◆ pushMark()

void oox::vml::ShapeContainer::pushMark ( )

Adds a recursion mark to the stack.

It is possible that a shape contains <w:txbxContent> which contains another shape, and writerfilter needs to know which shape is from the inner ooxml context and which from the outer ooxml context, while it is necessary to keep at least shape types across such blocks. Therefore this function marks beginning of each shape xml block, and takeLastShape() returns only shapes from this block.

Definition at line 119 of file vmlshapecontainer.cxx.

References markStack, and maShapes.

◆ takeLastShape()

std::shared_ptr< ShapeBase > oox::vml::ShapeContainer::takeLastShape ( )

(Word only) Returns the last shape in the collection, if it is after the last mark from pushMark(), and removes it.

Definition at line 108 of file vmlshapecontainer.cxx.

References oox::vml::Drawing::getType(), markStack, maShapes, mrDrawing, and oox::vml::VMLDRAWING_WORD.

Member Data Documentation

◆ markStack

std::stack< size_t > oox::vml::ShapeContainer::markStack

private

Recursion marks from pushMark()/popMark().

Definition at line 120 of file vmlshapecontainer.hxx.

Referenced by popMark(), pushMark(), and takeLastShape().

◆ maShapes

ShapeVector oox::vml::ShapeContainer::maShapes

private

All shape definitions.

Definition at line 117 of file vmlshapecontainer.hxx.

Referenced by convertAndInsert(), createShape(), empty(), finalizeFragmentImport(), findShape(), getShapeById(), getShapeTypeById(), pushMark(), and takeLastShape().

◆ maShapesById

ShapeMap oox::vml::ShapeContainer::maShapesById

private

All shape definitions mapped by identifier.

Definition at line 119 of file vmlshapecontainer.hxx.

Referenced by finalizeFragmentImport(), and getShapeById().

◆ maTypes

ShapeTypeVector oox::vml::ShapeContainer::maTypes

private

All shape templates.

Definition at line 116 of file vmlshapecontainer.hxx.

Referenced by createShapeType(), finalizeFragmentImport(), and getShapeTypeById().

◆ maTypesById

ShapeTypeMap oox::vml::ShapeContainer::maTypesById

private

All shape templates mapped by identifier.

Definition at line 118 of file vmlshapecontainer.hxx.

Referenced by finalizeFragmentImport(), and getShapeTypeById().

◆ mrDrawing

Drawing& oox::vml::ShapeContainer::mrDrawing

private

The VML drawing page that contains this shape.

Definition at line 115 of file vmlshapecontainer.hxx.

Referenced by createShape(), createShapeType(), getDrawing(), and takeLastShape().

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

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ShapeMap

◆ ShapeTypeMap

◆ ShapeTypeVector

◆ ShapeVector

Constructor & Destructor Documentation

◆ ShapeContainer()

◆ ~ShapeContainer()

Member Function Documentation

◆ convertAndInsert()

◆ createShape()

◆ createShapeType()

◆ empty()

◆ finalizeFragmentImport()

◆ findShape()

◆ getDrawing()

◆ getShapeById()

◆ getShapeTypeById()

◆ popMark()

◆ pushMark()

◆ takeLastShape()

Member Data Documentation

◆ markStack

◆ maShapes

◆ maShapesById

◆ maTypes

◆ maTypesById

◆ mrDrawing