LibreOffice Module oox (master) 1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
oox::vml::GroupShape Class Referencefinal

A group shape that extends the basic shape by a container of child shapes. More...

#include <vmlshape.hxx>

Inheritance diagram for oox::vml::GroupShape:
[legend]
Collaboration diagram for oox::vml::GroupShape:
[legend]

Public Member Functions

 GroupShape (Drawing &rDrawing)
 
virtual ~GroupShape () override
 
ShapeContainergetChildren ()
 Returns read/write access to the container of child shapes and templates. More...
 
const ShapeContainergetChildren () const
 Returns read access to the container of child shapes and templates. More...
 
virtual void finalizeFragmentImport () override
 Final processing after import of the drawing fragment. More...
 
virtual const ShapeTypegetChildTypeById (const OUString &rShapeId) const override
 Returns the shape template with the passed identifier from the child shapes. More...
 
virtual const ShapeBasegetChildById (const OUString &rShapeId) const override
 Returns the shape with the passed identifier from the child shapes. More...
 
- Public Member Functions inherited from oox::vml::ShapeBase
ShapeModelgetShapeModel ()
 Returns read/write access to the shape model structure. More...
 
const ShapeModelgetShapeModel () const
 Returns read access to the shape model structure. More...
 
const TextBoxgetTextBox () const
 Returns read access to the shape textbox. More...
 
const ClientDatagetClientData () const
 Returns read access to the shape client data structure. More...
 
virtual void finalizeFragmentImport ()
 Final processing after import of the drawing fragment. More...
 
OUString getShapeName () const
 Returns the real shape name if existing, or a generated shape name. More...
 
virtual const ShapeTypegetChildTypeById (const OUString &rShapeId) const
 Returns the shape template with the passed identifier from the child shapes. More...
 
virtual const ShapeBasegetChildById (const OUString &rShapeId) const
 Returns the shape with the passed identifier from the child shapes. More...
 
css::uno::Reference< css::drawing::XShape > convertAndInsert (const css::uno::Reference< css::drawing::XShapes > &rxShapes, const ShapeParentAnchor *pParentAnchor=nullptr) const
 Creates the corresponding XShape and inserts it into the passed container. More...
 
void convertFormatting (const css::uno::Reference< css::drawing::XShape > &rxShape) const
 Converts position and formatting into the passed existing XShape. More...
 
void setContainer (ShapeContainer *pContainer)
 
ShapeContainergetContainer () const
 
- Public Member Functions inherited from oox::vml::ShapeType
 ShapeType (Drawing &rDrawing)
 
virtual ~ShapeType ()
 
ShapeTypeModelgetTypeModel ()
 Returns read/write access to the shape template model structure. More...
 
const ShapeTypeModelgetTypeModel () const
 Returns read access to the shape template model structure. More...
 
const OUString & getShapeId () const
 Returns the shape identifier (which is unique through the containing drawing). More...
 
sal_Int32 getShapeType () const
 Returns the application defined shape type. More...
 
OUString getGraphicPath () const
 Returns the fragment path to the embedded graphic used by this shape. More...
 
const DrawinggetDrawing () const
 

Private Member Functions

virtual css::uno::Reference< css::drawing::XShape > implConvertAndInsert (const css::uno::Reference< css::drawing::XShapes > &rxShapes, const css::awt::Rectangle &rShapeRect) const override
 Creates the corresponding XShape and inserts it into the passed container. More...
 

Private Attributes

std::unique_ptr< ShapeContainermxChildren
 Shapes and templates that are part of this group. More...
 

Additional Inherited Members

- Protected Member Functions inherited from oox::vml::ShapeBase
 ShapeBase (Drawing &rDrawing)
 
virtual css::uno::Reference< css::drawing::XShape > implConvertAndInsert (const css::uno::Reference< css::drawing::XShapes > &rxShapes, const css::awt::Rectangle &rShapeRect) const =0
 Derived classes create the corresponding XShape and insert it into the passed container. More...
 
virtual css::uno::Reference< css::drawing::XShape > finalImplConvertAndInsert (const css::uno::Reference< css::drawing::XShape > &rxShape) const
 Always called after implConvertAndInsert for the same task. More...
 
