#include <ShapeFilterBase.hxx>

Inheritance diagram for oox::shape::ShapeFilterBase:

Collaboration diagram for oox::shape::ShapeFilterBase:

Public Types
typedef rtl::Reference< ShapeFilterBase >	Pointer_t

Public Member Functions
	ShapeFilterBase (const css::uno::Reference< css::uno::XComponentContext > &rxContext)

virtual	~ShapeFilterBase () override

virtual const ::oox::drawingml::Theme *	getCurrentTheme () const override
	Has to be implemented by each filter, returns the current theme. More...

virtual std::shared_ptr<::oox::drawingml::Theme >	getCurrentThemePtr () const override
	May be implemented by filters which handle Diagrams, default returns empty ptr. More...

void	setCurrentTheme (const ::oox::drawingml::ThemePtr &pTheme)

virtual ::oox::vml::Drawing *	getVmlDrawing () override
	Has to be implemented by each filter to return the collection of VML shapes. More...

virtual ::oox::drawingml::table::TableStyleListPtr	getTableStyles () override
	Has to be implemented by each filter to return TableStyles. More...

virtual ::oox::drawingml::chart::ChartConverter *	getChartConverter () override
	Has to be implemented by each filter, returns a filter-specific chart converter object, that should be global per imported document. More...

virtual bool	importDocument () override
	Derived classes implement import of the entire document. More...

virtual bool	exportDocument () override
	Derived classes implement export of the entire document. More...

::Color	getSchemeColor (sal_Int32 nToken) const

void	setGraphicMapper (css::uno::Reference< css::graphic::XGraphicMapper > const &rxGraphicMapper)

Public Member Functions inherited from oox::core::XmlFilterBase
	XmlFilterBase (const css::uno::Reference< css::uno::XComponentContext > &rxContext)

virtual	~XmlFilterBase () override

virtual const ::oox::drawingml::Theme *	getCurrentTheme () const =0
	Has to be implemented by each filter, returns the current theme. More...

virtual std::shared_ptr<::oox::drawingml::Theme >	getCurrentThemePtr () const
	May be implemented by filters which handle Diagrams, default returns empty ptr. More...

virtual ::oox::vml::Drawing *	getVmlDrawing ()=0
	Has to be implemented by each filter to return the collection of VML shapes. More...

virtual ::oox::drawingml::chart::ChartConverter *	getChartConverter ()=0
	Has to be implemented by each filter, returns a filter-specific chart converter object, that should be global per imported document. More...

virtual void	useInternalChartDataTable (bool)
	Helper to switch chart data table - specifically for xlsx imports. More...

virtual ::oox::drawingml::table::TableStyleListPtr	getTableStyles ()=0
	Has to be implemented by each filter to return the table style list. More...

OUString	getFragmentPathFromFirstTypeFromOfficeDoc (std::u16string_view rPart)

bool	importFragment (const rtl::Reference< FragmentHandler > &rxHandler)
	Imports a fragment using the passed fragment handler, which contains the full path to the fragment stream. More...

bool	importFragment (const rtl::Reference< FragmentHandler > &rxHandler, FastParser &rParser)

css::uno::Reference< css::xml::dom::XDocument >	importFragment (const OUString &rFragmentPath)
	Imports a fragment into an xml::dom::XDocument. More...

bool	importFragment (const ::rtl::Reference< FragmentHandler > &rxHandler, const css::uno::Reference< css::xml::sax::XFastSAXSerializable > &rxSerializer)
	Imports a fragment from an xml::dom::XDocument using the passed fragment handler. More...

RelationsRef	importRelations (const OUString &rFragmentPath)
	Imports the relations fragment associated with the specified fragment. More...

OUString	addRelation (const OUString &rType, std::u16string_view rTarget)
	Adds new relation. More...

OUString	addRelation (const css::uno::Reference< css::io::XOutputStream > &rOutputStream, const OUString &rType, std::u16string_view rTarget, bool bExternal=false)
	Adds new relation to part's relations. More...

css::uno::Reference< css::io::XOutputStream >	openFragmentStream (const OUString &rStreamName, const OUString &rMediaType)
	Opens and returns the specified output stream from the base storage with specified media type. More...

::sax_fastparser::FSHelperPtr	openFragmentStreamWithSerializer (const OUString &rStreamName, const OUString &rMediaType)
	Opens specified output stream from the base storage with specified media type and returns new fast serializer for that stream. More...

