LibreOffice Module comphelper (master) 1
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
comphelper::MasterPropertySet Class Referenceabstract

#include <MasterPropertySet.hxx>

Inheritance diagram for comphelper::MasterPropertySet:
[legend]
Collaboration diagram for comphelper::MasterPropertySet:
[legend]

Public Member Functions

 MasterPropertySet (comphelper::MasterPropertySetInfo *pInfo, SolarMutex *pMutex) noexcept
 
virtual ~MasterPropertySet () noexcept
 
void registerSlave (ChainablePropertySet *pNewSet) noexcept
 
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo () override
 
virtual void SAL_CALL setPropertyValue (const OUString &aPropertyName, const css::uno::Any &aValue) override
 
virtual css::uno::Any SAL_CALL getPropertyValue (const OUString &PropertyName) override
 
virtual void SAL_CALL addPropertyChangeListener (const OUString &aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &xListener) override
 
virtual void SAL_CALL removePropertyChangeListener (const OUString &aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &aListener) override
 
virtual void SAL_CALL addVetoableChangeListener (const OUString &PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &aListener) override
 
virtual void SAL_CALL removeVetoableChangeListener (const OUString &PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &aListener) override
 
virtual void SAL_CALL setPropertyValues (const css::uno::Sequence< OUString > &aPropertyNames, const css::uno::Sequence< css::uno::Any > &aValues) override
 
virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPropertyValues (const css::uno::Sequence< OUString > &aPropertyNames) override
 
virtual void SAL_CALL addPropertiesChangeListener (const css::uno::Sequence< OUString > &aPropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener > &xListener) override
 
virtual void SAL_CALL removePropertiesChangeListener (const css::uno::Reference< css::beans::XPropertiesChangeListener > &xListener) override
 
virtual void SAL_CALL firePropertiesChangeEvent (const css::uno::Sequence< OUString > &aPropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener > &xListener) override
 
virtual css::beans::PropertyState SAL_CALL getPropertyState (const OUString &PropertyName) override
 
virtual css::uno::Sequence< css::beans::PropertyState > SAL_CALL getPropertyStates (const css::uno::Sequence< OUString > &aPropertyName) override
 
virtual void SAL_CALL setPropertyToDefault (const OUString &PropertyName) override
 
virtual css::uno::Any SAL_CALL getPropertyDefault (const OUString &aPropertyName) override
 

Protected Member Functions

virtual void _preSetValues ()=0
 
virtual void _setSingleValue (const comphelper::PropertyInfo &rInfo, const css::uno::Any &rValue)=0
 
virtual void _postSetValues ()=0
 
virtual void _preGetValues ()=0
 
virtual void _getSingleValue (const comphelper::PropertyInfo &rInfo, css::uno::Any &rValue)=0
 
virtual void _postGetValues ()=0
 

Protected Attributes

SolarMutex *const mpMutex
 
sal_uInt8 mnLastId
 
std::map< sal_uInt8, comphelper::SlaveData * > maSlaveMap
 
rtl::Reference< MasterPropertySetInfo > mxInfo
 

Detailed Description

Definition at line 60 of file MasterPropertySet.hxx.

Constructor & Destructor Documentation

◆ MasterPropertySet()

MasterPropertySet::MasterPropertySet ( comphelper::MasterPropertySetInfo *  pInfo,
comphelper::SolarMutex *  pMutex 
)
noexcept

Definition at line 64 of file MasterPropertySet.cxx.

◆ ~MasterPropertySet()

MasterPropertySet::~MasterPropertySet ( )
virtualnoexcept

Definition at line 72 of file MasterPropertySet.cxx.

References maSlaveMap.

Member Function Documentation

◆ _getSingleValue()

virtual void comphelper::MasterPropertySet::_getSingleValue ( const comphelper::PropertyInfo &  rInfo,
css::uno::Any &  rValue 
)
protectedpure virtual
Exceptions
css::beans::UnknownPropertyException
css::lang::WrappedTargetException
css::uno::RuntimeException

Referenced by getPropertyValue(), and getPropertyValues().

◆ _postGetValues()

virtual void comphelper::MasterPropertySet::_postGetValues ( )
protectedpure virtual
Exceptions
css::beans::UnknownPropertyException
css::beans::PropertyVetoException
css::lang::IllegalArgumentException
css::lang::WrappedTargetException

Referenced by getPropertyValue().

◆ _postSetValues()

virtual void comphelper::MasterPropertySet::_postSetValues ( )
protectedpure virtual
Exceptions
css::beans::UnknownPropertyException
css::beans::PropertyVetoException
css::lang::IllegalArgumentException
css::lang::WrappedTargetException

