Helper class for handling xml elements representing a form control. More...

#include <elementexport.hxx>

Inheritance diagram for xmloff::OControlExport:

Collaboration diagram for xmloff::OControlExport:

Public Member Functions
	OControlExport (IFormsExportContext &_rContext, const css::uno::Reference< css::beans::XPropertySet > &_rxControl, OUString _sControlId, OUString _sReferringControls, const css::uno::Sequence< css::script::ScriptEventDescriptor > &_rxEvents)
	constructs an object capable of exporting controls More...

Public Member Functions inherited from xmloff::OElementExport
	OElementExport (IFormsExportContext &_rContext, const css::uno::Reference< css::beans::XPropertySet > &_rxProps, const css::uno::Sequence< css::script::ScriptEventDescriptor > &_rEvents)

virtual	~OElementExport ()

void	doExport ()

Public Member Functions inherited from xmloff::OPropertyExport
	OPropertyExport (IFormsExportContext &_rContext, const css::uno::Reference< css::beans::XPropertySet > &_rxProps)
	constructs an object capable of handling attributes for export More...

template<typename T >
void	exportRemainingPropertiesSequence (Any const &value, token::XMLTokenEnum eValueAttName)

Protected Types
typedef o3tl::sorted_vector< sal_Int16 >	Int16Set

Protected Member Functions
virtual void	implStartElement (const char *_pName) override
	start the XML element More...

virtual void	implEndElement () override
	ends the XML element More...

virtual const char *	getOuterXMLElementName () const
	get the name of the outer XML element More...

virtual const char *	getXMLElementName () const override
	get the name of the XML element More...

virtual void	examine () override
	examine the control. More...

void	exportOuterAttributes ()
	exports the attributes for the outer element More...

void	exportInnerAttributes ()
	exports the attributes for the inner element More...

virtual void	exportAttributes () override
	export the attributes More...

void	exportSubTags () override
	writes everything which needs to be represented as sub tag More...

void	exportGenericHandlerAttributes ()
	adds the attributes which are handled via generic IPropertyHandlers More...

void	exportCommonControlAttributes ()
	adds common control attributes to the XMLExport context given More...

void	exportDatabaseAttributes ()
	adds database attributes to the XMLExport context given More...

void	exportBindingAttributes ()
	adds the XML attributes which are related to binding controls to external values and/or list sources More...

void	exportSpecialAttributes ()
	adds attributes which are special to a control type to the export context's attribute list More...

void	exportListSourceAsAttribute ()
	exports the ListSource property of a control as attribute More...

void	exportListSourceAsElements ()
	exports the ListSource property of a control as XML elements More...

void	getSequenceInt16PropertyAsSet (const OUString &_rPropertyName, Int16Set &_rOut)
	gets a Sequence< sal_Int16 > property value as set of sal_Int16's More...

void	exportCellBindingAttributes (bool _bIncludeListLinkageType)
	exports the attribute which descrives a cell value binding of a control in a spreadsheet document More...

void	exportXFormsBindAttributes ()
	exports the attribute(s) which bind this control to XForms More...

void	exportXFormsListAttributes ()
	exports the attribute(s) which bind the list of a list control to XForms More...

void	exportXFormsSubmissionAttributes ()
	exports the attribute(s) for an XForms submission More...

void	exportCellListSourceRange ()
	exports the attribute which descrives a cell range which acts as list source for a list-like control More...

void	exportImagePositionAttributes ()
	exports the attribute(s) for the ImagePosition property More...

bool	controlHasActiveDataBinding () const
	determines whether the control we're exporting has an active data binding. More...

OUString	getScalarListSourceValue () const
	retrieves the string specifying the ListSource of a list or combo box More...

bool	controlHasUserSuppliedListEntries () const
	determines whether the list entries (of a combo or list box) are supplied by the user More...

Protected Member Functions inherited from xmloff::OControlElement
	OControlElement ()
	ctor. More...

Protected Member Functions inherited from xmloff::OValuePropertiesMetaData
	OValuePropertiesMetaData ()

Protected Member Functions inherited from xmloff::OElementExport
virtual const char *	getXMLElementName () const =0
	get the name of the XML element More...

virtual void	examine ()
	examine the element we're exporting More...

virtual void	exportAttributes ()
	export the attributes More...

virtual void	exportSubTags ()
	export any sub tags More...

void	exportEvents ()
	exports the events (as script:events tag) More...

