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

#include <ShapeFilterBase.hxx>

Inheritance diagram for oox::shape::ShapeFilterBase:
[legend]
Collaboration diagram for oox::shape::ShapeFilterBase:
[legend]

Public Types

typedef rtl::Reference< ShapeFilterBasePointer_t
 

Public Member Functions

 ShapeFilterBase (const css::uno::Reference< css::uno::XComponentContext > &rxContext)
 
virtual ~ShapeFilterBase () override
 
virtual const ::oox::drawingml::ThemegetCurrentTheme () const override
 Has to be implemented by each filter, returns the current theme. More...
 
void setCurrentTheme (const ::oox::drawingml::ThemePtr &pTheme)
 
virtual ::oox::vml::DrawinggetVmlDrawing () 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::ChartConvertergetChartConverter () 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 importTheme ()
 
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 void useInternalChartDataTable (bool)
 Helper to switch chart data table - specifically for xlsx imports. 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...
 
TextFieldStackgetTextFieldStack () const
 Returns a stack of used textfields, used by the pptx importer to replace links to slidepages with the real page name. 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...
 
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
 
void setMissingExtDrawing ()
 Signal that an MSO 2007-created SmartArt was found, need to warn the user about it. More...
 
void setDiagramFontHeights (NamedShapePairs *pDiagramFontHeights)
 
NamedShapePairsgetDiagramFontHeights ()
 
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
 
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::SequenceAsHashMapgetFilterData () const
 Returns the FilterData. More...
 
utl::MediaDescriptorgetMediaDescriptor () 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...
 
GraphicHelpergetGraphicHelper () const
 Returns a helper for the handling of graphics and graphic objects. More...
 
ModelObjectHelpergetModelObjectHelper () const
 Returns a helper with containers for various named drawing objects for the imported document. More...
 
ModelObjectHelpergetModelObjectHelperForModel (const css::uno::Reference< css::lang::XMultiServiceFactory > &xFactory) const
 
::oox::ole::OleObjectHelpergetOleObjectHelper () const
 Returns a helper for the handling of OLE objects. More...
 
::oox::ole::VbaProjectgetVbaProject () 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::VbaProjectimplCreateVbaProject () const override
 Derived classes create a VBA project manager object. More...
 
virtual OUString SAL_CALL getImplementationName () override
 
virtual GraphicHelperimplCreateGraphicHelper () const override
 Derived classes may create a specialized graphic helper, e.g. More...
 

Private Attributes

std::shared_ptr< ::oox::drawingml::chart::ChartConvertermxChartConv
 
::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 FastParsercreateParser ()
 
- 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
css::uno::Reference< css::io::XStream > const & getMainDocumentStream () const
 
- Protected Attributes inherited from oox::core::XmlFilterBase
bool mbMissingExtDrawing
 
- Protected Attributes inherited from cppu::BaseMutex
mutable::osl::Mutex m_aMutex
 

Detailed Description

Definition at line 40 of file ShapeFilterBase.hxx.

Member Typedef Documentation

Definition at line 43 of file ShapeFilterBase.hxx.

Constructor & Destructor Documentation

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

Definition at line 35 of file ShapeFilterBase.cxx.

References make_shared().

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

Definition at line 41 of file ShapeFilterBase.cxx.

Member Function Documentation

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

Derived classes implement export of the entire document.

Implements oox::core::FilterBase.

Definition at line 65 of file ShapeFilterBase.hxx.

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 65 of file ShapeFilterBase.cxx.

References mxChartConv.

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 45 of file ShapeFilterBase.cxx.

References mpTheme.

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

Definition at line 75 of file ShapeFilterBase.cxx.

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

Definition at line 113 of file ShapeFilterBase.cxx.

References oox::drawingml::Color::getColor().

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 60 of file ShapeFilterBase.cxx.

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 55 of file ShapeFilterBase.cxx.

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 105 of file ShapeFilterBase.cxx.

References oox::GraphicHelper::setGraphicMapper().

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

Derived classes create a VBA project manager object.

Implements oox::core::FilterBase.

Definition at line 70 of file ShapeFilterBase.cxx.

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

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

Derived classes implement import of the entire document.

Implements oox::core::FilterBase.

Definition at line 64 of file ShapeFilterBase.hxx.

void oox::shape::ShapeFilterBase::importTheme ( )

Definition at line 123 of file ShapeFilterBase.cxx.

References oox::drawingml::importFragment().

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

Definition at line 50 of file ShapeFilterBase.cxx.

References mpTheme.

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

Definition at line 71 of file ShapeFilterBase.hxx.

Member Data Documentation

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

Definition at line 82 of file ShapeFilterBase.hxx.

Referenced by getCurrentTheme(), and setCurrentTheme().

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

Definition at line 81 of file ShapeFilterBase.hxx.

Referenced by getChartConverter().

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

Definition at line 83 of file ShapeFilterBase.hxx.


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