LibreOffice Module writerfilter (master) 1
Public Types | Public Member Functions | List of all members
writerfilter::ooxml::OOXMLDocument Class Referenceabstract

#include <OOXMLDocument.hxx>

Inheritance diagram for writerfilter::ooxml::OOXMLDocument:
[legend]
Collaboration diagram for writerfilter::ooxml::OOXMLDocument:
[legend]

Public Types

typedef tools::SvRef< OOXMLDocumentPointer_t
 Pointer to this stream. More...
 
- Public Types inherited from writerfilter::Reference< Stream >
typedef tools::SvRef< Reference< Stream > > Pointer_t
 Pointer to reference. More...
 

Public Member Functions

virtual void resolve (Stream &rStream) override=0
 Resolves this document to a stream handler. More...
 
virtual void resolveFootnote (Stream &rStream, Id aNoteType, const sal_Int32 nNoteId)=0
 Resolves a footnote to a stream handler. More...
 
virtual void resolveEndnote (Stream &rStream, Id aNoteType, const sal_Int32 NoteId)=0
 Resolves an endnote to a stream handler. More...
 
virtual void resolveComment (Stream &rStream, const sal_Int32 nCommentId)=0
 Resolves a comment to a stream handler. More...
 
virtual void resolvePicture (Stream &rStream, const OUString &rPictureId)=0
 Resolves a picture to a stream handler. More...
 
virtual void resolveHeader (Stream &rStream, const sal_Int32 type, const OUString &rId)=0
 Resolves a header to a stream handler. More...
 
virtual void resolveFooter (Stream &rStream, const sal_Int32 type, const OUString &rId)=0
 Resolves a footer to a stream handler. More...
 
virtual OUString getTargetForId (const OUString &rId)=0
 Returns target URL from relationships for a given id. More...
 
virtual void setModel (css::uno::Reference< css::frame::XModel > xModel)=0
 
virtual css::uno::Reference< css::frame::XModel > getModel ()=0
 
virtual void setDrawPage (css::uno::Reference< css::drawing::XDrawPage > xDrawPage)=0
 
virtual css::uno::Reference< css::drawing::XDrawPage > getDrawPage ()=0
 
virtual css::uno::Reference< css::io::XInputStream > getInputStreamForId (const OUString &rId)=0
 
virtual void setXNoteId (const sal_Int32 nId)=0
 
virtual sal_Int32 getXNoteId () const =0
 
virtual const OUString & getTarget () const =0
 
virtual rtl::Reference< oox::shape::ShapeContextHandlergetShapeContext ()=0
 
virtual void setShapeContext (rtl::Reference< oox::shape::ShapeContextHandler > xContext)=0
 
virtual const oox::drawingml::ThemePtrgetTheme () const =0
 
virtual void pushShapeContext ()=0
 Push context of drawingML shapes, so nested shapes are handled separately. More...
 
virtual void popShapeContext ()=0
 Pop context of a previously pushed drawingML shape. More...
 
virtual css::uno::Reference< css::xml::dom::XDocument > getThemeDom ()=0
 
virtual css::uno::Reference< css::xml::dom::XDocument > getGlossaryDocDom ()=0
 
virtual css::uno::Sequence< css::uno::Sequence< css::beans::NamedValue > > getGlossaryDomList ()=0
 
virtual css::uno::Sequence< css::uno::Reference< css::xml::dom::XDocument > > getCustomXmlDomList ()=0
 
virtual css::uno::Sequence< css::uno::Reference< css::xml::dom::XDocument > > getCustomXmlDomPropsList ()=0
 
virtual css::uno::Sequence< css::beans::PropertyValue > getEmbeddingsList ()=0
 
- Public Member Functions inherited from writerfilter::Reference< Stream >
virtual void resolve (Stream &rHandler)=0
 Resolves the reference. More...
 
 Reference ()=default
 
 Reference (Reference const &)=default
 
 Reference (Reference &&)=default
 
Referenceoperator= (Reference const &)=default
 
Referenceoperator= (Reference &&)=default
 
- Public Member Functions inherited from SvRefBase
 SvRefBase ()
 
 SvRefBase (const SvRefBase &)
 
