LibreOffice Module forms (master): frm::PropertyBagHelper Class Reference

LibreOffice Module forms (master) 1

#include <propertybaghelper.hxx>

Collaboration diagram for frm::PropertyBagHelper:

Public Member Functions
	PropertyBagHelper (IPropertyBagHelperContext &_rContext)

	~PropertyBagHelper ()

	PropertyBagHelper (const PropertyBagHelper &)=delete

PropertyBagHelper &	operator= (const PropertyBagHelper &)=delete

void	dispose ()

inline ::comphelper::OPropertyArrayAggregationHelper &	getInfoHelper () const

void	addProperty (const OUString &_rName, ::sal_Int16 _nAttributes, const css::uno::Any &_rInitialValue)

void	removeProperty (const OUString &_rName)

css::uno::Sequence< css::beans::PropertyValue >	getPropertyValues ()

void	setPropertyValues (const css::uno::Sequence< css::beans::PropertyValue > &_rProps)

void	getDynamicFastPropertyValue (sal_Int32 _nHandle, css::uno::Any &_out_rValue) const

bool	convertDynamicFastPropertyValue (sal_Int32 _nHandle, const css::uno::Any &_rNewValue, css::uno::Any &_out_rConvertedValue, css::uno::Any &_out_rCurrentValue) const

void	setDynamicFastPropertyValue (sal_Int32 _nHandle, const css::uno::Any &_rValue)

void	getDynamicPropertyDefaultByHandle (sal_Int32 _nHandle, css::uno::Any &_out_rValue) const

bool	hasDynamicPropertyByHandle (sal_Int32 _nHandle) const

Private Member Functions
void	impl_nts_checkDisposed_throw () const

void	impl_nts_invalidatePropertySetInfo ()
	invalidates our property set info, so subsequent calls to impl_ts_getArrayHelper and thus getInfoHelper will return a newly created instance More...

::comphelper::OPropertyArrayAggregationHelper &	impl_ts_getArrayHelper () const
	returns the IPropertyArrayHelper instance used by \|this\| More...

sal_Int32	impl_findFreeHandle (const OUString &_rPropertyName)
	finds a free property handle More...

Private Attributes
IPropertyBagHelperContext &	m_rContext

std::unique_ptr<::comphelper::OPropertyArrayAggregationHelper >	m_pPropertyArrayHelper

::comphelper::PropertyBag	m_aDynamicProperties

bool	m_bDisposed

Detailed Description

Definition at line 52 of file propertybaghelper.hxx.

Constructor & Destructor Documentation

◆ PropertyBagHelper() [1/2]

frm::PropertyBagHelper::PropertyBagHelper ( IPropertyBagHelperContext & _rContext )

Definition at line 72 of file propertybaghelper.cxx.

References m_bDisposed, and m_rContext.

◆ ~PropertyBagHelper()

frm::PropertyBagHelper::~PropertyBagHelper ( )

Definition at line 79 of file propertybaghelper.cxx.

◆ PropertyBagHelper() [2/2]

frm::PropertyBagHelper::PropertyBagHelper ( const PropertyBagHelper & )

delete

Member Function Documentation

◆ addProperty()

void frm::PropertyBagHelper::addProperty	(	const OUString &	_rName,
		::sal_Int16	_nAttributes,
		const css::uno::Any &	_rInitialValue
	)

Definition at line 176 of file propertybaghelper.cxx.

References frm::IPropertyBagHelperContext::getMutex(), frm::IPropertyBagHelperContext::getPropertiesInterface(), comphelper::OPropertyArrayAggregationHelper::hasPropertyByName(), impl_findFreeHandle(), impl_nts_checkDisposed_throw(), impl_nts_invalidatePropertySetInfo(), impl_ts_getArrayHelper(), m_aDynamicProperties, m_rContext, and nHandle.

Referenced by frm::ODatabaseForm::addProperty(), and frm::OControlModel::addProperty().

◆ convertDynamicFastPropertyValue()