Referenced by getPropertyValues(), setPropertyValue(), and setPropertyValues().

◆ _preGetValues()

virtual void comphelper::MasterPropertySet::_preGetValues ( )
protectedpure virtual
Exceptions
css::beans::UnknownPropertyException
css::beans::PropertyVetoException
css::lang::IllegalArgumentException
css::lang::WrappedTargetException

Referenced by getPropertyValue(), and getPropertyValues().

◆ _preSetValues()

virtual void comphelper::MasterPropertySet::_preSetValues ( )
protectedpure virtual
Exceptions
css::beans::UnknownPropertyException
css::beans::PropertyVetoException
css::lang::IllegalArgumentException
css::lang::WrappedTargetException

Referenced by setPropertyValue(), and setPropertyValues().

◆ _setSingleValue()

virtual void comphelper::MasterPropertySet::_setSingleValue ( const comphelper::PropertyInfo &  rInfo,
const css::uno::Any &  rValue 
)
protectedpure virtual
Exceptions
css::beans::UnknownPropertyException
css::beans::PropertyVetoException
css::lang::IllegalArgumentException
css::lang::WrappedTargetException
css::uno::RuntimeException

Referenced by setPropertyValue(), and setPropertyValues().

◆ addPropertiesChangeListener()

void SAL_CALL MasterPropertySet::addPropertiesChangeListener ( const css::uno::Sequence< OUString > &  aPropertyNames,
const css::uno::Reference< css::beans::XPropertiesChangeListener > &  xListener 
)
overridevirtual

Definition at line 307 of file MasterPropertySet.cxx.

◆ addPropertyChangeListener()

void SAL_CALL MasterPropertySet::addPropertyChangeListener ( const OUString &  aPropertyName,
const css::uno::Reference< css::beans::XPropertyChangeListener > &  xListener 
)
overridevirtual

Definition at line 160 of file MasterPropertySet.cxx.

◆ addVetoableChangeListener()

void SAL_CALL MasterPropertySet::addVetoableChangeListener ( const OUString &  PropertyName,
const css::uno::Reference< css::beans::XVetoableChangeListener > &  aListener 
)
overridevirtual

Definition at line 170 of file MasterPropertySet.cxx.

◆ firePropertiesChangeEvent()

void SAL_CALL MasterPropertySet::firePropertiesChangeEvent ( const css::uno::Sequence< OUString > &  aPropertyNames,
const css::uno::Reference< css::beans::XPropertiesChangeListener > &  xListener 
)
overridevirtual

Definition at line 317 of file MasterPropertySet.cxx.

◆ getPropertyDefault()

Any SAL_CALL MasterPropertySet::getPropertyDefault ( const OUString &  aPropertyName)
overridevirtual

Definition at line 389 of file MasterPropertySet.cxx.

References Any, mxInfo, and XPropertySet.

◆ getPropertySetInfo()

Reference< XPropertySetInfo > SAL_CALL MasterPropertySet::getPropertySetInfo ( )
overridevirtual

Definition at line 80 of file MasterPropertySet.cxx.

References mxInfo.

◆ getPropertyState()

PropertyState SAL_CALL MasterPropertySet::getPropertyState ( const OUString &  PropertyName)
overridevirtual

Definition at line 323 of file MasterPropertySet.cxx.

References maSlaveMap, comphelper::ChainablePropertySet::mpMutex, mxInfo, and XPropertySet.

◆ getPropertyStates()

Sequence< PropertyState > SAL_CALL MasterPropertySet::getPropertyStates ( const css::uno::Sequence< OUString > &  aPropertyName)
overridevirtual

Definition at line 343 of file MasterPropertySet.cxx.

References i, comphelper::SlaveData::IsInit(), maSlaveMap, mxInfo, nCount, comphelper::SlaveData::SetInit(), and XPropertySet.

◆ getPropertyValue()

Any SAL_CALL MasterPropertySet::getPropertyValue ( const OUString &  PropertyName)
overridevirtual

Definition at line 125 of file MasterPropertySet.cxx.

References comphelper::ChainablePropertySet::_getSingleValue(), _getSingleValue(), comphelper::ChainablePropertySet::_postGetValues(), _postGetValues(), comphelper::ChainablePropertySet::_preGetValues(), _preGetValues(), Any, maSlaveMap, comphelper::ChainablePropertySet::mpMutex, mpMutex, mxInfo, and XPropertySet.

◆ getPropertyValues()

Sequence< Any > SAL_CALL MasterPropertySet::getPropertyValues ( const css::uno::Sequence< OUString > &  aPropertyNames)
overridevirtual

! have a unique_ptr to an array of OGuards in order to have the ! allocated memory properly freed (exception safe!). ! Since the array itself has unique_ptrs as members we have to use a ! helper class 'AutoOGuardArray' in order to have ! the acquired locks properly released.

