LibreOffice Module comphelper (master) 1
Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
comphelper::OPropertyContainer Class Reference

an OPropertySetHelper implementation which is just a simple container for properties represented by class members, usually in a derived class. More...

#include <propertycontainer.hxx>

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

Public Member Functions

virtual ~OPropertyContainer ()
 
- Public Member Functions inherited from cppu::OPropertySetHelper
 OPropertySetHelper (OBroadcastHelper &rBHelper)
 
 OPropertySetHelper (OBroadcastHelper &rBHelper, bool bIgnoreRuntimeExceptionsWhileFiring)
 
 OPropertySetHelper (OBroadcastHelper &rBHelper, IEventNotificationHook *i_pFireEvents, bool bIgnoreRuntimeExceptionsWhileFiring=false)
 
virtual css::uno::Any SAL_CALL queryInterface (const css::uno::Type &rType) SAL_OVERRIDE
 
css::uno::Sequence< css::uno::Type > getTypes ()
 
void SAL_CALL disposing ()
 
virtual void SAL_CALL setPropertyValue (const ::rtl::OUString &rPropertyName, const css::uno::Any &aValue) SAL_OVERRIDE
 
virtual css::uno::Any SAL_CALL getPropertyValue (const ::rtl::OUString &aPropertyName) SAL_OVERRIDE
 
virtual void SAL_CALL addPropertyChangeListener (const ::rtl::OUString &aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &aListener) SAL_OVERRIDE
 
virtual void SAL_CALL removePropertyChangeListener (const ::rtl::OUString &aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &aListener) SAL_OVERRIDE
 
virtual void SAL_CALL addVetoableChangeListener (const ::rtl::OUString &aPropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &aListener) SAL_OVERRIDE
 
virtual void SAL_CALL removeVetoableChangeListener (const ::rtl::OUString &aPropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &aListener) SAL_OVERRIDE
 
virtual void SAL_CALL setFastPropertyValue (sal_Int32 nHandle, const css::uno::Any &rValue) SAL_OVERRIDE
 
virtual css::uno::Any SAL_CALL getFastPropertyValue (sal_Int32 nHandle) SAL_OVERRIDE
 
virtual void SAL_CALL setPropertyValues (const css::uno::Sequence< ::rtl::OUString > &PropertyNames, const css::uno::Sequence< css::uno::Any > &Values) SAL_OVERRIDE
 
virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPropertyValues (const css::uno::Sequence< ::rtl::OUString > &PropertyNames) SAL_OVERRIDE
 
virtual void SAL_CALL addPropertiesChangeListener (const css::uno::Sequence< ::rtl::OUString > &PropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener > &Listener) SAL_OVERRIDE
 
virtual void SAL_CALL removePropertiesChangeListener (const css::uno::Reference< css::beans::XPropertiesChangeListener > &Listener) SAL_OVERRIDE
 
virtual void SAL_CALL firePropertiesChangeEvent (const css::uno::Sequence< ::rtl::OUString > &PropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener > &Listener) SAL_OVERRIDE
 

Protected Member Functions

 OPropertyContainer (::cppu::OBroadcastHelper &_rBHelper)
 
virtual sal_Bool SAL_CALL convertFastPropertyValue (css::uno::Any &rConvertedValue, css::uno::Any &rOldValue, sal_Int32 nHandle, const css::uno::Any &rValue) override
 
virtual void SAL_CALL setFastPropertyValue_NoBroadcast (sal_Int32 nHandle, const css::uno::Any &rValue) override
 
virtual void SAL_CALL getFastPropertyValue (css::uno::Any &rValue, sal_Int32 nHandle) const override
 
- Protected Member Functions inherited from cppu::OPropertySetHelper
void SAL_CALL fire (sal_Int32 *pnHandles, const css::uno::Any *pNewValues, const css::uno::Any *pOldValues, sal_Int32 nCount, sal_Bool bVetoable)
 
void SAL_CALL setFastPropertyValues (sal_Int32 nSeqLen, sal_Int32 *pHandles, const css::uno::Any *pValues, sal_Int32 nHitCount)
 
virtual IPropertyArrayHelper &SAL_CALL getInfoHelper ()=0
 
virtual sal_Bool SAL_CALL convertFastPropertyValue (css::uno::Any &rConvertedValue, css::uno::Any &rOldValue, sal_Int32 nHandle, const css::uno::Any &rValue)=0
 
virtual void SAL_CALL setFastPropertyValue_NoBroadcast (sal_Int32 nHandle, const css::uno::Any &rValue)=0
 
virtual void SAL_CALL getFastPropertyValue (css::uno::Any &rValue, sal_Int32 nHandle) const=0
 