css::awt::Rectangle calcShapeRectangle (const ShapeParentAnchor *pParentAnchor) const
 Calculates the final shape rectangle according to the passed anchor, if present, otherwise according to the own anchor settings. More...
 
void convertShapeProperties (const css::uno::Reference< css::drawing::XShape > &rxShape) const
 Converts common shape properties such as formatting attributes. More...
 
- Protected Member Functions inherited from oox::vml::ShapeType
css::awt::Rectangle getCoordSystem () const
 Returns the coordinate system of this shape. More...
 
css::awt::Rectangle getRectangle (const ShapeParentAnchor *pParentAnchor) const
 Returns the absolute shape rectangle according to the passed anchor. More...
 
virtual css::awt::Rectangle getAbsRectangle () const
 Returns the absolute shape rectangle. More...
 
virtual css::awt::Rectangle getRelRectangle () const
 Returns the rectangle relative to the parent coordinate system. More...
 
- Protected Attributes inherited from oox::vml::ShapeBase
ShapeModel maShapeModel
 The model structure containing shape data. More...
 
ShapeContainermpContainer = nullptr
 
- Protected Attributes inherited from oox::vml::ShapeType
DrawingmrDrawing
 The VML drawing page that contains this shape. More...
 
ShapeTypeModel maTypeModel
 The model structure containing shape type data. More...
 

Detailed Description

A group shape that extends the basic shape by a container of child shapes.

Definition at line 441 of file vmlshape.hxx.

Constructor & Destructor Documentation

◆ GroupShape()

oox::vml::GroupShape::GroupShape ( Drawing rDrawing)
explicit

Definition at line 1504 of file vmlshape.cxx.

◆ ~GroupShape()

oox::vml::GroupShape::~GroupShape ( )
overridevirtual

Definition at line 1510 of file vmlshape.cxx.

Member Function Documentation

◆ finalizeFragmentImport()

void oox::vml::GroupShape::finalizeFragmentImport ( )
overridevirtual

Final processing after import of the drawing fragment.

Reimplemented from oox::vml::ShapeBase.

Definition at line 1514 of file vmlshape.cxx.

References oox::vml::ShapeBase::finalizeFragmentImport(), and mxChildren.

◆ getChildById()

const ShapeBase * oox::vml::GroupShape::getChildById ( const OUString &  rShapeId) const
overridevirtual

Returns the shape with the passed identifier from the child shapes.

Reimplemented from oox::vml::ShapeBase.

Definition at line 1527 of file vmlshape.cxx.

References mxChildren.

◆ getChildren() [1/2]

ShapeContainer & oox::vml::GroupShape::getChildren ( )
inline

Returns read/write access to the container of child shapes and templates.

Definition at line 448 of file vmlshape.hxx.

References mxChildren.

◆ getChildren() [2/2]

const ShapeContainer & oox::vml::GroupShape::getChildren ( ) const
inline

Returns read access to the container of child shapes and templates.

Definition at line 450 of file vmlshape.hxx.

References mxChildren.

◆ getChildTypeById()

const ShapeType * oox::vml::GroupShape::getChildTypeById ( const OUString &  rShapeId) const
overridevirtual

Returns the shape template with the passed identifier from the child shapes.

Reimplemented from oox::vml::ShapeBase.

Definition at line 1522 of file vmlshape.cxx.

References mxChildren.

◆ implConvertAndInsert()

Reference< XShape > oox::vml::GroupShape::implConvertAndInsert ( const css::uno::Reference< css::drawing::XShapes > &  rxShapes,
const css::awt::Rectangle &  rShapeRect 
) const
overrideprivatevirtual

Member Data Documentation

◆ mxChildren

std::unique_ptr<ShapeContainer> oox::vml::GroupShape::mxChildren
private

Shapes and templates that are part of this group.

Definition at line 468 of file vmlshape.hxx.

Referenced by finalizeFragmentImport(), getChildById(), getChildren(), getChildTypeById(), and implConvertAndInsert().


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