Definition at line 244 of file MasterPropertySet.cxx.

References _getSingleValue(), _postSetValues(), _preGetValues(), Any, i, comphelper::SlaveData::IsInit(), maSlaveMap, mpMutex, mxInfo, comphelper::SlaveData::mxSlave, nCount, comphelper::SlaveData::SetInit(), and XPropertySet.

◆ registerSlave()

void MasterPropertySet::registerSlave ( ChainablePropertySet *  pNewSet)
noexcept

Definition at line 85 of file MasterPropertySet.cxx.

◆ removePropertiesChangeListener()

void SAL_CALL MasterPropertySet::removePropertiesChangeListener ( const css::uno::Reference< css::beans::XPropertiesChangeListener > &  xListener)
overridevirtual

Definition at line 312 of file MasterPropertySet.cxx.

◆ removePropertyChangeListener()

void SAL_CALL MasterPropertySet::removePropertyChangeListener ( const OUString &  aPropertyName,
const css::uno::Reference< css::beans::XPropertyChangeListener > &  aListener 
)
overridevirtual

Definition at line 165 of file MasterPropertySet.cxx.

◆ removeVetoableChangeListener()

void SAL_CALL MasterPropertySet::removeVetoableChangeListener ( const OUString &  PropertyName,
const css::uno::Reference< css::beans::XVetoableChangeListener > &  aListener 
)
overridevirtual

Definition at line 175 of file MasterPropertySet.cxx.

◆ setPropertyToDefault()

void SAL_CALL MasterPropertySet::setPropertyToDefault ( const OUString &  PropertyName)
overridevirtual

Definition at line 381 of file MasterPropertySet.cxx.

References mxInfo, and XPropertySet.

◆ setPropertyValue()

void SAL_CALL MasterPropertySet::setPropertyValue ( const OUString &  aPropertyName,
const css::uno::Any &  aValue 
)
overridevirtual

Definition at line 92 of file MasterPropertySet.cxx.

References comphelper::ChainablePropertySet::_postSetValues(), _postSetValues(), comphelper::ChainablePropertySet::_preSetValues(), _preSetValues(), comphelper::ChainablePropertySet::_setSingleValue(), _setSingleValue(), maSlaveMap, comphelper::ChainablePropertySet::mpMutex, mpMutex, mxInfo, and XPropertySet.

◆ setPropertyValues()

void SAL_CALL MasterPropertySet::setPropertyValues ( const css::uno::Sequence< OUString > &  aPropertyNames,
const css::uno::Sequence< css::uno::Any > &  aValues 
)
overridevirtual

! have a unique_ptr to an array of OGuards in order to have the ! allocated memory properly freed (exception safe!). ! Since the array itself has unique_ptrs as members we have to use a ! helper class 'AutoOGuardArray' in order to have ! the acquired locks properly released.

Definition at line 181 of file MasterPropertySet.cxx.

References _postSetValues(), _preSetValues(), _setSingleValue(), Any, i, comphelper::SlaveData::IsInit(), maSlaveMap, mpMutex, mxInfo, comphelper::SlaveData::mxSlave, nCount, comphelper::SlaveData::SetInit(), and XPropertySet.

Member Data Documentation

◆ maSlaveMap

std::map< sal_uInt8, comphelper::SlaveData* > comphelper::MasterPropertySet::maSlaveMap
protected

Definition at line 67 of file MasterPropertySet.hxx.

Referenced by getPropertyState(), getPropertyStates(), getPropertyValue(), getPropertyValues(), setPropertyValue(), setPropertyValues(), and ~MasterPropertySet().

◆ mnLastId

sal_uInt8 comphelper::MasterPropertySet::mnLastId
protected

Definition at line 66 of file MasterPropertySet.hxx.

◆ mpMutex

SolarMutex* const comphelper::MasterPropertySet::mpMutex
protected

Definition at line 65 of file MasterPropertySet.hxx.

Referenced by getPropertyValue(), getPropertyValues(), setPropertyValue(), and setPropertyValues().

◆ mxInfo

rtl::Reference< MasterPropertySetInfo > comphelper::MasterPropertySet::mxInfo
protected

Definition at line 68 of file MasterPropertySet.hxx.

Referenced by getPropertyDefault(), getPropertySetInfo(), getPropertyState(), getPropertyStates(), getPropertyValue(), getPropertyValues(), setPropertyToDefault(), setPropertyValue(), and setPropertyValues().

The documentation for this class was generated from the following files:
Generated on Wed Aug 17 2022 17:47:38 for LibreOffice Module comphelper (master) by doxygen 1.9.3