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, sal_uInt16 nPrfx, const OUString &rLocalName)
 
 XMLEventsImportContext (SvXMLImport &rImport)
 
 XMLEventsImportContext (SvXMLImport &rImport, sal_uInt16 nPrfx, const OUString &rLocalName, const css::uno::Reference< css::document::XEventsSupplier > &xEventsSupplier)
 
 XMLEventsImportContext (SvXMLImport &rImport, const css::uno::Reference< css::document::XEventsSupplier > &xEventsSupplier)
 
 XMLEventsImportContext (SvXMLImport &rImport, sal_uInt16 nPrfx, const OUString &rLocalName, 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
bool IsPrefixFilledIn () const
 
sal_uInt16 GetPrefix () const
 
const OUString & GetLocalName () const
 
 SvXMLImportContext (SvXMLImport &rImport, sal_uInt16 nPrfx, const OUString &rLName)
 A contexts constructor does anything that is required if an element starts. More...
 
 SvXMLImportContext (SvXMLImport &rImport)
 
virtual ~SvXMLImportContext ()
 A contexts destructor does anything that is required if an element ends. More...
 
virtual void Characters (const OUString &rChars)
 This method is called for all characters that are contained in the current element. More...
 
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 endUnknownElement (const OUString &Namespace, const OUString &Name) 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
 
virtual css::uno::Any SAL_CALL queryInterface (const css::uno::Type &aType) final override
 
virtual void SAL_CALL acquire () final override throw ()
 
virtual void SAL_CALL release () final override throw ()
 
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 void StartElement (const css::uno::Reference< css::xml::sax::XAttributeList > &xAttrList) override
 StartElement is called after a context has been constructed and before an elements context is parsed. More...
 
virtual void EndElement () override
 EndElement is called before a context will be destructed, but after an elements context has been parsed. More...
 
virtual SvXMLImportContextRef CreateChildContext (sal_uInt16 nPrefix, const OUString &rLocalName, const css::uno::Reference< css::xml::sax::XAttributeList > &xAttrList) override
 Create a children element context. More...
 
virtual void SAL_CALL startFastElement (sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &) override
 
virtual void SAL_CALL endFastElement (sal_Int32 nElement) override
 
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< EventNameValuesPairaCollectEvents
 

Private Attributes

css::uno::Reference< css::container::XNameReplace > 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::XMLEventsImportContext ( SvXMLImport rImport,
sal_uInt16  nPrfx,
const OUString &  rLocalName 
)

Definition at line 42 of file XMLEventsImportContext.cxx.

XMLEventsImportContext::XMLEventsImportContext ( SvXMLImport rImport)

Definition at line 50 of file XMLEventsImportContext.cxx.

XMLEventsImportContext::XMLEventsImportContext ( SvXMLImport rImport,
sal_uInt16  nPrfx,
const OUString &  rLocalName,
const css::uno::Reference< css::document::XEventsSupplier > &  xEventsSupplier 
)
XMLEventsImportContext::XMLEventsImportContext ( SvXMLImport rImport,
const css::uno::Reference< css::document::XEventsSupplier > &  xEventsSupplier 
)
XMLEventsImportContext::XMLEventsImportContext ( SvXMLImport rImport,
sal_uInt16  nPrfx,
const OUString &  rLocalName,
const css::uno::Reference< css::container::XNameReplace > &  xNameRepl 
)
XMLEventsImportContext::~XMLEventsImportContext ( )
overridevirtual

Definition at line 85 of file XMLEventsImportContext.cxx.

Member Function Documentation

void XMLEventsImportContext::AddEventValues ( const OUString &  rEventName,
const css::uno::Sequence< css::beans::PropertyValue > &  rValues 
)
SvXMLImportContextRef XMLEventsImportContext::CreateChildContext ( sal_uInt16  nPrefix,
const OUString &  rLocalName,
const css::uno::Reference< css::xml::sax::XAttributeList > &  xAttrList 
)
overrideprotectedvirtual

Create a children element context.

By default, the import's CreateContext method is called to create a new default context.

Reimplemented from SvXMLImportContext.

Definition at line 103 of file XMLEventsImportContext.cxx.

References XMLEventImportHelper::CreateContext(), SvXMLImport::GetEventImport(), SvXMLImportContext::GetImport(), SvXMLImport::GetNamespaceMap(), xmloff::token::IsXMLToken(), nCount, xmloff::token::XML_EVENT_NAME, xmloff::token::XML_LANGUAGE, and XML_NAMESPACE_SCRIPT.

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

EndElement is called before a context will be destructed, but after an elements context has been parsed.

It may be used for actions that require virtual methods. The default is to do nothing.

Reimplemented from SvXMLImportContext.

Reimplemented in xmloff::OFormEventsImportContext.

Definition at line 98 of file XMLEventsImportContext.cxx.

Referenced by xmloff::OFormEventsImportContext::EndElement().

void XMLEventsImportContext::endFastElement ( sal_Int32  nElement)
overrideprotectedvirtual

Reimplemented from SvXMLImportContext.

Definition at line 150 of file XMLEventsImportContext.cxx.

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 227 of file XMLEventsImportContext.cxx.

References aCollectEvents.

Referenced by XMLMacroFieldImportContext::PrepareField().

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().

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

void XMLEventsImportContext::StartElement ( const css::uno::Reference< css::xml::sax::XAttributeList > &  xAttrList)
overrideprotectedvirtual

StartElement is called after a context has been constructed and before an elements context is parsed.

It may be used for actions that require virtual methods. The default is to do nothing.

Reimplemented from SvXMLImportContext.

Definition at line 92 of file XMLEventsImportContext.cxx.

void XMLEventsImportContext::startFastElement ( sal_Int32  nElement,
const css::uno::Reference< css::xml::sax::XFastAttributeList > &   
)
overrideprotectedvirtual

Reimplemented from SvXMLImportContext.

Definition at line 144 of file XMLEventsImportContext.cxx.

Member Data Documentation

std::vector< EventNameValuesPair > XMLEventsImportContext::aCollectEvents
protected
css::uno::Reference<css::container::XNameReplace> XMLEventsImportContext::xEvents
private

Definition at line 54 of file XMLEventsImportContext.hxx.

Referenced by AddEventValues().


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