virtual void	exportServiceNameAttribute ()
	add the service-name attribute to the export context More...

virtual void	implStartElement (const char *_pName)
	start the XML element More...

virtual void	implEndElement ()
	ends the XML element More...

Protected Member Functions inherited from xmloff::OPropertyExport
void	examinePersistence ()
	examines a property set given for all properties which's value are to made persistent More...

template<typename T >
void	exportRemainingPropertiesSequence (css::uno::Any const &value, token::XMLTokenEnum eValueAttName)

void	exportRemainingProperties ()

void	exportedProperty (const OUString &_rPropertyName)
	indicates that a property has been handled by a derived class, without using the helper methods of this class. More...

void	exportStringPropertyAttribute (const sal_uInt16 _nNamespaceKey, const OUString &_pAttributeName, const OUString &_rPropertyName)
	add an attribute which is represented by a string property to the export context More...

void	exportBooleanPropertyAttribute (const sal_uInt16 _nNamespaceKey, const OUString &_pAttributeName, const OUString &_rPropertyName, const BoolAttrFlags _nBooleanAttributeFlags)
	add an attribute which is represented by a boolean property to the export context More...

void	exportInt16PropertyAttribute (const sal_uInt16 _nNamespaceKey, const OUString &_pAttributeName, const OUString &_rPropertyName, const sal_Int16 _nDefault, const bool force=false)
	add an attribute which is represented by a sal_Int16 property to the export context More...

void	exportInt32PropertyAttribute (const sal_uInt16 _nNamespaceKey, const OUString &_pAttributeName, const OUString &_rPropertyName, const sal_Int32 _nDefault)
	add an attribute which is represented by a sal_Int32 property to the export context More...

template<typename EnumT >
void	exportEnumPropertyAttribute (const sal_uInt16 _nNamespaceKey, const OUString &_pAttributeName, const OUString &_rPropertyName, const SvXMLEnumMapEntry< EnumT > *_pValueMap, const EnumT _nDefault, const bool _bVoidDefault=false)
	add an attribute which is represented by an enum property to the export context More...

void	exportEnumPropertyAttributeImpl (const sal_uInt16 _nNamespaceKey, const OUString &_pAttributeName, const OUString &_rPropertyName, const SvXMLEnumMapEntry< sal_uInt16 > *_pValueMap, const sal_uInt16 _nDefault, const bool _bVoidDefault)

void	exportTargetFrameAttribute ()
	add the hlink:target-frame attribute to the export context. More...

void	exportTargetLocationAttribute (bool _bAddType)
	add the form:href attribute to the export context. More...

void	exportImageDataAttribute ()
	add the form:image attribute to the export context. More...

void	flagStyleProperties ()
	flag the style properties as 'already exported' More...

void	exportGenericPropertyAttribute (const sal_uInt16 _nAttributeNamespaceKey, const OUString &_pAttributeName, const OUString &_pPropertyName)
	add an arbitrary attribute extracted from an arbitrary property to the export context More...

void	exportStringSequenceAttribute (const sal_uInt16 _nAttributeNamespaceKey, const OUString &_pAttributeName, const OUString &_rPropertyName)
	exports a property value, which is a string sequence, as attribute More...

bool	shouldExportProperty (const OUString &i_propertyName) const
	determines whether the given property is to be exported More...

OUString	implConvertAny (const css::uno::Any &_rValue)
	tries to convert an arbitrary <type scope="com.sun:star.uno">Any</type> into an string More...

void	AddAttribute (sal_uInt16 _nPrefix, const OUString &_rName, const OUString &_rValue)

void	AddAttribute (sal_uInt16 _nPrefix, ::xmloff::token::XMLTokenEnum _eName, const OUString &_rValue)

void	AddAttribute (sal_uInt16 _nPrefix, ::xmloff::token::XMLTokenEnum _eName, ::xmloff::token::XMLTokenEnum _eValue)

void	dbg_implCheckProperty (const OUString &_rPropertyName, const css::uno::Type *_pType)
	check a given property set for the existence and type correctness of a given property More...

Protected Attributes
OUString	m_sControlId

OUString	m_sReferringControls

sal_Int16	m_nClassId

ElementType	m_eType

CCAFlags	m_nIncludeCommon

DAFlags	m_nIncludeDatabase

SCAFlags	m_nIncludeSpecial

EAFlags	m_nIncludeEvents

