cppu::PropertySetMixin< T > Class Template Reference

A helper mixin to implement certain UNO interfaces related to property set handling on top of the attributes of a given UNO interface type. More...

#include <propertysetmixin.hxx>

Inheritance diagram for cppu::PropertySetMixin< T >:

List of all members.

Protected Member Functions
	PropertySetMixin (com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > const &context, Implements implements, com::sun::star::uno::Sequence< rtl::OUString > const &absentOptional)
	The constructor.
	~PropertySetMixin ()
	The destructor.

---

Detailed Description

template<typename T>
class cppu::PropertySetMixin< T >

A helper mixin to implement certain UNO interfaces related to property set handling on top of the attributes of a given UNO interface type.

The UNO interface type is specified by the type parameter T (which must correspond to a UNO interface type).

No specializations of this class template should be added by client code.

Since:

UDK 3.2.1

---

Constructor & Destructor Documentation

template<typename T >

cppu::PropertySetMixin< T >::PropertySetMixin	(	com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext > const &	context,
		Implements	implements,
		com::sun::star::uno::Sequence< rtl::OUString > const &	absentOptional
	)			[inline, protected]

The constructor.

May throw com::sun::star::uno::RuntimeException and std::bad_alloc.

Parameters:

	context	the component context used by this class template; must not be null, and must supply the service com.sun.star.reflection.CoreReflection and the singleton com.sun.star.reflection.theTypeDescriptionManager
	implements	a combination of zero or more flags specifying what UNO interface types shall be supported
	absentOptional	a list of optional properties that are not present, and should thus not be visible via com::sun::star::beans::XPropertySet::getPropertySetInfo, com::sun::star::beans::XPropertySet::addPropertyChangeListener, com::sun::star::beans::XPropertySet::removePropertyChangeListener, com::sun::star::beans::XPropertySet::addVetoableChangeListener, and com::sun::star::beans::XPropertySet::removeVetoableChangeListener. For consistency reasons, the given absentOptional should only contain the names of attributes that represent optional properties that are not present (that is, the attribute getters and setters always throw a com::sun::star::beans::UnknownPropertyException), and should contain each such name only once. If an optional property is not present (that is, the corresponding attribute getter and setter always throw a com::sun::star::beans::UnknownPropertyException) but is not contained in the given absentOptional, then it will be visible via com::sun::star::beans::XPropertySet::getPropertySetInfo as a com::sun::star::beans::Property with a set com::sun::star::beans::PropertyAttribute::OPTIONAL. If the given implements specifies that com::sun::star::beans::XPropertySet is not supported, then the given absentOptional is effectively ignored and can be empty.

template<typename T >

cppu::PropertySetMixin< T >::~PropertySetMixin

(

)

[inline, protected]

The destructor.

Does not throw.

---

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

• cppuhelper/propertysetmixin.hxx