LibreOffice
LibreOffice 5.3 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | List of all members
cppu::OPropertySetHelper2 Class Reference

OPropertySetHelper plus XPropertySetOption. More...

#include <propshlp.hxx>

Inheritance diagram for cppu::OPropertySetHelper2:
cppu::OPropertySetHelper

Public Member Functions

 OPropertySetHelper2 (OBroadcastHelper &rBHelper, IEventNotificationHook *i_pFireEvents=NULL, bool bIgnoreRuntimeExceptionsWhileFiring=false)
 Constructor. More...
 
virtual css::uno::Any queryInterface (const css::uno::Type &rType) SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 Only returns a reference to XMultiPropertySet, XFastPropertySet, XPropertySet and XEventListener. More...
 
virtual void enableChangeListenerNotification (sal_Bool bEnable) SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 
- Public Member Functions inherited from cppu::OPropertySetHelper
 OPropertySetHelper (OBroadcastHelper &rBHelper)
 
 OPropertySetHelper (OBroadcastHelper &rBHelper, bool bIgnoreRuntimeExceptionsWhileFiring)
 Constructor. More...
 
 OPropertySetHelper (OBroadcastHelper &rBHelper, IEventNotificationHook *i_pFireEvents, bool bIgnoreRuntimeExceptionsWhileFiring=false)
 Constructor. More...
 
css::uno::Sequence
< css::uno::Type > 
getTypes () throw (css::uno::RuntimeException)
 eases implementing XTypeProvider::getTypes, returns the types of XMultiPropertySet, XFastPropertySet, XPropertySet More...
 
void disposing ()
 Send a disposing notification to the listeners in the containers aBoundLC and aVetoableLC. More...
 
virtual void setPropertyValue (const ::rtl::OUString &rPropertyName, const css::uno::Any &aValue) SAL_OVERRIDE throw (css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception)
 Throw UnknownPropertyException or PropertyVetoException if the property with the name rPropertyName does not exist or is readonly. More...
 
virtual css::uno::Any getPropertyValue (const ::rtl::OUString &aPropertyName) SAL_OVERRIDE throw (css::beans::UnknownPropertyException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception)
 Throw UnknownPropertyException if the property with the name rPropertyName does not exist. More...
 
virtual void addPropertyChangeListener (const ::rtl::OUString &aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &aListener) SAL_OVERRIDE throw (css::beans::UnknownPropertyException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception)
 Ignored if the property is not bound. More...
 
virtual void removePropertyChangeListener (const ::rtl::OUString &aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &aListener) SAL_OVERRIDE throw (css::beans::UnknownPropertyException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception)
 Ignored if the property is not bound. More...
 
virtual void addVetoableChangeListener (const ::rtl::OUString &aPropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &aListener) SAL_OVERRIDE throw (css::beans::UnknownPropertyException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception)
 Ignored if the property is not constrained. More...
 
virtual void removeVetoableChangeListener (const ::rtl::OUString &aPropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &aListener) SAL_OVERRIDE throw (css::beans::UnknownPropertyException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception)
 Ignored if the property is not constrained. More...
 
virtual void setFastPropertyValue (sal_Int32 nHandle, const css::uno::Any &rValue) SAL_OVERRIDE throw (css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception)
 Throw UnknownPropertyException or PropertyVetoException if the property with the name rPropertyName does not exist or is readonly. More...
 
virtual css::uno::Any getFastPropertyValue (sal_Int32 nHandle) SAL_OVERRIDE throw (css::beans::UnknownPropertyException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception)
 
Exceptions
css::beans::UnknownPropertyExceptionif the property with the handle nHandle does not exist.
More...
 
virtual void setPropertyValues (const css::uno::Sequence< ::rtl::OUString > &PropertyNames, const css::uno::Sequence< css::uno::Any > &Values) SAL_OVERRIDE throw (css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception)
 
