implements an <type>XPropertyHandler</type> which composes its information from a set of other property handlers More...

#include <propertycomposer.hxx>

Inheritance diagram for pcr::PropertyComposer:

[legend]

Collaboration diagram for pcr::PropertyComposer:

[legend]

Classes
class	MethodGuard

Public Types
typedef std::vector< css::uno::Reference< css::inspection::XPropertyHandler > >	HandlerArray

Public Member Functions
	PropertyComposer (std::vector< css::uno::Reference< css::inspection::XPropertyHandler > > &&_rSlaveHandlers)
	constructs an <type>XPropertyHandler</type> which composes its information from a set of other property handlers More...

virtual void SAL_CALL	inspect (const css::uno::Reference< css::uno::XInterface > &_rxIntrospectee) override

virtual css::uno::Any SAL_CALL	getPropertyValue (const OUString &_rPropertyName) override

virtual void SAL_CALL	setPropertyValue (const OUString &_rPropertyName, const css::uno::Any &_rValue) override

virtual css::uno::Any SAL_CALL	convertToPropertyValue (const OUString &_rPropertyName, const css::uno::Any &_rControlValue) override

virtual css::uno::Any SAL_CALL	convertToControlValue (const OUString &_rPropertyName, const css::uno::Any &_rPropertyValue, const css::uno::Type &_rControlValueType) override

virtual css::beans::PropertyState SAL_CALL	getPropertyState (const OUString &_rPropertyName) override

virtual void SAL_CALL	addPropertyChangeListener (const css::uno::Reference< css::beans::XPropertyChangeListener > &_rxListener) override

virtual void SAL_CALL	removePropertyChangeListener (const css::uno::Reference< css::beans::XPropertyChangeListener > &_rxListener) override

virtual css::uno::Sequence< css::beans::Property > SAL_CALL	getSupportedProperties () override

virtual css::uno::Sequence< OUString > SAL_CALL	getSupersededProperties () override

virtual css::uno::Sequence< OUString > SAL_CALL	getActuatingProperties () override

virtual css::inspection::LineDescriptor SAL_CALL	describePropertyLine (const OUString &_rPropertyName, const css::uno::Reference< css::inspection::XPropertyControlFactory > &_rxControlFactory) override

virtual sal_Bool SAL_CALL	isComposable (const OUString &_rPropertyName) override

virtual css::inspection::InteractiveSelectionResult SAL_CALL	onInteractivePropertySelection (const OUString &_rPropertyName, sal_Bool _bPrimary, css::uno::Any &_rData, const css::uno::Reference< css::inspection::XObjectInspectorUI > &_rxInspectorUI) override

virtual void SAL_CALL	actuatingPropertyChanged (const OUString &_rActuatingPropertyName, const css::uno::Any &_rNewValue, const css::uno::Any &_rOldValue, const css::uno::Reference< css::inspection::XObjectInspectorUI > &_rxInspectorUI, sal_Bool _bFirstTimeInit) override

virtual sal_Bool SAL_CALL	suspend (sal_Bool _bSuspend) override

virtual void SAL_CALL	disposing () override

virtual void SAL_CALL	propertyChange (const css::beans::PropertyChangeEvent &evt) override

virtual void SAL_CALL	disposing (const css::lang::EventObject &Source) override

virtual bool	hasPropertyByName (const OUString &_rName) override

virtual bool	hasPropertyByName (const OUString &_rName)=0

Private Member Functions
void	impl_ensureUIRequestComposer (const css::uno::Reference< css::inspection::XObjectInspectorUI > &_rxInspectorUI)
	ensures that m_pUIRequestComposer exists More...

bool	impl_isSupportedProperty_nothrow (const OUString &_rPropertyName)
	checks whether a given property exists in <member>m_aSupportedProperties</member> More...

Private Attributes
HandlerArray	m_aSlaveHandlers

std::unique_ptr< ComposedPropertyUIUpdate >	m_pUIRequestComposer

PropertyChangeListeners	m_aPropertyListeners

