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, sal_uInt16 _nPrefix, const OUString &_rName, const css::uno::Reference< css::container::XNameContainer > &_rxParentContainer)
 
- Public Member Functions inherited from xmloff::OElementImport
 OElementImport (OFormLayerXMLImport_Impl &_rImport, IEventAttacherManager &_rEventManager, sal_uInt16 _nPrefix, const OUString &_rName, const css::uno::Reference< css::container::XNameContainer > &_rxParentContainer)
 ctor More...
 
virtual ~OElementImport () override
 
- Public Member Functions inherited from xmloff::OPropertyImport
 OPropertyImport (OFormLayerXMLImport_Impl &_rImport, sal_uInt16 _nPrefix, const OUString &_rName)
 
virtual void 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
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 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
 
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
 
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
 
- 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
 

Private Member Functions

virtual SvXMLImportContextRef CreateChildContext (sal_uInt16 _nPrefix, const OUString &_rLocalName, const css::uno::Reference< css::xml::sax::XAttributeList > &_rxAttrList) override
 Create a children element context. More...
 
virtual void StartElement (const css::uno::Reference< css::xml::sax::XAttributeList > &_rxAttrList) 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 bool handleAttribute (sal_uInt16 _nNamespaceKey, const OUString &_rLocalName, 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...
 
OControlImportimplCreateChildContext (sal_uInt16 _nPrefix, const OUString &_rLocalName, OControlElement::ElementType _eType)
 
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 registerEvents (const css::uno::Sequence< css::script::ScriptEventDescriptor > &_rEvents) override
 
void simulateDefaultedAttribute (const char *_pAttributeName, 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_uInt16 _nNamespaceKey, const OUString &_rLocalName, 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
bool encounteredAttribute (const OUString &_rAttributeName) 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
 
std::set< OUString > m_aEncounteredAttributes
 
OFormLayerXMLImport_Implm_rContext
 
bool m_bTrackAttributes
 

Detailed Description

helper class importing a single <form:form> element

Definition at line 627 of file elementimport.hxx.

Constructor & Destructor Documentation

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

Definition at line 1884 of file elementimport.cxx.

References xmloff::OPropertyImport::enableTrackAttributes().

Referenced by CreateChildContext().

Member Function Documentation

SvXMLImportContextRef xmloff::OFormImport::CreateChildContext ( sal_uInt16  nPrefix,
const OUString &  rLocalName,
const css::uno::Reference< css::xml::sax::XAttributeList > &  xAttrList 
)
overrideprivatevirtual
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 1930 of file elementimport.cxx.

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

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

Reimplemented from xmloff::OElementImport.

Definition at line 2107 of file elementimport.cxx.

void xmloff::OFormImport::EndElement ( )
overrideprivatevirtual

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

Definition at line 1918 of file elementimport.cxx.

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

bool xmloff::OFormImport::handleAttribute ( sal_uInt16  _nNamespaceKey,
const OUString &  _rLocalName,
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 1948 of file elementimport.cxx.

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

OControlImport * xmloff::OFormImport::implCreateChildContext ( sal_uInt16  _nPrefix,
const OUString &  _rLocalName,
OControlElement::ElementType  _eType 
)
private
void xmloff::OFormImport::implTranslateStringListProperty ( const OUString &  _rPropertyName,
const OUString &  _rValue 
)
private
void xmloff::OFormImport::StartElement ( const css::uno::Reference< css::xml::sax::XAttributeList > &  xAttrList)
overrideprivatevirtual

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

Definition at line 1909 of file elementimport.cxx.

References xmloff::OFormLayerXMLImport_Impl::enterEventContext(), xmloff::OAttributeMetaData::getCommonControlAttributeName(), xmloff::OElementImport::m_rFormImport, PROPERTY_TARGETFRAME, xmloff::OElementImport::simulateDefaultedAttribute(), xmloff::OElementImport::StartElement(), and TargetFrame.

Member Data Documentation

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

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