bool frm::PropertyBagHelper::convertDynamicFastPropertyValue	(	sal_Int32	_nHandle,
		const css::uno::Any &	_rNewValue,
		css::uno::Any &	_out_rConvertedValue,
		css::uno::Any &	_out_rCurrentValue
	)		const

inline

Definition at line 121 of file propertybaghelper.hxx.

References m_aDynamicProperties.

Referenced by frm::ODatabaseForm::convertFastPropertyValue().

◆ dispose()

void frm::PropertyBagHelper::dispose ( void )

Definition at line 84 of file propertybaghelper.cxx.

References m_bDisposed.

Referenced by frm::ODatabaseForm::disposing(), and frm::OControlModel::disposing().

◆ getDynamicFastPropertyValue()

void frm::PropertyBagHelper::getDynamicFastPropertyValue	(	sal_Int32	_nHandle,
		css::uno::Any &	_out_rValue
	)		const

inline

Definition at line 115 of file propertybaghelper.hxx.

References m_aDynamicProperties.

◆ getDynamicPropertyDefaultByHandle()

void frm::PropertyBagHelper::getDynamicPropertyDefaultByHandle	(	sal_Int32	_nHandle,
		css::uno::Any &	_out_rValue
	)		const

inline

Definition at line 133 of file propertybaghelper.hxx.

References m_aDynamicProperties.

Referenced by frm::ODatabaseForm::getPropertyDefaultByHandle(), and frm::OControlModel::getPropertyDefaultByHandle().

◆ getInfoHelper()

comphelper::OPropertyArrayAggregationHelper & frm::PropertyBagHelper::getInfoHelper ( ) const

inline

Definition at line 109 of file propertybaghelper.hxx.

References impl_ts_getArrayHelper().

Referenced by frm::ODatabaseForm::getInfoHelper(), frm::OControlModel::getInfoHelper(), frm::OFormattedModel::getPropertyDefault(), and frm::OFormattedModel::setPropertyToDefault().

◆ getPropertyValues()

Sequence< PropertyValue > frm::PropertyBagHelper::getPropertyValues ( )

Definition at line 251 of file propertybaghelper.cxx.

References Any, aProperties, aPropertyValues, DBG_UNHANDLED_EXCEPTION, Exception, frm::IPropertyBagHelperContext::getMutex(), frm::IPropertyBagHelperContext::getPropertiesInterface(), impl_nts_checkDisposed_throw(), m_rContext, and pName.

Referenced by frm::ODatabaseForm::getPropertyValues(), and frm::OControlModel::getPropertyValues().

◆ hasDynamicPropertyByHandle()

bool frm::PropertyBagHelper::hasDynamicPropertyByHandle ( sal_Int32 _nHandle ) const

inline

Definition at line 138 of file propertybaghelper.hxx.

References m_aDynamicProperties.

Referenced by frm::ODatabaseForm::convertFastPropertyValue(), frm::ODatabaseForm::getPropertyDefaultByHandle(), frm::OControlModel::getPropertyDefaultByHandle(), frm::ODatabaseForm::setFastPropertyValue_NoBroadcast(), and frm::OControlModel::setFastPropertyValue_NoBroadcast().

◆ impl_findFreeHandle()

sal_Int32 frm::PropertyBagHelper::impl_findFreeHandle ( const OUString & _rPropertyName )

private

finds a free property handle

Parameters

_rPropertyName the name of the property to find a handle for. If possible, the handle as determined by our ConcreteInfoService instance will be used

Definition at line 103 of file propertybaghelper.cxx.

References comphelper::OPropertyArrayAggregationHelper::fillPropertyMembersByHandle(), impl_ts_getArrayHelper(), NEW_HANDLE_BASE, and nHandle.

Referenced by addProperty().

◆ impl_nts_checkDisposed_throw()

void frm::PropertyBagHelper::impl_nts_checkDisposed_throw ( ) const

private

Definition at line 90 of file propertybaghelper.cxx.

References m_bDisposed.

Referenced by addProperty(), getPropertyValues(), removeProperty(), and setPropertyValues().

◆ impl_nts_invalidatePropertySetInfo()

void frm::PropertyBagHelper::impl_nts_invalidatePropertySetInfo ( )