bool	m_bSupportedPropertiesAreKnown

PropertyBag	m_aSupportedProperties

Friends
class	MethodGuard

Additional Inherited Members
Protected Member Functions inherited from pcr::IPropertyExistenceCheck
	~IPropertyExistenceCheck ()

Protected Attributes inherited from cppu::BaseMutex
mutable::osl::Mutex	m_aMutex

Detailed Description

implements an <type>XPropertyHandler</type> which composes its information from a set of other property handlers

Definition at line 48 of file propertycomposer.hxx.

Member Typedef Documentation

◆ HandlerArray

typedef std::vector< css::uno::Reference< css::inspection::XPropertyHandler > > pcr::PropertyComposer::HandlerArray

Definition at line 54 of file propertycomposer.hxx.

Constructor & Destructor Documentation

◆ PropertyComposer()

pcr::PropertyComposer::PropertyComposer ( std::vector< css::uno::Reference< css::inspection::XPropertyHandler > > && _rSlaveHandlers )

explicit

constructs an <type>XPropertyHandler</type> which composes its information from a set of other property handlers

Parameters

_rSlaveHandlers the set of slave handlers to invoke. Must not be <NULL>

Definition at line 86 of file propertycomposer.cxx.

References m_aSlaveHandlers, and m_refCount.

Member Function Documentation

◆ actuatingPropertyChanged()

void SAL_CALL pcr::PropertyComposer::actuatingPropertyChanged	(	const OUString &	_rActuatingPropertyName,
		const css::uno::Any &	_rNewValue,
		const css::uno::Any &	_rOldValue,
		const css::uno::Reference< css::inspection::XObjectInspectorUI > &	_rxInspectorUI,
		sal_Bool	_bFirstTimeInit
	)

overridevirtual

Definition at line 369 of file propertycomposer.cxx.

References impl_ensureUIRequestComposer(), m_aSlaveHandlers, and m_pUIRequestComposer.

◆ addPropertyChangeListener()

void SAL_CALL pcr::PropertyComposer::addPropertyChangeListener ( const css::uno::Reference< css::beans::XPropertyChangeListener > & _rxListener )

overridevirtual

Definition at line 187 of file propertycomposer.cxx.

References comphelper::OInterfaceContainerHelper3< class ListenerT >::addInterface(), and m_aPropertyListeners.

◆ convertToControlValue()

Any SAL_CALL pcr::PropertyComposer::convertToControlValue	(	const OUString &	_rPropertyName,
		const css::uno::Any &	_rPropertyValue,
		const css::uno::Type &	_rControlValueType
	)

overridevirtual

Definition at line 141 of file propertycomposer.cxx.

References Any, and m_aSlaveHandlers.

◆ convertToPropertyValue()

Any SAL_CALL pcr::PropertyComposer::convertToPropertyValue	(	const OUString &	_rPropertyName,
		const css::uno::Any &	_rControlValue
	)

overridevirtual

Definition at line 134 of file propertycomposer.cxx.

References Any, and m_aSlaveHandlers.

◆ describePropertyLine()

LineDescriptor SAL_CALL pcr::PropertyComposer::describePropertyLine	(	const OUString &	_rPropertyName,
		const css::uno::Reference< css::inspection::XPropertyControlFactory > &	_rxControlFactory
	)

overridevirtual

Definition at line 291 of file propertycomposer.cxx.

References m_aSlaveHandlers.

◆ disposing() [1/2]

void SAL_CALL pcr::PropertyComposer::disposing ( )

overridevirtual

Definition at line 402 of file propertycomposer.cxx.

References pcr::clearContainer().

◆ disposing() [2/2]

virtual void SAL_CALL pcr::PropertyComposer::disposing ( const css::lang::EventObject & Source )

overridevirtual

◆ getActuatingProperties()

Sequence< OUString > SAL_CALL pcr::PropertyComposer::getActuatingProperties ( )

overridevirtual

Definition at line 280 of file propertycomposer.cxx.

References m_aSlaveHandlers, and pcr::uniteStringArrays().