void setDependentFastPropertyValue (sal_Int32 i_handle, const css::uno::Any &i_value)
 
 ~OPropertySetHelper ()
 
- Protected Member Functions inherited from comphelper::OPropertyContainerHelper
 OPropertyContainerHelper ()
 
 ~OPropertyContainerHelper ()
 
void registerProperty (const OUString &_rName, sal_Int32 _nHandle, sal_Int32 _nAttributes, void *_pPointerToMember, const css::uno::Type &_rMemberType)
 register a property. More...
 
void registerMayBeVoidProperty (const OUString &_rName, sal_Int32 _nHandle, sal_Int32 _nAttributes, css::uno::Any *_pPointerToMember, const css::uno::Type &_rExpectedType)
 register a property. More...
 
void registerPropertyNoMember (const OUString &_rName, sal_Int32 _nHandle, sal_Int32 _nAttributes, const css::uno::Type &_rType, css::uno::Any const &_pInitialValue)
 register a property. More...
 
void revokeProperty (sal_Int32 _nHandle)
 revokes a previously registered property More...
 
bool isRegisteredProperty (sal_Int32 _nHandle) const
 checks whether a property with the given handle has been registered More...
 
bool isRegisteredProperty (const OUString &_rName) const
 checks whether a property with the given name has been registered More...
 
bool convertFastPropertyValue (css::uno::Any &rConvertedValue, css::uno::Any &rOldValue, sal_Int32 nHandle, const css::uno::Any &rValue)
 
void setFastPropertyValue (sal_Int32 nHandle, const css::uno::Any &rValue)
 
void getFastPropertyValue (css::uno::Any &rValue, sal_Int32 nHandle) const
 
void describeProperties (css::uno::Sequence< css::beans::Property > &_rProps) const
 appends the descriptions of all properties which were registered 'til that moment to the given sequence, keeping the array sorted (by name) @precond the given sequence is already sorted by name More...
 
const css::beans::Property & getProperty (const OUString &_rName) const
 retrieves the description for a registered property More...
 

Static Protected Member Functions

static css::uno::Sequence< css::uno::Type > getBaseTypes ()
 for scripting : the types of the interfaces supported by this class More...
 

Additional Inherited Members

- Static Public Member Functions inherited from cppu::OPropertySetHelper
static css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL createPropertySetInfo (IPropertyArrayHelper &rProperties)
 
- Protected Attributes inherited from cppu::OPropertySetHelper
OBroadcastHelperrBHelper
 
OMultiTypeInterfaceContainerHelperInt32 aBoundLC
 
OMultiTypeInterfaceContainerHelperInt32 aVetoableLC
 
Impl *const m_pReserved
 

Detailed Description

an OPropertySetHelper implementation which is just a simple container for properties represented by class members, usually in a derived class.


A restriction of this class is that no value conversions are made on a setPropertyValue call. Though the base class supports this with the convertFastPropertyValue method, the OPropertyContainer accepts only values which already have the correct type, it's unable to convert, for instance, a long to a short.

Definition at line 42 of file propertycontainer.hxx.

Constructor & Destructor Documentation

◆ ~OPropertyContainer()

comphelper::OPropertyContainer::~OPropertyContainer ( )
virtual

Definition at line 38 of file propertycontainer.cxx.

◆ OPropertyContainer()

comphelper::OPropertyContainer::OPropertyContainer ( ::cppu::OBroadcastHelper _rBHelper)
protected

Definition at line 32 of file propertycontainer.cxx.

Member Function Documentation

◆ convertFastPropertyValue()

sal_Bool comphelper::OPropertyContainer::convertFastPropertyValue ( css::uno::Any &  rConvertedValue,
css::uno::Any &  rOldValue,
sal_Int32  nHandle,
const css::uno::Any &  rValue 
)
overrideprotectedvirtual

◆ getBaseTypes()

Sequence< Type > comphelper::OPropertyContainer::getBaseTypes ( )
staticprotected

for scripting : the types of the interfaces supported by this class

Exceptions
css::uno::RuntimeException

Definition at line 43 of file propertycontainer.cxx.

References aTypes.

◆ getFastPropertyValue()

void comphelper::OPropertyContainer::getFastPropertyValue ( css::uno::Any &  rValue,
sal_Int32  nHandle 
) const
overrideprotectedvirtual

◆ setFastPropertyValue_NoBroadcast()

void comphelper::OPropertyContainer::setFastPropertyValue_NoBroadcast ( sal_Int32  nHandle,
const css::uno::Any &  rValue 
)
overrideprotectedvirtual

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