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 PropertySetMixinImpl


prepareSet
void prepareSet(
const rtl::OUString & propertyName,
const com::sun::star::uno::Any & oldValue,
const com::sun::star::uno::Any & newValue,
BoundListeners * boundListeners );

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

Summary
A function used by subclasses of cppu::PropertySetMixin when implementing UNO interface type attribute setter functions.
Description
First, this function checks whether this instance has already been disposed (see cppu::PropertySetMixinImpl::dispose), and throws a com::sun::star::lang::DisposedException if applicable. For a constrained attribute (whose setter can explicitly raise com::sun::star::beans::PropertyVetoException), this function notifies any com::sun::star::beans::XVetoableChangeListeners. For a bound attribute, this function modifies the passed-in boundListeners so that it can afterwards be used to notify any com::sun::star::beans::XPropertyChangeListeners. This function should be called before storing the new attribute value, and boundListeners->notify() should be called exactly once after storing the new attribute value (in case the attribute is bound; otherwise, calling boundListeners->notify() is ignored). Furthermore, boundListeners->notify() and this function have to be called from the same thread.
Parameters
propertyName
the name of the property (which is the same as the
name of the attribute that is going to be set)

oldValue
the property value corresponding to the old attribute
value.  This is only used as
com::sun::star::beans::PropertyChangeEvent::OldValue, which
is rather useless, anyway (see “Using the Observer Pattern”
in 
OpenOffice.org Coding Guidelines).  If the attribute
that is going to be set is neither bound nor constrained, or if
com::sun::star::beans::PropertyChangeEvent::OldValue should
not be set, a VOID Any can be used instead.

newValue
the property value corresponding to the new
attribute value.  This is only used as
com::sun::star::beans::PropertyChangeEvent::NewValue, which
is rather useless, anyway (see “Using the Observer Pattern”
in 
OpenOffice.org Coding Guidelines), unless the
attribute that is going to be set is constrained.  If the attribute
that is going to be set is neither bound nor constrained, or if it is
only bound but
com::sun::star::beans::PropertyChangeEvent::NewValue should
not be set, a VOID Any can be used instead.

boundListeners
a pointer to a fresh
cppu::PropertySetMixinImpl::BoundListeners instance
(which has not been passed to this function before, and on which
notify has not yet been called); may only be null if the
attribute that is going to be set is not bound

dispose
void dispose();

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

Summary
Mark this instance as being disposed.
Description
See com::sun::star::lang::XComponent for the general concept of disposing UNO objects. On the first call to this function, all registered listeners (com::sun::star::beans::XPropertyChangeListeners and com::sun::star::beans::XVetoableChangeListeners) are notified of the disposing source. Any subsequent calls to this function are ignored.

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

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

Summary
A function used by subclasses of cppu::PropertySetMixin when implementing com::sun::star::uno::XInterface::queryInterface.
Description
This function checks for support of any of the UNO interface types specified in the call of the cppu::PropertySetMixin constructor. It does not check for any other UNO interface types (not even for com::sun::star::uno::XInterface), and should not be used directly as the implementation of com::sun::star::uno::XInterface::queryInterface of this UNO object.

getPropertySetInfo
virtual com::sun::star::uno::Reference< com::sun::star::beans::XPropertySetInfo > getPropertySetInfo()
throw( com::sun::star::uno::RuntimeException );

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


setPropertyValue
virtual void setPropertyValue(
const rtl::OUString & propertyName,
const com::sun::star::uno::Any & value )
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


getPropertyValue
virtual com::sun::star::uno::Any getPropertyValue(
const rtl::OUString & propertyName )
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


addPropertyChangeListener
virtual void addPropertyChangeListener(
const rtl::OUString & propertyName,
const com::sun::star::uno::Reference< com::sun::star::beans::XPropertyChangeListener > & listener )
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
Adds a com::sun::star::beans::XPropertyChangeListener.
Description
If a listener is added more than once, it will receive all relevant notifications multiple times.
See Also
com::sun::star::beans::XPropertySet::addPropertyChangeListener

removePropertyChangeListener
virtual void removePropertyChangeListener(
const rtl::OUString & propertyName,
const com::sun::star::uno::Reference< com::sun::star::beans::XPropertyChangeListener > & listener )
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


addVetoableChangeListener
virtual void addVetoableChangeListener(
const rtl::OUString & propertyName,
const com::sun::star::uno::Reference< com::sun::star::beans::XVetoableChangeListener > & listener )
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
Adds a com::sun::star::beans::XVetoableChangeListener.
Description
If a listener is added more than once, it will receive all relevant notifications multiple times.
See Also
com::sun::star::beans::XPropertySet::addVetoableChangeListener

removeVetoableChangeListener
virtual void removeVetoableChangeListener(
const rtl::OUString & propertyName,
const com::sun::star::uno::Reference< com::sun::star::beans::XVetoableChangeListener > & listener )
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


setFastPropertyValue
virtual void setFastPropertyValue(
sal_Int32 handle,
const com::sun::star::uno::Any & value )
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


getFastPropertyValue
virtual com::sun::star::uno::Any getFastPropertyValue(
sal_Int32 handle )
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


getPropertyValues
virtual com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue > getPropertyValues()
throw( 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< com::sun::star::beans::PropertyValue > & props )
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


PropertySetMixinImpl
PropertySetMixinImpl(
PropertySetMixinImpl & );

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


operator=
void operator=(
PropertySetMixinImpl & );

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


PropertySetMixinImpl
PropertySetMixinImpl(
const com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > & context,
Implements implements,
const com::sun::star::uno::Sequence< rtl::OUString > & absentOptional,
const com::sun::star::uno::Type & type );

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


~PropertySetMixinImpl
~PropertySetMixinImpl();

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


checkUnknown
void checkUnknown(
const rtl::OUString & propertyName );

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


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.