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

helper class importing a single <form:form> element More...

#include <elementimport.hxx>

Inheritance diagram for xmloff::OFormImport:
[legend]
Collaboration diagram for xmloff::OFormImport:
[legend]

Public Member Functions

 OFormImport (OFormLayerXMLImport_Impl &_rImport, IEventAttacherManager &_rEventManager, const css::uno::Reference< css::container::XNameContainer > &_rxParentContainer)
 
- Public Member Functions inherited from xmloff::OElementImport
 OElementImport (OFormLayerXMLImport_Impl &_rImport, IEventAttacherManager &_rEventManager, const css::uno::Reference< css::container::XNameContainer > &_rxParentContainer)
 ctor More...
 
virtual ~OElementImport () override
 
- Public Member Functions inherited from xmloff::OPropertyImport
 OPropertyImport (OFormLayerXMLImport_Impl &_rImport)
 
virtual css::uno::Reference< css::xml::sax::XFastContextHandler > SAL_CALL createFastChildContext (sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &AttrList) override
 
virtual void SAL_CALL startFastElement (sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &_rxAttrList) override
 
virtual void SAL_CALL characters (const OUString &_rChars) override
 This method is called for all characters that are contained in the current element. 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
 
virtual void registerEvents (const css::uno::Sequence< css::script::ScriptEventDescriptor > &_rEvents)=0
 
- Public Member Functions inherited from xmloff::ODefaultEventAttacherManager
virtual void registerEvents (const css::uno::Reference< css::beans::XPropertySet > &_rxElement, const css::uno::Sequence< css::script::ScriptEventDescriptor > &_rEvents) override
 
virtual void registerEvents (const css::uno::Reference< css::beans::XPropertySet > &_rxElement, const css::uno::Sequence< css::script::ScriptEventDescriptor > &_rEvents)=0
 

Private Member Functions

virtual void SAL_CALL startFastElement (sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &xAttrList) override
 
virtual void SAL_CALL endFastElement (sal_Int32 nElement) override
 endFastElement is called before a context will be destructed, but after an elements context has been parsed. More...
 
virtual css::uno::Reference< css::xml::sax::XFastContextHandler > SAL_CALL createFastChildContext (sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &AttrList) override
 
virtual bool handleAttribute (sal_Int32 nElement, const OUString &_rValue) override
 handle one single attribute. More...
 
virtual css::uno::Reference< css::beans::XPropertySetcreateElement () override
 create the (uninitialized) element which is to represent the read data More...
 
virtual OUString determineDefaultServiceName () const override
 
void implTranslateStringListProperty (const OUString &_rPropertyName, const OUString &_rValue)
 

Private Attributes

css::uno::Reference< css::container::XNameContainer > m_xMeAsContainer
 

Additional Inherited Members

- Protected Types inherited from xmloff::OPropertyImport
typedef ::std::vector< css::beans::PropertyValue > PropertyValueArray
 
- Protected Member Functions inherited from xmloff::OElementImport
virtual void SAL_CALL startFastElement (sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &xAttrList) override
 
virtual void SAL_CALL endFastElement (sal_Int32 nElement) override
 endFastElement is called before a context will be destructed, but after an elements context has been parsed. More...
 
virtual css::uno::Reference< css::xml::sax::XFastContextHandler > SAL_CALL createFastChildContext (sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &AttrList) override
 
virtual bool handleAttribute (sal_Int32 nElement, const OUString &_rValue) override
 handle one single attribute. More...
 
virtual void registerEvents (const css::uno::Sequence< css::script::ScriptEventDescriptor > &_rEvents) override
 
virtual css::uno::Reference< css::beans::XPropertySetcreateElement ()
 create the (uninitialized) element which is to represent the read data More...
 
void simulateDefaultedAttribute (sal_Int32 nElement, const OUString &_rPropertyName, const char *_pAttributeDefault)
 can be used to handle properties where the attribute default and the property default differ. More...
 
bool tryGenericAttribute (sal_Int32 nElement, const OUString &_rValue)
 to be called from within handleAttribute, checks whether the given attribute is covered by our generic attribute handler mechanisms More...
 
void disableImplicitGenericAttributeHandling ()
 controls whether |handleAttribute| implicitly calls |tryGenericAttribute|, or whether the derived class must do this explicitly at a suitable place in its own |handleAttribute| More...
 
- Protected Member Functions inherited from xmloff::OPropertyImport
virtual bool handleAttribute (sal_Int32 nElement, const OUString &_rValue)
 handle one single attribute. More...
 
bool encounteredAttribute (sal_Int32 nElement) const
 determine if the element imported by the object had a given attribute. More...
 
void enableTrackAttributes ()
 enables the tracking of the encountered attributes More...
 
void implPushBackPropertyValue (const css::beans::PropertyValue &_rProp)
 
void implPushBackPropertyValue (const OUString &_rName, const css::uno::Any &_rValue)
 
void implPushBackGenericPropertyValue (const css::beans::PropertyValue &_rProp)
 
- Protected Member Functions inherited from SvXMLImportContext
SvXMLImportGetImport ()
 
