LibreOffice Module xmloff (master) 1
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
XMLEventsImportContext Class Reference

Import <script:events> element. More...

#include <XMLEventsImportContext.hxx>

Inheritance diagram for XMLEventsImportContext:
[legend]
Collaboration diagram for XMLEventsImportContext:
[legend]

Public Member Functions

 XMLEventsImportContext (SvXMLImport &rImport)
 
 XMLEventsImportContext (SvXMLImport &rImport, const css::uno::Reference< css::document::XEventsSupplier > &xEventsSupplier)
 
 XMLEventsImportContext (SvXMLImport &rImport, const css::uno::Reference< css::container::XNameReplace > &xNameRepl)
 
virtual ~XMLEventsImportContext () override
 
void AddEventValues (const OUString &rEventName, const css::uno::Sequence< css::beans::PropertyValue > &rValues)
 
void SetEvents (const css::uno::Reference< css::document::XEventsSupplier > &xEventsSupplier)
 if the import operates in delayed mode, you can use this method to set all events that have been read on the XEventsSupplier More...
 
void SetEvents (const css::uno::Reference< css::container::XNameReplace > &xNameRepl)
 if the import operates in delayed mode, you can use this method to set all events that have been read on the XNameReplace More...
 
void GetEventSequence (const OUString &rName, css::uno::Sequence< css::beans::PropertyValue > &rSequence)
 if the import operates in delayed mode, you can use this method to obtain the value sequence for a specific event More...
 
- Public Member Functions inherited from SvXMLImportContext
 SvXMLImportContext (SvXMLImport &rImport)
 A contexts constructor does anything that is required if an element starts. More...
 
virtual ~SvXMLImportContext ()
 A contexts destructor does anything that is required if an element ends. More...
 
virtual void SAL_CALL startFastElement (sal_Int32 Element, const css::uno::Reference< css::xml::sax::XFastAttributeList > &Attribs) override
 
virtual void SAL_CALL startUnknownElement (const OUString &Namespace, const OUString &Name, const css::uno::Reference< css::xml::sax::XFastAttributeList > &Attribs) override
 
virtual void SAL_CALL endFastElement (sal_Int32 Element) override
 endFastElement is called before a context will be destructed, but after an elements context has been parsed. More...
 
virtual void SAL_CALL endUnknownElement (const OUString &Namespace, const OUString &Name) override
 
virtual css::uno::Reference< XFastContextHandler > SAL_CALL createFastChildContext (sal_Int32 Element, const css::uno::Reference< css::xml::sax::XFastAttributeList > &Attribs) override
 
virtual css::uno::Reference< css::xml::sax::XFastContextHandler > SAL_CALL createUnknownChildContext (const OUString &Namespace, const OUString &Name, const css::uno::Reference< css::xml::sax::XFastAttributeList > &Attribs) override
 
virtual void SAL_CALL characters (const OUString &aChars) override
 This method is called for all characters that are contained in the current element. More...
 
virtual css::uno::Any SAL_CALL queryInterface (const css::uno::Type &aType) final override
 
virtual void SAL_CALL acquire () noexcept final override
 
virtual void SAL_CALL release () noexcept final override
 
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes () final override
 
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId () final override
 

Protected Member Functions

virtual css::uno::Reference< css::xml::sax::XFastContextHandler > SAL_CALL createFastChildContext (sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &AttrList) override
 
- Protected Member Functions inherited from SvXMLImportContext
SvXMLImportGetImport ()
 
const SvXMLImportGetImport () const
 

Protected Attributes

std::vector< EventNameValuesPairm_aCollectEvents
 

Private Attributes

css::uno::Reference< css::container::XNameReplace > m_xEvents
 

Detailed Description

Import <script:events> element.

The import context usually sets the events immediately at the event XNameReplace. If none was given on construction, it operates in delayed mode: All events are collected and may then be set with the setEvents() method.

Definition at line 51 of file XMLEventsImportContext.hxx.

Constructor & Destructor Documentation

◆ XMLEventsImportContext() [1/3]

XMLEventsImportContext::XMLEventsImportContext ( SvXMLImport rImport)

Definition at line 41 of file XMLEventsImportContext.cxx.

◆ XMLEventsImportContext() [2/3]

XMLEventsImportContext::XMLEventsImportContext ( SvXMLImport rImport,
const css::uno::Reference< css::document::XEventsSupplier > &  xEventsSupplier 
)

◆ XMLEventsImportContext() [3/3]

XMLEventsImportContext::XMLEventsImportContext ( SvXMLImport rImport,
const css::uno::Reference< css::container::XNameReplace > &  xNameRepl 
)

◆ ~XMLEventsImportContext()

XMLEventsImportContext::~XMLEventsImportContext ( )
overridevirtual

Definition at line 64 of file XMLEventsImportContext.cxx.

Member Function Documentation

◆ AddEventValues()

void XMLEventsImportContext::AddEventValues ( const OUString &  rEventName,
const css::uno::Sequence< css::beans::PropertyValue > &  rValues 
)

◆ createFastChildContext()

css::uno::Reference< css::xml::sax::XFastContextHandler > XMLEventsImportContext::createFastChildContext ( sal_Int32  nElement,
const css::uno::Reference< css::xml::sax::XFastAttributeList > &  AttrList 
)
overrideprotectedvirtual

◆ GetEventSequence()

void XMLEventsImportContext::GetEventSequence ( const OUString &  rName,
css::uno::Sequence< css::beans::PropertyValue > &  rSequence 
)

if the import operates in delayed mode, you can use this method to obtain the value sequence for a specific event

Definition at line 130 of file XMLEventsImportContext.cxx.

References m_aCollectEvents.

Referenced by XMLMacroFieldImportContext::PrepareField().

◆ SetEvents() [1/2]

void XMLEventsImportContext::SetEvents ( const css::uno::Reference< css::container::XNameReplace > &  xNameRepl)

if the import operates in delayed mode, you can use this method to set all events that have been read on the XNameReplace

◆ SetEvents() [2/2]

void XMLEventsImportContext::SetEvents ( const css::uno::Reference< css::document::XEventsSupplier > &  xEventsSupplier)

if the import operates in delayed mode, you can use this method to set all events that have been read on the XEventsSupplier

Referenced by XMLTextImportHelper::SetHyperlink().

Member Data Documentation

◆ m_aCollectEvents

std::vector< EventNameValuesPair > XMLEventsImportContext::m_aCollectEvents
protected

◆ m_xEvents

css::uno::Reference<css::container::XNameReplace> XMLEventsImportContext::m_xEvents
private

Definition at line 54 of file XMLEventsImportContext.hxx.

Referenced by AddEventValues().


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