◆ getPropertyState()

PropertyState SAL_CALL pcr::PropertyComposer::getPropertyState ( const OUString & _rPropertyName )

overridevirtual

Definition at line 148 of file propertycomposer.cxx.

References Any, and m_aSlaveHandlers.

◆ getPropertyValue()

Any SAL_CALL pcr::PropertyComposer::getPropertyValue ( const OUString & _rPropertyName )

overridevirtual

Definition at line 120 of file propertycomposer.cxx.

References Any, and m_aSlaveHandlers.

Referenced by propertyChange().

◆ getSupersededProperties()

Sequence< OUString > SAL_CALL pcr::PropertyComposer::getSupersededProperties ( )

overridevirtual

Definition at line 269 of file propertycomposer.cxx.

References m_aSlaveHandlers, and pcr::uniteStringArrays().

◆ getSupportedProperties()

Sequence< Property > SAL_CALL pcr::PropertyComposer::getSupportedProperties ( )

overridevirtual

Definition at line 201 of file propertycomposer.cxx.

References check(), comphelper::containerToSequence(), isComposable(), m_aSlaveHandlers, m_aSupportedProperties, and m_bSupportedPropertiesAreKnown.

◆ hasPropertyByName()

bool pcr::PropertyComposer::hasPropertyByName ( const OUString & _rName )

overridevirtual

Exceptions

css::uno::RuntimeException

Implements pcr::IPropertyExistenceCheck.

Definition at line 476 of file propertycomposer.cxx.

References impl_isSupportedProperty_nothrow().

◆ impl_ensureUIRequestComposer()

void pcr::PropertyComposer::impl_ensureUIRequestComposer ( const css::uno::Reference< css::inspection::XObjectInspectorUI > & _rxInspectorUI )

private

ensures that m_pUIRequestComposer exists

Definition at line 357 of file propertycomposer.cxx.

References m_pUIRequestComposer.

Referenced by actuatingPropertyChanged(), and onInteractivePropertySelection().

◆ impl_isSupportedProperty_nothrow()

bool pcr::PropertyComposer::impl_isSupportedProperty_nothrow ( const OUString & _rPropertyName )

inlineprivate

checks whether a given property exists in <member>m_aSupportedProperties</member>

Definition at line 117 of file propertycomposer.hxx.

References m_aSupportedProperties.

Referenced by hasPropertyByName(), and propertyChange().

◆ inspect()

void SAL_CALL pcr::PropertyComposer::inspect ( const css::uno::Reference< css::uno::XInterface > & _rxIntrospectee )

overridevirtual

Definition at line 109 of file propertycomposer.cxx.

References m_aSlaveHandlers.

◆ isComposable()

sal_Bool SAL_CALL pcr::PropertyComposer::isComposable ( const OUString & _rPropertyName )

overridevirtual

Definition at line 299 of file propertycomposer.cxx.

References m_aSlaveHandlers.

Referenced by getSupportedProperties().

◆ onInteractivePropertySelection()

InteractiveSelectionResult SAL_CALL pcr::PropertyComposer::onInteractivePropertySelection	(	const OUString &	_rPropertyName,
		sal_Bool	_bPrimary,
		css::uno::Any &	_rData,
		const css::uno::Reference< css::inspection::XObjectInspectorUI > &	_rxInspectorUI
	)

overridevirtual

Definition at line 306 of file propertycomposer.cxx.

References impl_ensureUIRequestComposer(), m_aSlaveHandlers, m_pUIRequestComposer, and onInteractivePropertySelection().

Referenced by onInteractivePropertySelection().

◆ propertyChange()

void SAL_CALL pcr::PropertyComposer::propertyChange ( const css::beans::PropertyChangeEvent & evt )

overridevirtual

Definition at line 421 of file propertycomposer.cxx.

References DBG_UNHANDLED_EXCEPTION, Exception, getPropertyValue(), impl_isSupportedProperty_nothrow(), m_aPropertyListeners, and comphelper::OInterfaceContainerHelper3< class ListenerT >::notifyEach().