const SvXMLImportGetImport () const
 
- Protected Member Functions inherited from xmloff::IEventAttacher
 ~IEventAttacher ()
 
- Protected Member Functions inherited from xmloff::ODefaultEventAttacherManager
void setEvents (const css::uno::Reference< css::container::XIndexAccess > &_rxContainer)
 
virtual ~ODefaultEventAttacherManager ()
 
- Protected Member Functions inherited from xmloff::IEventAttacherManager
 ~IEventAttacherManager ()
 
- Protected Attributes inherited from xmloff::OElementImport
OUString m_sServiceName
 
OUString m_sName
 
OFormLayerXMLImport_Implm_rFormImport
 
IEventAttacherManagerm_rEventManager
 
const XMLTextStyleContextm_pStyleElement
 
css::uno::Reference< css::container::XNameContainer > m_xParentContainer
 the parent container to insert the new element into More...
 
css::uno::Reference< css::beans::XPropertySetm_xElement
 the element we're creating. Valid after StartElement More...
 
css::uno::Reference< css::beans::XPropertySetInfo > m_xInfo
 
bool m_bImplicitGenericAttributeHandling
 
- Protected Attributes inherited from xmloff::OPropertyImport
PropertyValueArray m_aValues
 
PropertyValueArray m_aGenericValues
 
o3tl::sorted_vector< sal_Int32 > m_aEncounteredAttributes
 
OFormLayerXMLImport_Implm_rContext
 
bool m_bTrackAttributes
 

Detailed Description

helper class importing a single <form:form> element

Definition at line 604 of file elementimport.hxx.

Constructor & Destructor Documentation

◆ OFormImport()

xmloff::OFormImport::OFormImport ( OFormLayerXMLImport_Impl _rImport,
IEventAttacherManager _rEventManager,
const css::uno::Reference< css::container::XNameContainer > &  _rxParentContainer 
)

Member Function Documentation

◆ createElement()

css::uno::Reference< css::beans::XPropertySet > xmloff::OFormImport::createElement ( )
overrideprivatevirtual

create the (uninitialized) element which is to represent the read data

The default implementation uses <member>m_xORB</member> to create an object with <member>m_sServiceName</member>.

Reimplemented from xmloff::OElementImport.

Definition at line 1943 of file elementimport.cxx.

References xmloff::OElementImport::createElement(), and m_xMeAsContainer.

◆ createFastChildContext()

css::uno::Reference< css::xml::sax::XFastContextHandler > xmloff::OFormImport::createFastChildContext ( sal_Int32  nElement,
const css::uno::Reference< css::xml::sax::XFastAttributeList > &  AttrList 
)
overrideprivatevirtual

◆ determineDefaultServiceName()

OUString xmloff::OFormImport::determineDefaultServiceName ( ) const
overrideprivatevirtual

Reimplemented from xmloff::OElementImport.

Definition at line 2066 of file elementimport.cxx.

◆ endFastElement()

void xmloff::OFormImport::endFastElement ( sal_Int32  Element)
overrideprivatevirtual

endFastElement 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 xmloff::OElementImport.

Definition at line 1931 of file elementimport.cxx.

References xmloff::OElementImport::endFastElement(), xmloff::OFormLayerXMLImport_Impl::leaveEventContext(), xmloff::OElementImport::m_rFormImport, m_xMeAsContainer, and xmloff::ODefaultEventAttacherManager::setEvents().

◆ handleAttribute()

bool xmloff::OFormImport::handleAttribute ( sal_Int32  nElement,
const OUString &  _rValue 
)
overrideprivatevirtual

handle one single attribute.

This is called for every attribute of the element. This class' implementation checks if the attribute describes a property, if so, it is added to <member>m_aValues</member>.

All non-property attributes should be handled in derived classes.

Parameters
_nNamespaceKeykey of the namespace used in the attribute
_rLocalNamelocal (relative to the namespace) attribute name
_rValueattribute value

Reimplemented from xmloff::OElementImport.

Definition at line 1961 of file elementimport.cxx.

References xmloff::faDetailFields, xmloff::faMasterFields, xmloff::OAttributeMetaData::getFormAttributeToken(), xmloff::OElementImport::handleAttribute(), implTranslateStringListProperty(), xmloff::PROPERTY_DETAILFIELDS, xmloff::PROPERTY_MASTERFIELDS, and TOKEN_MASK.

◆ implTranslateStringListProperty()

void xmloff::OFormImport::implTranslateStringListProperty ( const OUString &  _rPropertyName,
const OUString &  _rValue 
)
private

◆ startFastElement()

void xmloff::OFormImport::startFastElement ( sal_Int32  nElement,
const css::uno::Reference< css::xml::sax::XFastAttributeList > &  xAttrList 
)
overrideprivatevirtual

Member Data Documentation

◆ m_xMeAsContainer

css::uno::Reference< css::container::XNameContainer > xmloff::OFormImport::m_xMeAsContainer
private

Definition at line 632 of file elementimport.hxx.

Referenced by createElement(), createFastChildContext(), and endFastElement().


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