LibreOffice Module drawinglayer (master) 1
Public Member Functions | Private Attributes | List of all members
drawinglayer::primitive2d::StructureTagPrimitive2D Class Referencefinal

StructureTagPrimitive2D class. More...

#include <structuretagprimitive2d.hxx>

Inheritance diagram for drawinglayer::primitive2d::StructureTagPrimitive2D:
[legend]
Collaboration diagram for drawinglayer::primitive2d::StructureTagPrimitive2D:
[legend]

Public Member Functions

 StructureTagPrimitive2D (const vcl::PDFWriter::StructElement &rStructureElement, bool bBackground, bool bIsImage, Primitive2DContainer &&aChildren, void const *pAnchorStructureElementKey=nullptr, ::std::vector< sal_Int32 > const *pAnnotIds=nullptr)
 constructor More...
 
const vcl::PDFWriter::StructElementgetStructureElement () const
 data read access More...
 
bool isBackground () const
 
bool isImage () const
 
bool isTaggedSdrObject () const
 
void const * GetAnchorStructureElementKey () const
 
::std::vector< sal_Int32 > GetAnnotIds () const
 
virtual bool operator== (const BasePrimitive2D &rPrimitive) const override
 compare operator More...
 
virtual sal_uInt32 getPrimitive2DID () const override
 provide unique ID More...
 
- Public Member Functions inherited from drawinglayer::primitive2d::GroupPrimitive2D
 GroupPrimitive2D (Primitive2DContainer &&aChildren)
 constructor More...
 
const Primitive2DContainergetChildren () const
 data read access More...
 
void getChildren (Primitive2DDecompositionVisitor &rVisitor) const
 
virtual bool operator== (const BasePrimitive2D &rPrimitive) const override
 compare operator More...
 
virtual void get2DDecomposition (Primitive2DDecompositionVisitor &rVisitor, const geometry::ViewInformation2D &rViewInformation) const override
 local decomposition. Implementation will just return children More...
 
virtual sal_uInt32 getPrimitive2DID () const override
 provide unique ID More...
 
virtual sal_Int64 estimateUsage () override
 
- Public Member Functions inherited from drawinglayer::primitive2d::BasePrimitive2D
 BasePrimitive2D ()
 
virtual ~BasePrimitive2D () override
 
virtual bool operator== (const BasePrimitive2D &rPrimitive) const
 the ==operator is mainly needed to allow testing newly-created primitives against their last incarnation which buffers/holds the made decompositions. More...
 
bool operator!= (const BasePrimitive2D &rPrimitive) const
 
virtual basegfx::B2DRange getB2DRange (const geometry::ViewInformation2D &rViewInformation) const
 The default implementation will use getDecomposition results to create the range. More...
 
virtual sal_uInt32 getPrimitive2DID () const =0
 provide unique ID for fast identifying of known primitive implementations in renderers. More...
 
virtual void get2DDecomposition (Primitive2DDecompositionVisitor &rVisitor, const geometry::ViewInformation2D &rViewInformation) const
 The default implementation will return an empty sequence. More...
 
Primitive2DContainer getDecomposition (const css::uno::Sequence< css::beans::PropertyValue > &rViewParameters)
 The getDecomposition implementation for UNO API will use getDecomposition from this implementation. More...
 
css::geometry::RealRectangle2D getRange (const css::uno::Sequence< css::beans::PropertyValue > &rViewParameters)
 The getRange implementation for UNO API will use getRange from this implementation. More...
 
virtual sal_Int64 estimateUsage ()
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Private Attributes

vcl::PDFWriter::StructElement maStructureElement
 the PDF structure element this grouping represents More...
 
bool mbBackground
 flag for background object More...
 
bool mbIsImage
 flag for image (OBJ_GRAF) More...
 
void const * m_pAnchorStructureElementKey
 anchor structure element (Writer) More...
 
::std::vector< sal_Int32 > m_AnnotIds
 for Annot structure element, the ids of the annotations More...
 

Additional Inherited Members

- Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static void * operator new (std::size_t nSize)
 
static void * operator new (std::size_t nSize, std::nothrow_t const &rNothrow)
 
static void operator delete (void *pPtr)
 
