LibreOffice LibreOffice 4.3 SDK C/C++ API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Protected Member Functions | List of all members
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 >:

## 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. More...
| ~PropertySetMixin ()
| The destructor. More...
Protected Member Functions inherited from cppu::PropertySetMixinImpl
void | prepareSet (rtl::OUString const &propertyName, com::sun::star::uno::Any const &oldValue, com::sun::star::uno::Any const &newValue, BoundListeners *boundListeners)
| A function used by subclasses of `cppu::PropertySetMixin` when implementing UNO interface type attribute setter functions. More...
void | dispose ()
| Mark this instance as being disposed. More...
virtual com::sun::star::uno::Any | queryInterface (com::sun::star::uno::Type const &type) SAL_OVERRIDE throw (com::sun::star::uno::RuntimeException, std::exception)
| A function used by subclasses of `cppu::PropertySetMixin` when implementing `com::sun::star::uno::XInterface::queryInterface`. More...
virtual com::sun::star::uno::Reference < com::sun::star::beans::XPropertySetInfo > | getPropertySetInfo () SAL_OVERRIDE throw (com::sun::star::uno::RuntimeException, std::exception)
virtual void | setPropertyValue (rtl::OUString const &propertyName, com::sun::star::uno::Any const &value) SAL_OVERRIDE 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, std::exception)
virtual com::sun::star::uno::Any | getPropertyValue (rtl::OUString const &propertyName) SAL_OVERRIDE throw ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException, com::sun::star::uno::RuntimeException, std::exception)
virtual void | addPropertyChangeListener (rtl::OUString const &propertyName, com::sun::star::uno::Reference< com::sun::star::beans::XPropertyChangeListener > const &listener) SAL_OVERRIDE throw ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException, com::sun::star::uno::RuntimeException, std::exception)
| Adds a `com::sun::star::beans::XPropertyChangeListener`. More...
virtual void | removePropertyChangeListener (rtl::OUString const &propertyName, com::sun::star::uno::Reference< com::sun::star::beans::XPropertyChangeListener > const &listener) SAL_OVERRIDE throw ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException, com::sun::star::uno::RuntimeException, std::exception)
virtual void | addVetoableChangeListener (rtl::OUString const &propertyName, com::sun::star::uno::Reference< com::sun::star::beans::XVetoableChangeListener > const &listener) SAL_OVERRIDE throw ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException, com::sun::star::uno::RuntimeException, std::exception)
| Adds a `com::sun::star::beans::XVetoableChangeListener`. More...
virtual void | removeVetoableChangeListener (rtl::OUString const &propertyName, com::sun::star::uno::Reference< com::sun::star::beans::XVetoableChangeListener > const &listener) SAL_OVERRIDE throw ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException, com::sun::star::uno::RuntimeException, std::exception)
virtual void | setFastPropertyValue (sal_Int32 handle, com::sun::star::uno::Any const &value) SAL_OVERRIDE 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, std::exception)
virtual com::sun::star::uno::Any | getFastPropertyValue (sal_Int32 handle) SAL_OVERRIDE throw ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException, com::sun::star::uno::RuntimeException, std::exception)
virtual com::sun::star::uno::Sequence < com::sun::star::beans::PropertyValue > | getPropertyValues () SAL_OVERRIDE throw (com::sun::star::uno::RuntimeException, std::exception)
virtual void | setPropertyValues (com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue > const &props) SAL_OVERRIDE 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, std::exception)

## Additional Inherited Members
Protected Types inherited from cppu::PropertySetMixinImpl
enum | Implements { IMPLEMENTS_PROPERTY_SET = 1, IMPLEMENTS_FAST_PROPERTY_SET = 2, IMPLEMENTS_PROPERTY_ACCESS = 4 }
| Flags used by subclasses of `cppu::PropertySetMixin` to specify what UNO interface types shall be supported. More...

## 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 `com.sun.star.reflection.theCoreReflection` and `com.sun.star.reflection.theTypeDescriptionManager` singletons
  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