◆ removePropertyChangeListener()

void SAL_CALL pcr::PropertyComposer::removePropertyChangeListener ( const css::uno::Reference< css::beans::XPropertyChangeListener > & _rxListener )

overridevirtual

Definition at line 194 of file propertycomposer.cxx.

References m_aPropertyListeners, and comphelper::OInterfaceContainerHelper3< class ListenerT >::removeInterface().

◆ setPropertyValue()

void SAL_CALL pcr::PropertyComposer::setPropertyValue	(	const OUString &	_rPropertyName,
		const css::uno::Any &	_rValue
	)

overridevirtual

Definition at line 127 of file propertycomposer.cxx.

References m_aSlaveHandlers, and SetPropertyValue().

◆ suspend()

sal_Bool SAL_CALL pcr::PropertyComposer::suspend ( sal_Bool _bSuspend )

overridevirtual

Definition at line 447 of file propertycomposer.cxx.

References m_aSlaveHandlers.

Friends And Related Function Documentation

◆ MethodGuard

friend class MethodGuard

friend

Definition at line 125 of file propertycomposer.hxx.

Member Data Documentation

◆ m_aPropertyListeners

PropertyChangeListeners pcr::PropertyComposer::m_aPropertyListeners

private

Definition at line 59 of file propertycomposer.hxx.

Referenced by addPropertyChangeListener(), propertyChange(), and removePropertyChangeListener().

◆ m_aSlaveHandlers

HandlerArray pcr::PropertyComposer::m_aSlaveHandlers

private

Definition at line 57 of file propertycomposer.hxx.

Referenced by actuatingPropertyChanged(), convertToControlValue(), convertToPropertyValue(), describePropertyLine(), getActuatingProperties(), getPropertyState(), getPropertyValue(), getSupersededProperties(), getSupportedProperties(), inspect(), isComposable(), pcr::PropertyComposer::MethodGuard::MethodGuard(), onInteractivePropertySelection(), PropertyComposer(), setPropertyValue(), and suspend().

◆ m_aSupportedProperties

PropertyBag pcr::PropertyComposer::m_aSupportedProperties

private

Definition at line 61 of file propertycomposer.hxx.

Referenced by getSupportedProperties(), and impl_isSupportedProperty_nothrow().

◆ m_bSupportedPropertiesAreKnown

bool pcr::PropertyComposer::m_bSupportedPropertiesAreKnown

private

Definition at line 60 of file propertycomposer.hxx.

Referenced by getSupportedProperties().

◆ m_pUIRequestComposer

std::unique_ptr< ComposedPropertyUIUpdate > pcr::PropertyComposer::m_pUIRequestComposer

private

Definition at line 58 of file propertycomposer.hxx.

Referenced by actuatingPropertyChanged(), impl_ensureUIRequestComposer(), and onInteractivePropertySelection().

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

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ HandlerArray

Constructor & Destructor Documentation

◆ PropertyComposer()

Member Function Documentation

◆ actuatingPropertyChanged()

◆ addPropertyChangeListener()

◆ convertToControlValue()

◆ convertToPropertyValue()

◆ describePropertyLine()

◆ disposing() [1/2]

◆ disposing() [2/2]

◆ getActuatingProperties()

◆ getPropertyState()

◆ getPropertyValue()

◆ getSupersededProperties()

◆ getSupportedProperties()

◆ hasPropertyByName()

◆ impl_ensureUIRequestComposer()

◆ impl_isSupportedProperty_nothrow()

◆ inspect()

◆ isComposable()

◆ onInteractivePropertySelection()

◆ propertyChange()

◆ removePropertyChangeListener()

◆ setPropertyValue()

◆ suspend()

Friends And Related Function Documentation

◆ MethodGuard

Member Data Documentation

◆ m_aPropertyListeners

◆ m_aSlaveHandlers

◆ m_aSupportedProperties

◆ m_bSupportedPropertiesAreKnown

◆ m_pUIRequestComposer