BAFlags	m_nIncludeBindings

std::unique_ptr< SvXMLElementExport >	m_pOuterElement

Protected Attributes inherited from xmloff::OPropertyExport
IFormsExportContext &	m_rContext

const css::uno::Reference< css::beans::XPropertySet >	m_xProps

const css::uno::Reference< css::beans::XPropertySetInfo >	m_xPropertyInfo

const css::uno::Reference< css::beans::XPropertyState >	m_xPropertyState

OUString	m_sValueTrue

OUString	m_sValueFalse

Additional Inherited Members
Public Types inherited from xmloff::OControlElement
enum	ElementType { TEXT = 0 , TEXT_AREA , PASSWORD , FILE , FORMATTED_TEXT , FIXED_TEXT , COMBOBOX , LISTBOX , BUTTON , IMAGE , CHECKBOX , RADIO , FRAME , IMAGE_FRAME , HIDDEN , GRID , VALUERANGE , GENERIC_CONTROL , TIME , DATE , UNKNOWN }

Static Public Member Functions inherited from xmloff::OControlElement
static const char *	getElementName (ElementType _eType)
	retrieves the tag name to be used to describe a control of the given type More...

static sal_Int32	getElementToken (ElementType _eType)
	retrieves the tag name to be used to describe a control of the given type More...

Static Public Member Functions inherited from xmloff::OValuePropertiesMetaData
static void	getValuePropertyNames (OControlElement::ElementType _eType, sal_Int16 _nFormComponentType, OUString &_rpCurrentValuePropertyName, OUString &_rpValuePropertyName)
	calculate the property names for the current-value and the value attribute. More...

static void	getValueLimitPropertyNames (sal_Int16 _nFormComponentType, OUString &_rpMinValuePropertyName, OUString &_rpMaxValuePropertyName)
	calculate the property names for the min-value and the max-value attribute. More...

static void	getRuntimeValuePropertyNames (OControlElement::ElementType _eType, sal_Int16 _nFormComponentType, OUString &_rpValuePropertyName, OUString &_rpDefaultValuePropertyName)
	calculate the names of the properties which, at runtime, are used for value and default value. More...

Static Protected Member Functions inherited from xmloff::OPropertyExport
::xmloff::token::XMLTokenEnum	implGetPropertyXMLType (const css::uno::Type &_rType)

Detailed Description

Helper class for handling xml elements representing a form control.

Definition at line 83 of file elementexport.hxx.

Member Typedef Documentation

◆ Int16Set

typedef o3tl::sorted_vector<sal_Int16> xmloff::OControlExport::Int16Set

protected

Definition at line 89 of file elementexport.hxx.

Constructor & Destructor Documentation

◆ OControlExport()

xmloff::OControlExport::OControlExport	(	IFormsExportContext &	_rContext,
		const css::uno::Reference< css::beans::XPropertySet > &	_rxControl,
		OUString	_sControlId,
		OUString	_sReferringControls,
		const css::uno::Sequence< css::script::ScriptEventDescriptor > &	_rxEvents
	)

constructs an object capable of exporting controls

You need at least two pre-requisites from outside: The control to be exported needs to have a class id assigned, and you need the list control-ids of all the controls referring to this one as LabelControl.
This information can't be collected when known only the control itself and not it's complete context.

Parameters

_rControlId	the control id to use when exporting the control
_rReferringControls	the comma-separated list of control-ids of all the controls referring to this one as LabelControl

Definition at line 229 of file elementexport.cxx.

References CONTROL, m_eType, xmloff::OPropertyExport::m_xProps, NONE, and UNKNOWN.

Member Function Documentation

◆ controlHasActiveDataBinding()

bool xmloff::OControlExport::controlHasActiveDataBinding ( ) const

protected

determines whether the control we're exporting has an active data binding.

Bindings which count here are:

an established connection to a database field
a binding to an external value supplier (<type scope="css::form::binding">XValueBinding</type>)

Definition at line 1861 of file elementexport.cxx.

References Exception, xmloff::OPropertyExport::m_xPropertyInfo, xmloff::OPropertyExport::m_xProps, and TOOLS_WARN_EXCEPTION.

Referenced by exportCommonControlAttributes().

◆ controlHasUserSuppliedListEntries()

bool xmloff::OControlExport::controlHasUserSuppliedListEntries ( ) const

protected

determines whether the list entries (of a combo or list box) are supplied by the user