sal_Int32	GetUniqueId ()
	Returns new unique ID for exported document. More...

sal_Int32	GetMaxDocId ()

void	SetMaxDocId (sal_Int32 maxDocId)

void	exportDocumentProperties (const css::uno::Reference< css::document::XDocumentProperties > &xProperties, bool bSecurityOptOpenReadOnly)
	Write the document properties into into the current OPC package. More...

void	exportCustomFragments ()
	Write the customXml entries we are preserving (xlsx and pptx only). More...

void	importDocumentProperties ()
	Read the document properties and also the customXml entries (xlsx and pptx only). More...

bool	isMSO2007Document () const

bool	isMSODocument () const

void	setMissingExtDrawing ()
	Signal that an MSO 2007-created SmartArt was found, need to warn the user about it. More...

void	setDiagramFontHeights (NamedShapePairs *pDiagramFontHeights)

NamedShapePairs *	getDiagramFontHeights ()

void	checkDocumentProperties (const css::uno::Reference< css::document::XDocumentProperties > &xDocProps)

OUString	getNamespaceURL (sal_Int32 nNSID) const

Public Member Functions inherited from oox::core::FilterBase
	FilterBase (const css::uno::Reference< css::uno::XComponentContext > &rxContext)

virtual	~FilterBase () override

bool	isImportFilter () const
	Returns true, if filter is an import filter. More...

bool	isExportFilter () const
	Returns true, if filter is an export filter. More...

OoxmlVersion	getVersion () const

virtual bool	importDocument ()=0
	Derived classes implement import of the entire document. More...

virtual bool	exportDocument ()=0
	Derived classes implement export of the entire document. More...

const css::uno::Reference< css::uno::XComponentContext > &	getComponentContext () const
	Returns the component context passed in the filter constructor (always existing). More...

const css::uno::Reference< css::frame::XModel > &	getModel () const
	Returns the document model (always existing). More...

const css::uno::Reference< css::lang::XMultiServiceFactory > &	getModelFactory () const
	Returns the service factory provided by the document model (always existing). More...

const css::uno::Reference< css::frame::XFrame > &	getTargetFrame () const
	Returns the frame that will contain the document model (may be null). More...

const css::uno::Reference< css::task::XStatusIndicator > &	getStatusIndicator () const
	Returns the status indicator (may be null). More...

::comphelper::SequenceAsHashMap &	getFilterData () const
	Returns the FilterData. More...

utl::MediaDescriptor &	getMediaDescriptor () const
	Returns the media descriptor. More...

const OUString &	getFileUrl () const
	Returns the URL of the imported or exported file. More...

OUString	getAbsoluteUrl (const OUString &rUrl) const
	Returns an absolute URL for the passed relative or absolute URL. More...

StorageRef const &	getStorage () const
	Returns the base storage of the imported/exported file. More...

css::uno::Reference< css::io::XInputStream >	openInputStream (const OUString &rStreamName) const
	Opens and returns the specified input stream from the base storage. More...

css::uno::Reference< css::io::XOutputStream >	openOutputStream (const OUString &rStreamName) const
	Opens and returns the specified output stream from the base storage. More...

void	commitStorage () const
	Commits changes to base storage (and substorages) More...

GraphicHelper &	getGraphicHelper () const
	Returns a helper for the handling of graphics and graphic objects. More...

ModelObjectHelper &	getModelObjectHelper () const
	Returns a helper with containers for various named drawing objects for the imported document. More...

ModelObjectHelper &	getModelObjectHelperForModel (const css::uno::Reference< css::lang::XMultiServiceFactory > &xFactory) const

::oox::ole::OleObjectHelper &	getOleObjectHelper () const
	Returns a helper for the handling of OLE objects. More...

::oox::ole::VbaProject &	getVbaProject () const
	Returns the VBA project manager. More...

bool	importBinaryData (StreamDataSequence &orDataSeq, const OUString &rStreamName)
	Imports the raw binary data from the specified stream. More...

virtual sal_Bool SAL_CALL	supportsService (const OUString &rServiceName) override

virtual css::uno::Sequence< OUString > SAL_CALL	getSupportedServiceNames () override

virtual void SAL_CALL	initialize (const css::uno::Sequence< css::uno::Any > &rArgs) override
	Receives user defined arguments. More...

