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

helper implementation for components which have properties with a default More...

#include <propertystatecontainer.hxx>

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

Protected Member Functions

 OPropertyStateContainer (::cppu::OBroadcastHelper &_rBHelper)
 ctor More...
 
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
 
css::beans::PropertyState getPropertyStateByHandle (sal_Int32 _nHandle) const
 get the PropertyState of the property denoted by the given handle More...
 
void setPropertyToDefaultByHandle (sal_Int32 _nHandle)
 set the property denoted by the given handle to its default value More...
 
virtual void getPropertyDefaultByHandle (sal_Int32 _nHandle, css::uno::Any &_rDefault) const =0
 get the default value for the property denoted by the given handle More...
 
virtual css::uno::Any SAL_CALL queryInterface (const css::uno::Type &_rType) override
 
sal_Int32 getHandleForName (const OUString &_rPropertyName)
 returns the handle for the given name More...
 
- Protected Member Functions inherited from comphelper::OPropertyContainer
 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...
 
- Protected Member Functions inherited from cppu::ImplHelper1< class Ifc1 >
 ~ImplHelper1 () SAL_NOEXCEPT
 

Additional Inherited Members

- Public Member Functions inherited from comphelper::OPropertyContainer
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
 
- Public Member Functions inherited from cppu::ImplHelper1< class Ifc1 >
virtual css::uno::Any SAL_CALL queryInterface (css::uno::Type const &rType) SAL_OVERRIDE
 
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes () SAL_OVERRIDE
 
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId () SAL_OVERRIDE
 
- Static Public Member Functions inherited from cppu::OPropertySetHelper
static css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL createPropertySetInfo (IPropertyArrayHelper &rProperties)
 
- Static Protected Member Functions inherited from comphelper::OPropertyContainer
static css::uno::Sequence< css::uno::Type > getBaseTypes ()
 for scripting : the types of the interfaces supported by this class More...
 
- Protected Attributes inherited from cppu::OPropertySetHelper
OBroadcastHelperrBHelper
 
OMultiTypeInterfaceContainerHelperInt32 aBoundLC
 
OMultiTypeInterfaceContainerHelperInt32 aVetoableLC
 
Impl *const m_pReserved
 

Detailed Description

helper implementation for components which have properties with a default

This class is not intended for direct use, you need to derive from it.

See also
com.sun.star.beans.XPropertyState

Definition at line 45 of file propertystatecontainer.hxx.

Constructor & Destructor Documentation

◆ OPropertyStateContainer()

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

ctor

Parameters
_rBHelperhelp to be used for broadcasting events

Definition at line 47 of file propertystatecontainer.cxx.

Member Function Documentation

◆ getHandleForName()

sal_Int32 comphelper::OPropertyStateContainer::getHandleForName ( const OUString &  _rPropertyName)
protected

returns the handle for the given name

Exceptions
UnknownPropertyExceptionif the given name is not a registered property

Definition at line 65 of file propertystatecontainer.cxx.

References cppu::IPropertyArrayHelper::getHandleByName(), and nHandle.

Referenced by getPropertyDefault(), getPropertyState(), and setPropertyToDefault().

◆ getPropertyDefault()

Any SAL_CALL comphelper::OPropertyStateContainer::getPropertyDefault ( const OUString &  aPropertyName)
overrideprotectedvirtual

Definition at line 143 of file propertystatecontainer.cxx.

References Any, getHandleForName(), and getPropertyDefaultByHandle().

◆ getPropertyDefaultByHandle()

virtual void comphelper::OPropertyStateContainer::getPropertyDefaultByHandle ( sal_Int32  _nHandle,
css::uno::Any &  _rDefault 
) const
protectedpure virtual

get the default value for the property denoted by the given handle

@precond <arg>_nHandle</arg> is a valid property handle

References queryInterface().

Referenced by getPropertyDefault(), getPropertyStateByHandle(), and setPropertyToDefaultByHandle().

◆ getPropertyState()

PropertyState SAL_CALL comphelper::OPropertyStateContainer::getPropertyState ( const OUString &  PropertyName)
overrideprotectedvirtual

Definition at line 78 of file propertystatecontainer.cxx.

References getHandleForName(), and getPropertyStateByHandle().

Referenced by getPropertyStates().

◆ getPropertyStateByHandle()

PropertyState comphelper::OPropertyStateContainer::getPropertyStateByHandle ( sal_Int32  _nHandle) const
protected

get the PropertyState of the property denoted by the given handle

Already implemented by this base class, no need to override

@precond <arg>_nHandle</arg> is a valid property handle

Definition at line 151 of file propertystatecontainer.cxx.

References Any, comphelper::OPropertyContainer::getFastPropertyValue(), getPropertyDefaultByHandle(), and uno_type_equalData().

Referenced by getPropertyState().

◆ getPropertyStates()

Sequence< PropertyState > SAL_CALL comphelper::OPropertyStateContainer::getPropertyStates ( const css::uno::Sequence< OUString > &  aPropertyName)
overrideprotectedvirtual

◆ queryInterface()

Any SAL_CALL comphelper::OPropertyStateContainer::queryInterface ( const css::uno::Type &  _rType)
overrideprotectedvirtual

◆ setPropertyToDefault()

void SAL_CALL comphelper::OPropertyStateContainer::setPropertyToDefault ( const OUString &  PropertyName)
overrideprotectedvirtual

◆ setPropertyToDefaultByHandle()

void comphelper::OPropertyStateContainer::setPropertyToDefaultByHandle ( sal_Int32  _nHandle)
protected

set the property denoted by the given handle to its default value

Already implemented by this base class, no need to override

@precond <arg>_nHandle</arg> is a valid property handle

Definition at line 172 of file propertystatecontainer.cxx.

References Any, getPropertyDefaultByHandle(), and cppu::OPropertySetHelper::setFastPropertyValue().

Referenced by setPropertyToDefault().


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