List entries may be

specified by the user
specified by an external list source (<type scope="css::form::binding">XListEntrySource</type>)
obtained from a database query (in various ways)

In the latter two cases, this method will return <FALSE>

Definition at line 1888 of file elementexport.cxx.

References DBG_UNHANDLED_EXCEPTION, Exception, getScalarListSourceValue(), xmloff::OPropertyExport::m_xPropertyInfo, xmloff::OPropertyExport::m_xProps, and xmloff::PROPERTY_LISTSOURCETYPE.

Referenced by exportSubTags().

◆ examine()

void xmloff::OControlExport::examine ( )

overrideprotectedvirtual

examine the control.

Some kind of CtorImpl.

Reimplemented from xmloff::OElementExport.

Reimplemented in xmloff::OColumnExport.

Definition at line 1403 of file elementexport.cxx.

Referenced by xmloff::OColumnExport::examine().

◆ exportAttributes()

void xmloff::OControlExport::exportAttributes ( )

overrideprotectedvirtual

export the attributes

Reimplemented from xmloff::OElementExport.

Reimplemented in xmloff::OColumnExport.

Definition at line 306 of file elementexport.cxx.

References exportOuterAttributes().

Referenced by xmloff::OColumnExport::exportAttributes().

◆ exportBindingAttributes()

void xmloff::OControlExport::exportBindingAttributes ( )

protected

adds the XML attributes which are related to binding controls to external values and/or list sources

Definition at line 867 of file elementexport.cxx.

References exportCellBindingAttributes(), exportCellListSourceRange(), exportXFormsBindAttributes(), exportXFormsListAttributes(), exportXFormsSubmissionAttributes(), LinkedCell, ListCellRange, ListLinkingType, m_nIncludeBindings, NONE, XFormsBind, XFormsListBind, and XFormsSubmission.

Referenced by exportInnerAttributes().

◆ exportCellBindingAttributes()

void xmloff::OControlExport::exportCellBindingAttributes ( bool _bIncludeListLinkageType )

protected

exports the attribute which descrives a cell value binding of a control in a spreadsheet document

Definition at line 1732 of file elementexport.cxx.

References xmloff::OPropertyExport::AddAttribute(), aHelper, xmloff::aListLinkageMap, SvXMLUnitConverter::convertEnum(), Exception, xmloff::OAttributeMetaData::getBindingAttributeName(), xmloff::OAttributeMetaData::getBindingAttributeNamespace(), xmloff::FormCellBindingHelper::isCellIntegerBinding(), LinkedCell, ListLinkingType, xmloff::OPropertyExport::m_xProps, and TOOLS_WARN_EXCEPTION.

Referenced by exportBindingAttributes().

◆ exportCellListSourceRange()

void xmloff::OControlExport::exportCellListSourceRange ( )

protected

exports the attribute which descrives a cell range which acts as list source for a list-like control

Definition at line 1788 of file elementexport.cxx.

References xmloff::OPropertyExport::AddAttribute(), aHelper, Exception, xmloff::OAttributeMetaData::getBindingAttributeName(), xmloff::OAttributeMetaData::getBindingAttributeNamespace(), ListCellRange, xmloff::OPropertyExport::m_xProps, TOOLS_WARN_EXCEPTION, and xSink.

Referenced by exportBindingAttributes().

◆ exportCommonControlAttributes()

void xmloff::OControlExport::exportCommonControlAttributes ( )

protected

adds common control attributes to the XMLExport context given

The attribute list of the context is not cleared initially, this is the responsibility of the caller.

Definition at line 488 of file elementexport.cxx.

Referenced by exportInnerAttributes().

◆ exportDatabaseAttributes()

void xmloff::OControlExport::exportDatabaseAttributes ( )

protected

adds database attributes to the XMLExport context given

The attribute list of the context is not cleared initially, this is the responsibility of the caller.

Definition at line 789 of file elementexport.cxx.