SvRefBaseoperator= (const SvRefBase &)
 
void RestoreNoDelete ()
 
void AddNextRef ()
 
void AddFirstRef ()
 
void ReleaseRef ()
 
unsigned int GetRefCount () const
 

Additional Inherited Members

- Protected Member Functions inherited from writerfilter::Reference< Stream >
 ~Reference () override
 
- Protected Member Functions inherited from SvRefBase
virtual ~SvRefBase () COVERITY_NOEXCEPT_FALSE
 

Detailed Description

Definition at line 108 of file OOXMLDocument.hxx.

Member Typedef Documentation

◆ Pointer_t

Pointer to this stream.

Definition at line 114 of file OOXMLDocument.hxx.

Member Function Documentation

◆ getCustomXmlDomList()

virtual css::uno::Sequence< css::uno::Reference< css::xml::dom::XDocument > > writerfilter::ooxml::OOXMLDocument::getCustomXmlDomList ( )
pure virtual

◆ getCustomXmlDomPropsList()

virtual css::uno::Sequence< css::uno::Reference< css::xml::dom::XDocument > > writerfilter::ooxml::OOXMLDocument::getCustomXmlDomPropsList ( )
pure virtual

◆ getDrawPage()

virtual css::uno::Reference< css::drawing::XDrawPage > writerfilter::ooxml::OOXMLDocument::getDrawPage ( )
pure virtual

◆ getEmbeddingsList()

virtual css::uno::Sequence< css::beans::PropertyValue > writerfilter::ooxml::OOXMLDocument::getEmbeddingsList ( )
pure virtual

◆ getGlossaryDocDom()

virtual css::uno::Reference< css::xml::dom::XDocument > writerfilter::ooxml::OOXMLDocument::getGlossaryDocDom ( )
pure virtual

◆ getGlossaryDomList()

virtual css::uno::Sequence< css::uno::Sequence< css::beans::NamedValue > > writerfilter::ooxml::OOXMLDocument::getGlossaryDomList ( )
pure virtual

◆ getInputStreamForId()

virtual css::uno::Reference< css::io::XInputStream > writerfilter::ooxml::OOXMLDocument::getInputStreamForId ( const OUString &  rId)
pure virtual

◆ getModel()

virtual css::uno::Reference< css::frame::XModel > writerfilter::ooxml::OOXMLDocument::getModel ( )
pure virtual

◆ getShapeContext()

virtual rtl::Reference< oox::shape::ShapeContextHandler > writerfilter::ooxml::OOXMLDocument::getShapeContext ( )
pure virtual

◆ getTarget()

virtual const OUString & writerfilter::ooxml::OOXMLDocument::getTarget ( ) const
pure virtual

◆ getTargetForId()

virtual OUString writerfilter::ooxml::OOXMLDocument::getTargetForId ( const OUString &  rId)
pure virtual

Returns target URL from relationships for a given id.

Parameters
rIdthe id to look for
Returns
the URL found or an empty string

Implemented in writerfilter::ooxml::OOXMLDocumentImpl.

◆ getTheme()

virtual const oox::drawingml::ThemePtr & writerfilter::ooxml::OOXMLDocument::getTheme ( ) const
pure virtual

◆ getThemeDom()

virtual css::uno::Reference< css::xml::dom::XDocument > writerfilter::ooxml::OOXMLDocument::getThemeDom ( )
pure virtual

◆ getXNoteId()

virtual sal_Int32 writerfilter::ooxml::OOXMLDocument::getXNoteId ( ) const
pure virtual

◆ popShapeContext()

virtual void writerfilter::ooxml::OOXMLDocument::popShapeContext ( )
pure virtual

Pop context of a previously pushed drawingML shape.

Implemented in writerfilter::ooxml::OOXMLDocumentImpl.

◆ pushShapeContext()

virtual void writerfilter::ooxml::OOXMLDocument::pushShapeContext ( )
pure virtual

Push context of drawingML shapes, so nested shapes are handled separately.

Implemented in writerfilter::ooxml::OOXMLDocumentImpl.

