Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Methods of Class OPropertySetHelper


OPropertySetHelper
OPropertySetHelper(
OBroadcastHelper & rBHelper ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Parameters
rBHelper
this structure contains the basic members of
a broadcaster.
The lifetime must be longer than the lifetime
of this object. Stored in the variable rBHelper.

OPropertySetHelper
OPropertySetHelper(
OBroadcastHelper & rBHelper,
bool bIgnoreRuntimeExceptionsWhileFiring );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Summary
Constructor.
Parameters
rBHelper
                 this structure contains the basic members of
                 a broadcaster.
                   The lifetime must be longer than the lifetime
                   of this object. Stored in the variable rBHelper.
                   
 
bIgnoreRuntimeExceptionsWhileFiring
                 indicates whether occuring RuntimeExceptions will be
                 ignored when firing notifications (vetoableChange((),
                 propertyChange()) to listeners.
                 PropertyVetoExceptions may still be thrown.
                 This flag is useful in a inter-process scenarios when
                 remote bridges may break down
                 (firing DisposedExceptions).

OPropertySetHelper
OPropertySetHelper(
OBroadcastHelper & rBHelper,
IEventNotificationHook * i_pFireEvents,
bool bIgnoreRuntimeExceptionsWhileFiring = false );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Summary
Constructor.
Parameters
rBHelper
                 this structure contains the basic members of
                 a broadcaster.
                 The lifetime must be longer than the lifetime
                 of this object. Stored in the variable rBHelper.
                   
 
i_pFireEvents
                 additional event notifier

 
bIgnoreRuntimeExceptionsWhileFiring
                 indicates whether occuring RuntimeExceptions will be
                 ignored when firing notifications (vetoableChange((),
                 propertyChange()) to listeners.
                 PropertyVetoExceptions may still be thrown.
                 This flag is useful in a inter-process scenarios when
                 remote bridges may break down
                 (firing DisposedExceptions).

queryInterface
::com::sun::star::uno::Any queryInterface(
const ::com::sun::star::uno::Type & rType )
throw( ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

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

getTypes
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > getTypes()
throw( ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Summary
eases implementing XTypeProvider::getTypes, returns the types of XMultiPropertySet, XFastPropertySet, XPropertySet

disposing
void disposing() throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Summary
Send a disposing notification to the listeners in the conatiners aBoundLC and aVetoableLC.
See Also
OComponentHelper

setPropertyValue
virtual void setPropertyValue(
const ::rtl::OUString & rPropertyName,
const ::com::sun::star::uno::Any & aValue )
throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
YES NO NO NO NO NO NO NO

Description
Throw UnknownPropertyException or PropertyVetoException if the property with the name rPropertyName does not exist or is readonly. Otherwise rPropertyName is changed to its handle value and setFastPropertyValue is called.

getPropertyValue
virtual ::com::sun::star::uno::Any getPropertyValue(
const ::rtl::OUString & aPropertyName )
throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
YES NO NO NO NO NO NO NO

Summary
Throw UnknownPropertyException if the property with the name rPropertyName does not exist.

addPropertyChangeListener
virtual void addPropertyChangeListener(
const ::rtl::OUString & aPropertyName,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener > & aListener )
throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
YES NO NO NO NO NO NO NO

Summary
Ignored if the property is not bound.

removePropertyChangeListener
virtual void removePropertyChangeListener(
const ::rtl::OUString & aPropertyName,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener > & aListener )
throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
YES NO NO NO NO NO NO NO

Summary
Ignored if the property is not bound.

addVetoableChangeListener
virtual void addVetoableChangeListener(
const ::rtl::OUString & aPropertyName,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener > & aListener )
throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
YES NO NO NO NO NO NO NO

Summary
Ignored if the property is not constrained.

removeVetoableChangeListener
virtual void removeVetoableChangeListener(
const ::rtl::OUString & aPropertyName,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener > & aListener )
throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
YES NO NO NO NO NO NO NO

Summary
Ignored if the property is not constrained.

setFastPropertyValue
virtual void setFastPropertyValue(
sal_Int32 nHandle,
const ::com::sun::star::uno::Any & rValue )
throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
YES NO NO NO NO NO NO NO

Description
Throw UnknownPropertyException or PropertyVetoException if the property with the name rPropertyName does not exist or is readonly. Otherwise the method convertFastPropertyValue is called, then the vetoable listeners are notified. After this the value of the property is changed with the setFastPropertyValue_NoBroadcast method and the bound listeners are notified.

getFastPropertyValue
virtual ::com::sun::star::uno::Any getFastPropertyValue(
sal_Int32 nHandle )
throw( ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
YES NO NO NO NO NO NO NO


setPropertyValues
virtual void setPropertyValues(
const ::com::sun::star::uno::Sequence< ::rtl::OUString > & PropertyNames,
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > & Values )
throw( ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
YES NO NO NO NO NO NO NO


getPropertyValues
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > getPropertyValues(
const ::com::sun::star::uno::Sequence< ::rtl::OUString > & PropertyNames )
throw( ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
YES NO NO NO NO NO NO NO


addPropertiesChangeListener
virtual void addPropertiesChangeListener(
const ::com::sun::star::uno::Sequence< ::rtl::OUString > & PropertyNames,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertiesChangeListener > & Listener )
throw( ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
YES NO NO NO NO NO NO NO


removePropertiesChangeListener
virtual void removePropertiesChangeListener(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertiesChangeListener > & Listener )
throw( ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
YES NO NO NO NO NO NO NO


firePropertiesChangeEvent
virtual void firePropertiesChangeEvent(
const ::com::sun::star::uno::Sequence< ::rtl::OUString > & PropertyNames,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertiesChangeListener > & Listener )
throw( ::com::sun::star::uno::RuntimeException );

virtual abstract const volatile template static inline C-linkage
YES NO NO NO NO NO NO NO


fire
void fire(
sal_Int32 * pnHandles,
const ::com::sun::star::uno::Any * pNewValues,
const ::com::sun::star::uno::Any * pOldValues,
sal_Int32 nCount,
sal_Bool bVetoable );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Summary
This method fire events to all registered property listeners.
Parameters
pnHandles
the id's of the properties that changed.
pNewValues
the new values of the properties.
pOldValues
the old values of the properties.
nCount
the number of elements in the arrays pnHandles, pNewValues and pOldValues.
bVetoable
true means fire to VetoableChangeListener, false means fire to
           XPropertyChangedListener and XMultiPropertyChangedListener.

setFastPropertyValues
void setFastPropertyValues(
sal_Int32 nSeqLen,
sal_Int32 * pHandles,
const ::com::sun::star::uno::Any * pValues,
sal_Int32 nHitCount )
throw( ::com::sun::star::uno::Exception );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Summary
Set multiple properties with the handles.
Parameters
nSeqLen
the length of the arrays pHandles and Values.
pHandles
the handles of the properties. The number of elements
       in the Values sequence is the length of the handle array. A value of -1
       of a handle means invalid property. These are ignored.
pValues
the values of the properties.
nHitCount
the number of valid entries in the handle array.

getInfoHelper
virtual IPropertyArrayHelper & getInfoHelper() = 0;

virtual abstract const volatile template static inline C-linkage
YES YES NO NO NO NO NO NO

Summary
This abstract method must return the name to index table. This table contains all property names and types of this object. The method is not implemented in this class.

convertFastPropertyValue
virtual sal_Bool convertFastPropertyValue(
::com::sun::star::uno::Any & rConvertedValue,
::com::sun::star::uno::Any & rOldValue,
sal_Int32 nHandle,
const ::com::sun::star::uno::Any & rValue )
throw( ::com::sun::star::lang::IllegalArgumentException ) = 0;

virtual abstract const volatile template static inline C-linkage
YES YES NO NO NO NO NO NO

Description
Converted the value rValue and return the result in rConvertedValue and the old value in rOldValue. A IllegalArgumentException is thrown. The method is not implemented in this class. After this call the vetoable listeners are notified.
Parameters
rConvertedValue
the converted value. Only set if return is true.
rOldValue
the old value. Only set if return is true.
nHandle
the handle of the proberty.
Return
true if the value converted.

setFastPropertyValue_NoBroadcast
virtual void setFastPropertyValue_NoBroadcast(
sal_Int32 nHandle,
const ::com::sun::star::uno::Any & rValue )
throw( ::com::sun::star::uno::Exception ) = 0;

virtual abstract const volatile template static inline C-linkage
YES YES NO NO NO NO NO NO

Description
The same as setFastProperyValue; nHandle is always valid. The changes must not be broadcasted in this method. The method is implemented in a derived class.
ATTENTION!
Although you are permitted to throw any UNO exception, only the following are valid for usage: -- ::com::sun::star::beans::UnknownPropertyException -- ::com::sun::star::beans::PropertyVetoException -- ::com::sun::star::lang::IllegalArgumentException -- ::com::sun::star::lang::WrappedTargetException -- ::com::sun::star::uno::RuntimeException
Parameters
nHandle
       handle
rValue
       value

getFastPropertyValue
virtual void getFastPropertyValue(
::com::sun::star::uno::Any & rValue,
sal_Int32 nHandle ) const = 0;

virtual abstract const volatile template static inline C-linkage
YES YES YES NO NO NO NO NO

Description
The same as getFastProperyValue, but return the value through rValue and nHandle is always valid. The method is not implemented in this class.

setDependentFastPropertyValue
void setDependentFastPropertyValue(
sal_Int32 i_handle,
const ::com::sun::star::uno::Any & i_value );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Summary
sets an dependent property's value
Description

Sometimes setting a given property needs to implicitly modify another property's value. Calling |setPropertyValue| from within |setFastPropertyValue_NoBroadcast| is not an option here, as it would notify the property listeners while our mutex is still locked. Setting the dependent property's value directly (e.g. by calling |setFastPropertyValue_NoBroadcast| recursively) is not an option, too, since it would miss firing the property change event.

So, in such cases, you use |setDependentFastPropertyValue| from within |setFastPropertyValue_NoBroadcast|. It will convert and actually set the property value (invoking |convertFastPropertyValue| and |setFastPropertyValue_NoBroadcast| for the given handle and value), and add the property change event to the list of events to be notified when the bottom-most |setFastPropertyValue_NoBroadcast| on the stack returns.

Note: The method will not invoke veto listeners for the property.

Note: It's the caller's responsibility to ensure that our mutex is locked. This is canonically given when the method is invoked from within |setFastPropertyValue_NoBroadcast|, in other contexts, you might need to take own measures.


OPropertySetHelper
OPropertySetHelper(
const OPropertySetHelper & ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO


operator=
OPropertySetHelper & operator=(
const OPropertySetHelper & ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO


impl_fireAll
void impl_fireAll(
sal_Int32 * i_handles,
const ::com::sun::star::uno::Any * i_newValues,
const ::com::sun::star::uno::Any * i_oldValues,
sal_Int32 i_count );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Summary
notifies the given changes in property's values, plus all property changes collected during recent |setDependentFastPropertyValue| calls.

~OPropertySetHelper
~OPropertySetHelper() throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO NO

Summary
You must call disposing before destruction.

createPropertySetInfo
static ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > createPropertySetInfo(
IPropertyArrayHelper & rProperties ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO YES NO NO

Summary
The property sequence is created in the call. The interface isn't used after the call.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.