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

#include <ThemeFilterBase.hxx>

Inheritance diagram for oox::drawingml::ThemeFilterBase:
[legend]
Collaboration diagram for oox::drawingml::ThemeFilterBase:
[legend]

Public Types

typedef rtl::Reference< ThemeFilterBasePointer_t
 

Public Member Functions

 ThemeFilterBase (css::uno::Reference< css::uno::XComponentContext > const &rxContext)
 
virtual ~ThemeFilterBase () override
 
virtual const oox::drawingml::ThemegetCurrentTheme () const override
 Has to be implemented by each filter, returns the current theme. More...
 
virtual std::shared_ptr< oox::drawingml::ThemegetCurrentThemePtr () 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::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 oox::ole::VbaProjectimplCreateVbaProject () const override
 Derived classes create a VBA project manager object. 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...
 
- Public Member Functions inherited from oox::core::XmlFilterBase
 XmlFilterBase (const css::uno::Reference< css::uno::XComponentContext > &rxContext)
 
virtual ~XmlFilterBase () override
 
virtual const ::oox::drawingml::ThemegetCurrentTheme () const =0
 Has to be implemented by each filter, returns the current theme. More...
 
virtual std::shared_ptr<::oox::drawingml::ThemegetCurrentThemePtr () const
 May be implemented by filters which handle Diagrams, default returns empty ptr. More...
 
virtual ::oox::vml::DrawinggetVmlDrawing ()=0
 Has to be implemented by each filter to return the collection of VML shapes. More...
 
virtual ::oox::drawingml::chart::ChartConvertergetChartConverter ()=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)
 
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
 
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::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 OUString SAL_CALL getImplementationName () override
 

Private Attributes

oox::drawingml::ThemePtr mpTheme
 

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
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 20 of file ThemeFilterBase.hxx.

Member Typedef Documentation

◆ Pointer_t

Definition at line 23 of file ThemeFilterBase.hxx.

Constructor & Destructor Documentation

◆ ThemeFilterBase()

oox::drawingml::ThemeFilterBase::ThemeFilterBase ( css::uno::Reference< css::uno::XComponentContext > const &  rxContext)
explicit

Definition at line 17 of file ThemeFilterBase.cxx.

◆ ~ThemeFilterBase()

oox::drawingml::ThemeFilterBase::~ThemeFilterBase ( )
overridevirtualdefault

Member Function Documentation

◆ exportDocument()

virtual bool oox::drawingml::ThemeFilterBase::exportDocument ( )
inlineoverridevirtual

Derived classes implement export of the entire document.

Implements oox::core::FilterBase.

Definition at line 48 of file ThemeFilterBase.hxx.

◆ getChartConverter()

oox::drawingml::chart::ChartConverter * oox::drawingml::ThemeFilterBase::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 43 of file ThemeFilterBase.cxx.

◆ getCurrentTheme()

const oox::drawingml::Theme * oox::drawingml::ThemeFilterBase::getCurrentTheme ( ) const
overridevirtual

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

Implements oox::core::XmlFilterBase.

Definition at line 24 of file ThemeFilterBase.cxx.

References mpTheme.

◆ getCurrentThemePtr()

std::shared_ptr< oox::drawingml::Theme > oox::drawingml::ThemeFilterBase::getCurrentThemePtr ( ) const
overridevirtual

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

Reimplemented from oox::core::XmlFilterBase.

Definition at line 26 of file ThemeFilterBase.cxx.

References mpTheme.

◆ getImplementationName()

OUString oox::drawingml::ThemeFilterBase::getImplementationName ( )
overrideprivatevirtual

Definition at line 47 of file ThemeFilterBase.cxx.

◆ getTableStyles()

oox::drawingml::table::TableStyleListPtr oox::drawingml::ThemeFilterBase::getTableStyles ( )
overridevirtual

Has to be implemented by each filter to return TableStyles.

Implements oox::core::XmlFilterBase.

Definition at line 38 of file ThemeFilterBase.cxx.

◆ getVmlDrawing()

oox::vml::Drawing * oox::drawingml::ThemeFilterBase::getVmlDrawing ( )
overridevirtual

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

Implements oox::core::XmlFilterBase.

Definition at line 36 of file ThemeFilterBase.cxx.

◆ implCreateVbaProject()

oox::ole::VbaProject * oox::drawingml::ThemeFilterBase::implCreateVbaProject ( ) const
overridevirtual

Derived classes create a VBA project manager object.

Implements oox::core::FilterBase.

Definition at line 45 of file ThemeFilterBase.cxx.

◆ importDocument()

virtual bool oox::drawingml::ThemeFilterBase::importDocument ( )
inlineoverridevirtual

Derived classes implement import of the entire document.

Implements oox::core::FilterBase.

Definition at line 47 of file ThemeFilterBase.hxx.

◆ setCurrentTheme()

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

Definition at line 31 of file ThemeFilterBase.cxx.

References mpTheme.

Member Data Documentation

◆ mpTheme

oox::drawingml::ThemePtr oox::drawingml::ThemeFilterBase::mpTheme
private

Definition at line 53 of file ThemeFilterBase.hxx.

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


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