◆ resolve()

virtual void writerfilter::ooxml::OOXMLDocument::resolve ( Stream rStream)
overridepure virtual

Resolves this document to a stream handler.

Parameters
rStreamstream handler to resolve this document to

Implements writerfilter::Reference< Stream >.

Implemented in writerfilter::ooxml::OOXMLDocumentImpl.

◆ resolveComment()

virtual void writerfilter::ooxml::OOXMLDocument::resolveComment ( Stream rStream,
const sal_Int32  nCommentId 
)
pure virtual

Resolves a comment to a stream handler.

Parameters
rStreamstream handler to resolve to
rCommentid of the comment to resolve

Implemented in writerfilter::ooxml::OOXMLDocumentImpl.

◆ resolveEndnote()

virtual void writerfilter::ooxml::OOXMLDocument::resolveEndnote ( Stream rStream,
Id  aNoteType,
const sal_Int32  NoteId 
)
pure virtual

Resolves an endnote to a stream handler.

An endnote is resolved if either the note type or note id matches.

Parameters
rStreamstream handler to resolve to
rNoteTypetype of footnote to resolve
rNoteIdid of the endnote to resolve

Implemented in writerfilter::ooxml::OOXMLDocumentImpl.

◆ resolveFooter()

virtual void writerfilter::ooxml::OOXMLDocument::resolveFooter ( Stream rStream,
const sal_Int32  type,
const OUString &  rId 
)
pure virtual

Resolves a footer to a stream handler.

Parameters
rStreamstream handler to resolve to
typetype of footer to resolve: NS_ooxml::LN_Value_ST_HrdFtr_even header on even page NS_ooxml::LN_Value_ST_HrdFtr_default header on right page NS_ooxml::LN_Value_ST_HrdFtr_first header on first page
rIdid of the header

Implemented in writerfilter::ooxml::OOXMLDocumentImpl.

◆ resolveFootnote()

virtual void writerfilter::ooxml::OOXMLDocument::resolveFootnote ( Stream rStream,
Id  aNoteType,
const sal_Int32  nNoteId 
)
pure virtual

Resolves a footnote to a stream handler.

A footnote is resolved if either the note type or note id matches.

Parameters
rStreamstream handler to resolve to
rNoteTypetype of footnote to resolve
rNoteIdid of the footnote to resolve

Implemented in writerfilter::ooxml::OOXMLDocumentImpl.

◆ resolveHeader()

virtual void writerfilter::ooxml::OOXMLDocument::resolveHeader ( Stream rStream,
const sal_Int32  type,
const OUString &  rId 
)
pure virtual

Resolves a header to a stream handler.

Parameters
rStreamstream handler to resolve to
typetype of header to resolve: NS_ooxml::LN_Value_ST_HrdFtr_even header on even page NS_ooxml::LN_Value_ST_HrdFtr_default header on right page NS_ooxml::LN_Value_ST_HrdFtr_first header on first page
rIdid of the header

Implemented in writerfilter::ooxml::OOXMLDocumentImpl.

◆ resolvePicture()

virtual void writerfilter::ooxml::OOXMLDocument::resolvePicture ( Stream rStream,
const OUString &  rPictureId 
)
pure virtual

Resolves a picture to a stream handler.

Parameters
rStreamstream handler to resolve to
rPictureIdid of the picture to resolve

Implemented in writerfilter::ooxml::OOXMLDocumentImpl.

◆ setDrawPage()

virtual void writerfilter::ooxml::OOXMLDocument::setDrawPage ( css::uno::Reference< css::drawing::XDrawPage >  xDrawPage)
pure virtual

◆ setModel()

virtual void writerfilter::ooxml::OOXMLDocument::setModel ( css::uno::Reference< css::frame::XModel >  xModel)
pure virtual

◆ setShapeContext()

virtual void writerfilter::ooxml::OOXMLDocument::setShapeContext ( rtl::Reference< oox::shape::ShapeContextHandler xContext)
pure virtual

◆ setXNoteId()

virtual void writerfilter::ooxml::OOXMLDocument::setXNoteId ( const sal_Int32  nId)
pure virtual

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