private

invalidates our property set info, so subsequent calls to impl_ts_getArrayHelper and thus getInfoHelper will return a newly created instance

Definition at line 97 of file propertybaghelper.cxx.

References m_pPropertyArrayHelper.

Referenced by addProperty(), and removeProperty().

◆ impl_ts_getArrayHelper()

comphelper::OPropertyArrayAggregationHelper & frm::PropertyBagHelper::impl_ts_getArrayHelper ( ) const

private

returns the IPropertyArrayHelper instance used by |this|

Definition at line 142 of file propertybaghelper.cxx.

References frm::IPropertyBagHelperContext::describeFixedAndAggregateProperties(), frm::IPropertyBagHelperContext::getMutex(), m_aDynamicProperties, m_pPropertyArrayHelper, m_rContext, NEW_HANDLE_BASE, and p.

Referenced by addProperty(), getInfoHelper(), impl_findFreeHandle(), and setPropertyValues().

◆ operator=()

PropertyBagHelper & frm::PropertyBagHelper::operator= ( const PropertyBagHelper & )

delete

◆ removeProperty()

void frm::PropertyBagHelper::removeProperty ( const OUString & _rName )

Definition at line 203 of file propertybaghelper.cxx.

References frm::IPropertyBagHelperContext::getMutex(), frm::IPropertyBagHelperContext::getPropertiesInterface(), impl_nts_checkDisposed_throw(), impl_nts_invalidatePropertySetInfo(), m_aDynamicProperties, m_rContext, and Property.

Referenced by frm::ODatabaseForm::removeProperty(), and frm::OControlModel::removeProperty().

◆ setDynamicFastPropertyValue()

void frm::PropertyBagHelper::setDynamicFastPropertyValue	(	sal_Int32	_nHandle,
		const css::uno::Any &	_rValue
	)

inline

Definition at line 127 of file propertybaghelper.hxx.

References m_aDynamicProperties.

Referenced by frm::ODatabaseForm::setFastPropertyValue_NoBroadcast(), and frm::OControlModel::setFastPropertyValue_NoBroadcast().

◆ setPropertyValues()

void frm::PropertyBagHelper::setPropertyValues ( const css::uno::Sequence< css::beans::PropertyValue > & _rProps )

Definition at line 293 of file propertybaghelper.cxx.

References frm::IPropertyBagHelperContext::getMutex(), frm::IPropertyBagHelperContext::getPropertiesInterface(), comphelper::OPropertyArrayAggregationHelper::hasPropertyByName(), impl_nts_checkDisposed_throw(), impl_ts_getArrayHelper(), and m_rContext.

Referenced by frm::ODatabaseForm::setPropertyValues(), and frm::OControlModel::setPropertyValues().

Member Data Documentation

◆ m_aDynamicProperties

::comphelper::PropertyBag frm::PropertyBagHelper::m_aDynamicProperties

private

Definition at line 58 of file propertybaghelper.hxx.

Referenced by addProperty(), convertDynamicFastPropertyValue(), getDynamicFastPropertyValue(), getDynamicPropertyDefaultByHandle(), hasDynamicPropertyByHandle(), impl_ts_getArrayHelper(), removeProperty(), and setDynamicFastPropertyValue().

◆ m_bDisposed

bool frm::PropertyBagHelper::m_bDisposed

private

Definition at line 59 of file propertybaghelper.hxx.

Referenced by dispose(), and impl_nts_checkDisposed_throw().

◆ m_pPropertyArrayHelper

std::unique_ptr<::comphelper::OPropertyArrayAggregationHelper> frm::PropertyBagHelper::m_pPropertyArrayHelper

private

Definition at line 57 of file propertybaghelper.hxx.

Referenced by impl_nts_invalidatePropertySetInfo(), and impl_ts_getArrayHelper().

◆ m_rContext

IPropertyBagHelperContext& frm::PropertyBagHelper::m_rContext

private

Definition at line 55 of file propertybaghelper.hxx.

Referenced by addProperty(), getPropertyValues(), impl_ts_getArrayHelper(), removeProperty(), and setPropertyValues().

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