virtual void SAL_CALL	setTargetDocument (const css::uno::Reference< css::lang::XComponent > &rxDocument) override

virtual void SAL_CALL	setSourceDocument (const css::uno::Reference< css::lang::XComponent > &rxDocument) override

virtual sal_Bool SAL_CALL	filter (const css::uno::Sequence< css::beans::PropertyValue > &rMediaDescSeq) override

virtual void SAL_CALL	cancel () override

bool	exportVBA () const

bool	isExportTemplate () const

Private Member Functions
virtual ::oox::ole::VbaProject *	implCreateVbaProject () const override
	Derived classes create a VBA project manager object. More...

virtual OUString SAL_CALL	getImplementationName () override

virtual GraphicHelper *	implCreateGraphicHelper () const override
	Derived classes may create a specialized graphic helper, e.g. More...

Private Attributes
std::shared_ptr< ::oox::drawingml::chart::ChartConverter >	mxChartConv

::oox::drawingml::ThemePtr	mpTheme

css::uno::Reference< css::graphic::XGraphicMapper >	mxGraphicMapper

Additional Inherited Members
Static Public Member Functions inherited from oox::core::XmlFilterBase
static void	putPropertiesToDocumentGrabBag (const css::uno::Reference< css::lang::XComponent > &xDstDoc, const comphelper::SequenceAsHashMap &rProperties)

static FastParser *	createParser ()

Protected Member Functions inherited from oox::core::XmlFilterBase
virtual css::uno::Reference< css::io::XInputStream >	implGetInputStream (utl::MediaDescriptor &rMediaDesc) const override

virtual css::uno::Reference< css::io::XStream >	implGetOutputStream (utl::MediaDescriptor &rMediaDesc) const override

virtual bool	implFinalizeExport (utl::MediaDescriptor &rMediaDescriptor) override

Protected Member Functions inherited from oox::core::FilterBase
virtual css::uno::Reference< css::io::XInputStream >	implGetInputStream (utl::MediaDescriptor &rMediaDesc) const

virtual css::uno::Reference< css::io::XStream >	implGetOutputStream (utl::MediaDescriptor &rMediaDesc) const

virtual bool	implFinalizeExport (utl::MediaDescriptor &rMediaDescriptor)

css::uno::Reference< css::io::XStream > const &	getMainDocumentStream () const

Protected Attributes inherited from oox::core::XmlFilterBase
bool	mbMissingExtDrawing

Detailed Description

Definition at line 41 of file ShapeFilterBase.hxx.

Member Typedef Documentation

◆ Pointer_t

typedef rtl::Reference<ShapeFilterBase> oox::shape::ShapeFilterBase::Pointer_t

Definition at line 44 of file ShapeFilterBase.hxx.

Constructor & Destructor Documentation

◆ ShapeFilterBase()

oox::shape::ShapeFilterBase::ShapeFilterBase ( const css::uno::Reference< css::uno::XComponentContext > & rxContext )

explicit

Exceptions

css::uno::RuntimeException

Definition at line 37 of file ShapeFilterBase.cxx.

References if(), and make_shared().

◆ ~ShapeFilterBase()

oox::shape::ShapeFilterBase::~ShapeFilterBase ( )

overridevirtual

Definition at line 48 of file ShapeFilterBase.cxx.

Member Function Documentation

◆ exportDocument()

virtual bool oox::shape::ShapeFilterBase::exportDocument ( )

inlineoverridevirtual

Derived classes implement export of the entire document.

Implements oox::core::FilterBase.

Definition at line 69 of file ShapeFilterBase.hxx.

◆ getChartConverter()

oox::drawingml::chart::ChartConverter * oox::shape::ShapeFilterBase::getChartConverter ( )

overridevirtual

Has to be implemented by each filter, returns a filter-specific chart converter object, that should be global per imported document.

Implements oox::core::XmlFilterBase.

Definition at line 77 of file ShapeFilterBase.cxx.

References mxChartConv.

◆ getCurrentTheme()

const ::oox::drawingml::Theme * oox::shape::ShapeFilterBase::getCurrentTheme ( ) const

overridevirtual

Has to be implemented by each filter, returns the current theme.

Implements oox::core::XmlFilterBase.

Definition at line 52 of file ShapeFilterBase.cxx.

References mpTheme.

◆ getCurrentThemePtr()

std::shared_ptr<::oox::drawingml::Theme > oox::shape::ShapeFilterBase::getCurrentThemePtr ( ) const