References xmloff::aListSourceTypeMap, BoundColumn, ConvertEmpty, DataField, DefaultFalse, DefaultVoid, xmloff::OPropertyExport::exportBooleanPropertyAttribute(), xmloff::OPropertyExport::exportEnumPropertyAttribute(), xmloff::OPropertyExport::exportInt16PropertyAttribute(), exportListSourceAsAttribute(), xmloff::OPropertyExport::exportStringPropertyAttribute(), xmloff::OAttributeMetaData::getDatabaseAttributeName(), xmloff::OAttributeMetaData::getDatabaseAttributeNamespace(), InputRequired, ListSource, ListSource_TYPE, m_nIncludeDatabase, NONE, xmloff::PROPERTY_BOUNDCOLUMN, xmloff::PROPERTY_DATAFIELD, xmloff::PROPERTY_EMPTY_IS_NULL, xmloff::PROPERTY_INPUT_REQUIRED, xmloff::PROPERTY_LISTSOURCETYPE, and RESET_BIT.

Referenced by exportInnerAttributes().

◆ exportGenericHandlerAttributes()

void xmloff::OControlExport::exportGenericHandlerAttributes ( )

protected

adds the attributes which are handled via generic IPropertyHandlers

In the future, this really should be all attributes, instead of this shitload of hand-crafted code we have currently...

Definition at line 439 of file elementexport.cxx.

References xmloff::OPropertyExport::AddAttribute(), Any, aProperties, xmloff::PropertyDescription::attribute, xmloff::AttributeDescription::attributeToken, DBG_UNHANDLED_EXCEPTION, Exception, xmloff::OPropertyExport::exportedProperty(), xmloff::PropertyDescription::factory, xmloff::metadata::getPropertyDescription(), xmloff::token::GetXMLToken(), xmloff::OPropertyExport::m_xPropertyInfo, xmloff::OPropertyExport::m_xProps, xmloff::AttributeDescription::namespacePrefix, xmloff::PropertyDescription::propertyId, SAL_WARN, and xmloff::OPropertyExport::shouldExportProperty().

Referenced by exportInnerAttributes().

◆ exportImagePositionAttributes()

void xmloff::OControlExport::exportImagePositionAttributes ( )

protected

exports the attribute(s) for the ImagePosition property

Definition at line 1814 of file elementexport.cxx.

References xmloff::OPropertyExport::AddAttribute(), DBG_UNHANDLED_EXCEPTION, Exception, xmloff::OPropertyExport::exportedProperty(), xmloff::token::GetXMLToken(), xmloff::OPropertyExport::m_xProps, xmloff::PROPERTY_IMAGE_ALIGN, xmloff::PROPERTY_IMAGE_POSITION, xmloff::token::XML_BOTTOM, xmloff::token::XML_CENTER, xmloff::token::XML_END, xmloff::token::XML_IMAGE_ALIGN, xmloff::token::XML_IMAGE_POSITION, XML_NAMESPACE_FORM, xmloff::token::XML_START, and xmloff::token::XML_TOP.

Referenced by exportSpecialAttributes().

◆ exportInnerAttributes()

void xmloff::OControlExport::exportInnerAttributes ( )

protected

exports the attributes for the inner element

Definition at line 273 of file elementexport.cxx.

References SvXMLExport::AddAttributeIdLegacy(), ControlId, exportBindingAttributes(), exportCommonControlAttributes(), exportDatabaseAttributes(), exportGenericHandlerAttributes(), exportSpecialAttributes(), xmloff::OPropertyExport::flagStyleProperties(), xmloff::IFormsExportContext::getGlobalContext(), m_nIncludeCommon, xmloff::OPropertyExport::m_rContext, m_sControlId, and XML_NAMESPACE_FORM.

Referenced by implStartElement().

◆ exportListSourceAsAttribute()

void xmloff::OControlExport::exportListSourceAsAttribute ( )

protected

exports the ListSource property of a control as attribute

The ListSource property may be exported in different ways: For a ComboBox, it is an attribute of the form:combobox element.

For a ListBox, it's an attribute if the ListSourceType states that the ListBox does not display a value list. In case of a value list, the ListSource is not exported, and the pairs of StringItem/ValueItem are exported as sub-elements.

This method does the attribute part: It exports the ListSource property as attribute, not caring about whether the object is a ComboBox or a ListBox.

Definition at line 1216 of file elementexport.cxx.

References xmloff::OPropertyExport::AddAttribute(), DBG_CHECK_PROPERTY_NO_TYPE, xmloff::OPropertyExport::exportedProperty(), xmloff::OAttributeMetaData::getDatabaseAttributeName(), xmloff::OAttributeMetaData::getDatabaseAttributeNamespace(), getScalarListSourceValue(), ListSource, and xmloff::PROPERTY_LISTSOURCE.

Referenced by exportDatabaseAttributes().