virtual css::uno::Sequence
< css::uno::Any > 
getPropertyValues (const css::uno::Sequence< ::rtl::OUString > &PropertyNames) SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 
virtual void addPropertiesChangeListener (const css::uno::Sequence< ::rtl::OUString > &PropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener > &Listener) SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 
virtual void removePropertiesChangeListener (const css::uno::Reference< css::beans::XPropertiesChangeListener > &Listener) SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 
virtual void firePropertiesChangeEvent (const css::uno::Sequence< ::rtl::OUString > &PropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener > &Listener) SAL_OVERRIDE throw (css::uno::RuntimeException, std::exception)
 

Protected Member Functions

virtual ~OPropertySetHelper2 ()
 You must call disposing before destruction. More...
 
- Protected Member Functions inherited from cppu::OPropertySetHelper
void fire (sal_Int32 *pnHandles, const css::uno::Any *pNewValues, const css::uno::Any *pOldValues, sal_Int32 nCount, sal_Bool bVetoable)
 This method fire events to all registered property listeners. More...
 
void setFastPropertyValues (sal_Int32 nSeqLen, sal_Int32 *pHandles, const css::uno::Any *pValues, sal_Int32 nHitCount)
 Set multiple properties with the handles. More...
 
virtual IPropertyArrayHelpergetInfoHelper ()=0
 This abstract method must return the name to index table. More...
 
virtual sal_Bool convertFastPropertyValue (css::uno::Any &rConvertedValue, css::uno::Any &rOldValue, sal_Int32 nHandle, const css::uno::Any &rValue)=0 throw (css::lang::IllegalArgumentException, css::beans::UnknownPropertyException, css::uno::RuntimeException, std::exception)
 Converted the value rValue and return the result in rConvertedValue and the old value in rOldValue. More...
 
virtual void setFastPropertyValue_NoBroadcast (sal_Int32 nHandle, const css::uno::Any &rValue)=0 throw (css::uno::Exception, std::exception)
 The same as setFastProperyValue; nHandle is always valid. More...
 
virtual void getFastPropertyValue (css::uno::Any &rValue, sal_Int32 nHandle) const =0
 The same as getFastProperyValue, but return the value through rValue and nHandle is always valid. More...
 
void setDependentFastPropertyValue (sal_Int32 i_handle, const css::uno::Any &i_value)
 sets an dependent property's value More...
 
 ~OPropertySetHelper ()
 You must call disposing before destruction. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from cppu::OPropertySetHelper
static css::uno::Reference
< css::beans::XPropertySetInfo > 
createPropertySetInfo (IPropertyArrayHelper &rProperties)
 The property sequence is created in the call. More...
 
- Protected Attributes inherited from cppu::OPropertySetHelper
OBroadcastHelperrBHelper
 The common data of a broadcaster. More...
 
OMultiTypeInterfaceContainerHelperInt32 aBoundLC
 Container for the XProperyChangedListener. More...
 
OMultiTypeInterfaceContainerHelperInt32 aVetoableLC
 Container for the XPropertyVetoableListener. More...
 
Impl *const m_pReserved
 reserved for future use. More...
 

Detailed Description

OPropertySetHelper plus XPropertySetOption.

Attention
The getTypes() inherited from OPropertysetHelper does not cover XPropertySetOption.

Constructor & Destructor Documentation

cppu::OPropertySetHelper2::OPropertySetHelper2 ( OBroadcastHelper rBHelper,
IEventNotificationHook i_pFireEvents = NULL,
bool  bIgnoreRuntimeExceptionsWhileFiring = false 
)
explicit

Constructor.

See OPropertySetHelper constructors documentation

virtual cppu::OPropertySetHelper2::~OPropertySetHelper2 ( )
protectedvirtual

You must call disposing before destruction.

Member Function Documentation

virtual void cppu::OPropertySetHelper2::enableChangeListenerNotification ( sal_Bool  bEnable)
throw (css::uno::RuntimeException,
std::exception
)
virtual
virtual css::uno::Any cppu::OPropertySetHelper2::queryInterface ( const css::uno::Type &  rType)
throw (css::uno::RuntimeException,
std::exception
)
virtual

Only returns a reference to XMultiPropertySet, XFastPropertySet, XPropertySet and XEventListener.

Reimplemented from cppu::OPropertySetHelper.


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