overridevirtual

May be implemented by filters which handle Diagrams, default returns empty ptr.

Reimplemented from oox::core::XmlFilterBase.

Definition at line 57 of file ShapeFilterBase.cxx.

References mpTheme.

◆ getImplementationName()

OUString oox::shape::ShapeFilterBase::getImplementationName ( )

overrideprivatevirtual

Definition at line 87 of file ShapeFilterBase.cxx.

◆ getSchemeColor()

Color oox::shape::ShapeFilterBase::getSchemeColor ( sal_Int32 nToken ) const

Definition at line 125 of file ShapeFilterBase.cxx.

References nToken.

◆ getTableStyles()

oox::drawingml::table::TableStyleListPtr oox::shape::ShapeFilterBase::getTableStyles ( )

overridevirtual

Has to be implemented by each filter to return TableStyles.

Implements oox::core::XmlFilterBase.

Definition at line 72 of file ShapeFilterBase.cxx.

◆ getVmlDrawing()

oox::vml::Drawing * oox::shape::ShapeFilterBase::getVmlDrawing ( )

overridevirtual

Has to be implemented by each filter to return the collection of VML shapes.

Implements oox::core::XmlFilterBase.

Definition at line 67 of file ShapeFilterBase.cxx.

◆ implCreateGraphicHelper()

GraphicHelper * oox::shape::ShapeFilterBase::implCreateGraphicHelper ( ) const

overrideprivatevirtual

Derived classes may create a specialized graphic helper, e.g.

for resolving palette colors.

Reimplemented from oox::core::FilterBase.

Definition at line 117 of file ShapeFilterBase.cxx.

References oox::GraphicHelper::setGraphicMapper().

◆ implCreateVbaProject()

oox::ole::VbaProject * oox::shape::ShapeFilterBase::implCreateVbaProject ( ) const

overrideprivatevirtual

Derived classes create a VBA project manager object.

Implements oox::core::FilterBase.

Definition at line 82 of file ShapeFilterBase.cxx.

References oox::core::FilterBase::getComponentContext(), oox::core::FilterBase::getModel(), and u.

◆ importDocument()

virtual bool oox::shape::ShapeFilterBase::importDocument ( )

inlineoverridevirtual

Derived classes implement import of the entire document.

Implements oox::core::FilterBase.

Definition at line 68 of file ShapeFilterBase.hxx.

◆ setCurrentTheme()

void oox::shape::ShapeFilterBase::setCurrentTheme ( const ::oox::drawingml::ThemePtr & pTheme )

Definition at line 62 of file ShapeFilterBase.cxx.

References mpTheme.

◆ setGraphicMapper()

void oox::shape::ShapeFilterBase::setGraphicMapper ( css::uno::Reference< css::graphic::XGraphicMapper > const & rxGraphicMapper )

inline

Definition at line 73 of file ShapeFilterBase.hxx.

Member Data Documentation

◆ mpTheme

::oox::drawingml::ThemePtr oox::shape::ShapeFilterBase::mpTheme

private

Definition at line 84 of file ShapeFilterBase.hxx.

Referenced by getCurrentTheme(), getCurrentThemePtr(), and setCurrentTheme().

◆ mxChartConv

std::shared_ptr< ::oox::drawingml::chart::ChartConverter > oox::shape::ShapeFilterBase::mxChartConv

private

Definition at line 83 of file ShapeFilterBase.hxx.

Referenced by getChartConverter().

◆ mxGraphicMapper

css::uno::Reference<css::graphic::XGraphicMapper> oox::shape::ShapeFilterBase::mxGraphicMapper

private

Definition at line 85 of file ShapeFilterBase.hxx.

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Pointer_t

Constructor & Destructor Documentation

◆ ShapeFilterBase()

◆ ~ShapeFilterBase()

Member Function Documentation

◆ exportDocument()

◆ getChartConverter()

◆ getCurrentTheme()

◆ getCurrentThemePtr()

◆ getImplementationName()

◆ getSchemeColor()

◆ getTableStyles()

◆ getVmlDrawing()

◆ implCreateGraphicHelper()

◆ implCreateVbaProject()

◆ importDocument()

◆ setCurrentTheme()

◆ setGraphicMapper()

Member Data Documentation

◆ mpTheme

◆ mxChartConv

◆ mxGraphicMapper