static void operator delete (void *pPtr, std::nothrow_t const &rNothrow)
 
- Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual ~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE
 
- Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount m_nCount
 

Detailed Description

StructureTagPrimitive2D class.

This class is used to provide simple support for adding grouped pdf writer structured element information like used in sd from unomodel.cxx where a ViewObjectContactRedirector is used to add such information for diverse objects. This primitive encapsulates these and the VCLPdfRenderer uses it to apply the needed infos directly to the pdf export in a compatible way. If a renderer ignores this, it just decomposes to its child content.

Definition at line 42 of file structuretagprimitive2d.hxx.

Constructor & Destructor Documentation

◆ StructureTagPrimitive2D()

drawinglayer::primitive2d::StructureTagPrimitive2D::StructureTagPrimitive2D ( const vcl::PDFWriter::StructElement rStructureElement,
bool  bBackground,
bool  bIsImage,
Primitive2DContainer &&  aChildren,
void const *  pAnchorStructureElementKey = nullptr,
::std::vector< sal_Int32 > const *  pAnnotIds = nullptr 
)

constructor

Definition at line 29 of file structuretagprimitive2d.cxx.

References m_AnnotIds.

Member Function Documentation

◆ GetAnchorStructureElementKey()

void const * drawinglayer::primitive2d::StructureTagPrimitive2D::GetAnchorStructureElementKey ( ) const
inline

◆ GetAnnotIds()

::std::vector< sal_Int32 > drawinglayer::primitive2d::StructureTagPrimitive2D::GetAnnotIds ( ) const
inline

◆ getPrimitive2DID()

sal_uInt32 drawinglayer::primitive2d::StructureTagPrimitive2D::getPrimitive2DID ( ) const
overridevirtual

provide unique ID

Reimplemented from drawinglayer::primitive2d::GroupPrimitive2D.

Definition at line 62 of file structuretagprimitive2d.cxx.

References PRIMITIVE2D_ID_STRUCTURETAGPRIMITIVE2D.

◆ getStructureElement()

const vcl::PDFWriter::StructElement & drawinglayer::primitive2d::StructureTagPrimitive2D::getStructureElement ( ) const
inline

◆ isBackground()

bool drawinglayer::primitive2d::StructureTagPrimitive2D::isBackground ( ) const
inline

◆ isImage()

bool drawinglayer::primitive2d::StructureTagPrimitive2D::isImage ( ) const
inline

◆ isTaggedSdrObject()

bool drawinglayer::primitive2d::StructureTagPrimitive2D::isTaggedSdrObject ( ) const

◆ operator==()

bool drawinglayer::primitive2d::StructureTagPrimitive2D::operator== ( const BasePrimitive2D rPrimitive) const
overridevirtual

compare operator

Reimplemented from drawinglayer::primitive2d::GroupPrimitive2D.

Definition at line 48 of file structuretagprimitive2d.cxx.

References isBackground(), and isImage().

Member Data Documentation

◆ m_AnnotIds

::std::vector<sal_Int32> drawinglayer::primitive2d::StructureTagPrimitive2D::m_AnnotIds
private

for Annot structure element, the ids of the annotations

Definition at line 55 of file structuretagprimitive2d.hxx.

Referenced by StructureTagPrimitive2D().

◆ m_pAnchorStructureElementKey

void const* drawinglayer::primitive2d::StructureTagPrimitive2D::m_pAnchorStructureElementKey
private

anchor structure element (Writer)

Definition at line 53 of file structuretagprimitive2d.hxx.

◆ maStructureElement

vcl::PDFWriter::StructElement drawinglayer::primitive2d::StructureTagPrimitive2D::maStructureElement
private

the PDF structure element this grouping represents

Definition at line 46 of file structuretagprimitive2d.hxx.

◆ mbBackground

bool drawinglayer::primitive2d::StructureTagPrimitive2D::mbBackground
private

flag for background object

Definition at line 49 of file structuretagprimitive2d.hxx.

◆ mbIsImage

bool drawinglayer::primitive2d::StructureTagPrimitive2D::mbIsImage
private

flag for image (OBJ_GRAF)

Definition at line 51 of file structuretagprimitive2d.hxx.


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