521 lines
21 KiB
C++
521 lines
21 KiB
C++
|
/*************************************************************************
|
||
|
|
*
|
||
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
||
|
|
*
|
||
|
|
* $RCSfile: propertysetmixin.hxx,v $
|
||
|
|
*
|
||
|
|
* $Revision: 1.2 $
|
||
|
|
*
|
||
|
|
* last change: $Author: hr $ $Date: 2005-10-27 17:16:39 $
|
||
|
|
*
|
||
|
|
* The Contents of this file are made available subject to
|
||
|
|
* the terms of GNU Lesser General Public License Version 2.1.
|
||
|
|
*
|
||
|
|
*
|
||
|
|
* GNU Lesser General Public License Version 2.1
|
||
|
|
* =============================================
|
||
|
|
* Copyright 2005 by Sun Microsystems, Inc.
|
||
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
||
|
|
*
|
||
|
|
* This library is free software; you can redistribute it and/or
|
||
|
|
* modify it under the terms of the GNU Lesser General Public
|
||
|
|
* License version 2.1, as published by the Free Software Foundation.
|
||
|
|
*
|
||
|
|
* This library is distributed in the hope that it will be useful,
|
||
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||
|
|
* Lesser General Public License for more details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU Lesser General Public
|
||
|
|
* License along with this library; if not, write to the Free Software
|
||
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
||
|
|
* MA 02111-1307 USA
|
||
|
|
*
|
||
|
|
************************************************************************/
|
||
|
|
|
||
|
|
#ifndef INCLUDED_CPPUHELPER_PROPERTYSETMIXIN_HXX
|
||
|
|
#define INCLUDED_CPPUHELPER_PROPERTYSETMIXIN_HXX \
|
||
|
|
INCLUDED_CPPUHELPER_PROPERTYSETMIXIN_HXX
|
||
|
|
|
||
|
|
#ifndef _SAL_CONFIG_H_
|
||
|
|
#include "sal/config.h"
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifndef _COM_SUN_STAR_BEANS_PROPERTYVETOEXCEPTION_HPP_
|
||
|
|
#include "com/sun/star/beans/PropertyVetoException.hpp"
|
||
|
|
#endif
|
||
|
|
#ifndef _COM_SUN_STAR_BEANS_UNKNOWNPROPERTYEXCEPTION_HPP_
|
||
|
|
#include "com/sun/star/beans/UnknownPropertyException.hpp"
|
||
|
|
#endif
|
||
|
|
#ifndef _COM_SUN_STAR_BEANS_XFASTPROPERTYSET_HPP_
|
||
|
|
#include "com/sun/star/beans/XFastPropertySet.hpp"
|
||
|
|
#endif
|
||
|
|
#ifndef _COM_SUN_STAR_BEANS_XPROPERTYACCESS_HPP_
|
||
|
|
#include "com/sun/star/beans/XPropertyAccess.hpp"
|
||
|
|
#endif
|
||
|
|
#ifndef _COM_SUN_STAR_BEANS_XPROPERTYSET_HPP_
|
||
|
|
#include "com/sun/star/beans/XPropertySet.hpp"
|
||
|
|
#endif
|
||
|
|
#ifndef _COM_SUN_STAR_LANG_ILLEGALARGUMENTEXCEPTION_HPP_
|
||
|
|
#include "com/sun/star/lang/IllegalArgumentException.hpp"
|
||
|
|
#endif
|
||
|
|
#ifndef _COM_SUN_STAR_LANG_WRAPPEDTARGETEXCEPTION_HPP_
|
||
|
|
#include "com/sun/star/lang/WrappedTargetException.hpp"
|
||
|
|
#endif
|
||
|
|
#ifndef _COM_SUN_STAR_UNO_REFERENCE_HXX_
|
||
|
|
#include "com/sun/star/uno/Reference.hxx"
|
||
|
|
#endif
|
||
|
|
#ifndef _COM_SUN_STAR_UNO_RUNTIMEEXCEPTION_HPP_
|
||
|
|
#include "com/sun/star/uno/RuntimeException.hpp"
|
||
|
|
#endif
|
||
|
|
#ifndef _COM_SUN_STAR_UNO_SEQUENCE_HXX_
|
||
|
|
#include "com/sun/star/uno/Sequence.hxx"
|
||
|
|
#endif
|
||
|
|
#ifndef _SAL_TYPES_H_
|
||
|
|
#include "sal/types.h"
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/// @HTML
|
||
|
|
|
||
|
|
namespace com { namespace sun { namespace star {
|
||
|
|
namespace beans {
|
||
|
|
class XPropertyChangeListener;
|
||
|
|
class XPropertySetInfo;
|
||
|
|
class XVetoableChangeListener;
|
||
|
|
struct PropertyValue;
|
||
|
|
}
|
||
|
|
namespace uno {
|
||
|
|
class Any;
|
||
|
|
class Type;
|
||
|
|
class XComponentContext;
|
||
|
|
}
|
||
|
|
} } }
|
||
|
|
namespace rtl { class OUString; }
|
||
|
|
|
||
|
|
namespace cppu {
|
||
|
|
|
||
|
|
template< typename T > class PropertySetMixin;
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short A helper base class for <code>cppu::PropertySetMixin</code>.
|
||
|
|
|
||
|
|
@descr See the documentation of <code>cppu::PropertySetMixin</code> for
|
||
|
|
further details.
|
||
|
|
|
||
|
|
@descr That <code>cppu::PropertySetMixin</code> is derived from this
|
||
|
|
base class should be considered an implementation detail. The functionality
|
||
|
|
of <code>cppu::PropertySetMixin</code> that is inherited from this base
|
||
|
|
class and is visible to subclasses of
|
||
|
|
<code>cppu::PropertySetMixin</code> should be treated by such
|
||
|
|
subclasses as being provided by <code>cppu::PropertySetMixin</code>
|
||
|
|
directly (e.g., in such subclasses, use
|
||
|
|
“<code>PropertySetMixin::Implements</code>” instead of
|
||
|
|
“<code>PropertySetMixinImpl::Implements</code>”).
|
||
|
|
|
||
|
|
@since #i51720#
|
||
|
|
*/
|
||
|
|
class PropertySetMixinImpl:
|
||
|
|
public com::sun::star::beans::XPropertySet,
|
||
|
|
public com::sun::star::beans::XFastPropertySet,
|
||
|
|
public com::sun::star::beans::XPropertyAccess
|
||
|
|
{
|
||
|
|
protected:
|
||
|
|
/**
|
||
|
|
@short Flags used by subclasses of
|
||
|
|
<code>cppu::PropertySetMixin</code> to specify what UNO interface
|
||
|
|
types shall be supported.
|
||
|
|
*/
|
||
|
|
enum Implements {
|
||
|
|
/**
|
||
|
|
@short Flag specifying that the UNO interface type
|
||
|
|
<code>com::sun::star::beans::XPropertySet</code> shall be supported.
|
||
|
|
*/
|
||
|
|
IMPLEMENTS_PROPERTY_SET = 1,
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short Flag specifying that the UNO interface type
|
||
|
|
<code>com::sun::star::beans::XFastPropertySet</code> shall be
|
||
|
|
supported.
|
||
|
|
*/
|
||
|
|
IMPLEMENTS_FAST_PROPERTY_SET = 2,
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short Flag specifying that the UNO interface type
|
||
|
|
<code>com::sun::star::beans::XPropertyAccess</code> shall be
|
||
|
|
supported.
|
||
|
|
*/
|
||
|
|
IMPLEMENTS_PROPERTY_ACCESS = 4
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short A class used by subclasses of
|
||
|
|
<code>cppu::PropertySetMixin</code> when implementing UNO interface
|
||
|
|
type attribute setter functions.
|
||
|
|
|
||
|
|
@descr This class is not thread safe; that is, the constructor,
|
||
|
|
<code>notify</code>, and the destructor must be called from the same
|
||
|
|
thread.
|
||
|
|
|
||
|
|
@descr See <code>cppu::PropertySetMixinImpl::prepareSet</code> for
|
||
|
|
further details.
|
||
|
|
*/
|
||
|
|
class BoundListeners {
|
||
|
|
public:
|
||
|
|
/**
|
||
|
|
@short The constructor.
|
||
|
|
|
||
|
|
@descr May throw <code>std::bad_alloc</code>.
|
||
|
|
*/
|
||
|
|
BoundListeners();
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short The destructor.
|
||
|
|
|
||
|
|
@descr Does not throw.
|
||
|
|
*/
|
||
|
|
~BoundListeners();
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short Notifies any
|
||
|
|
<code>com::sun::star::beans::XPropertyChangeListener</code>s.
|
||
|
|
|
||
|
|
@descr May throw <code>com::sun::star::uno::RuntimeException</code>
|
||
|
|
and <code>std::bad_alloc</code>.
|
||
|
|
|
||
|
|
@descr See <code>cppu::PropertySetMixinImpl::prepareSet</code>
|
||
|
|
for further details.
|
||
|
|
*/
|
||
|
|
void notify() const;
|
||
|
|
|
||
|
|
private:
|
||
|
|
BoundListeners(BoundListeners &); // not defined
|
||
|
|
void operator =(BoundListeners); // not defined
|
||
|
|
|
||
|
|
class Impl;
|
||
|
|
Impl * m_impl;
|
||
|
|
|
||
|
|
friend class PropertySetMixinImpl;
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short A function used by subclasses of
|
||
|
|
<code>cppu::PropertySetMixin</code> when implementing UNO interface
|
||
|
|
type attribute setter functions.
|
||
|
|
|
||
|
|
@descr First, this function checks whether this instance has already been
|
||
|
|
disposed (see <code>cppu::PropertySetMixinImpl::dispose</code>),
|
||
|
|
and throws a <code>com::sun::star::lang::DisposedException</code> if
|
||
|
|
applicable. For a constrained attribute (whose setter can explicitly
|
||
|
|
raise <code>com::sun::star::beans::PropertyVetoException</code>), this
|
||
|
|
function notifies any
|
||
|
|
<code>com::sun::star::beans::XVetoableChangeListener</code>s. For a
|
||
|
|
bound attribute, this function modifies the passed-in
|
||
|
|
<code>boundListeners</code> so that it can afterwards be used to notify
|
||
|
|
any <code>com::sun::star::beans::XPropertyChangeListener</code>s. This
|
||
|
|
function should be called before storing the new attribute value, and
|
||
|
|
<code>boundListeners->notify()</code> should be called exactly once after
|
||
|
|
storing the new attribute value (in case the attribute is bound;
|
||
|
|
otherwise, calling <code>boundListeners->notify()</code> is ignored).
|
||
|
|
Furthermore, <code>boundListeners->notify()</code> and this function have
|
||
|
|
to be called from the same thread.
|
||
|
|
|
||
|
|
@descr May throw
|
||
|
|
<code>com::sun::star::beans::PropertyVetoException</code>,
|
||
|
|
<code>com::sun::star::uno::RuntimeException</code> (and
|
||
|
|
<code>com::sun::star::lang::DisposedException</code> in particular), and
|
||
|
|
<code>std::bad_alloc</code>.
|
||
|
|
|
||
|
|
@param propertyName the name of the property (which is the same as the
|
||
|
|
name of the attribute that is going to be set)
|
||
|
|
|
||
|
|
@param oldValue the property value corresponding to the old attribute
|
||
|
|
value. This is only used as
|
||
|
|
<code>com::sun::star::beans::PropertyChangeEvent::OldValue</code>, which
|
||
|
|
is rather useless, anyway (see “Using the Observer Pattern”
|
||
|
|
in <a href="http://tools.openoffice.org/CodingGuidelines.sxw">
|
||
|
|
<cite>OpenOffice.org Coding Guidelines</cite></a>). If the attribute
|
||
|
|
that is going to be set is neither bound nor constrained, or if
|
||
|
|
<code>com::sun::star::beans::PropertyChangeEvent::OldValue</code> should
|
||
|
|
not be set, a <code>VOID</code> <code>Any</code> can be used instead.
|
||
|
|
|
||
|
|
@param newValue the property value corresponding to the new
|
||
|
|
attribute value. This is only used as
|
||
|
|
<code>com::sun::star::beans::PropertyChangeEvent::NewValue</code>, which
|
||
|
|
is rather useless, anyway (see “Using the Observer Pattern”
|
||
|
|
in <a href="http://tools.openoffice.org/CodingGuidelines.sxw">
|
||
|
|
<cite>OpenOffice.org Coding Guidelines</cite></a>), <em>unless</em> 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
|
||
|
|
<code>com::sun::star::beans::PropertyChangeEvent::NewValue</code> should
|
||
|
|
not be set, a <code>VOID</code> <code>Any</code> can be used instead.
|
||
|
|
|
||
|
|
@param boundListeners a pointer to a fresh
|
||
|
|
<code>cppu::PropertySetMixinImpl::BoundListeners</code> instance
|
||
|
|
(which has not been passed to this function before, and on which
|
||
|
|
<code>notify</code> has not yet been called); may only be null if the
|
||
|
|
attribute that is going to be set is not bound
|
||
|
|
*/
|
||
|
|
void prepareSet(
|
||
|
|
rtl::OUString const & propertyName,
|
||
|
|
com::sun::star::uno::Any const & oldValue,
|
||
|
|
com::sun::star::uno::Any const & newValue,
|
||
|
|
BoundListeners * boundListeners);
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short Mark this instance as being disposed.
|
||
|
|
|
||
|
|
@descr See <code>com::sun::star::lang::XComponent</code> for the general
|
||
|
|
concept of disposing UNO objects. On the first call to this function,
|
||
|
|
all registered listeners
|
||
|
|
(<code>com::sun::star::beans::XPropertyChangeListener</code>s and
|
||
|
|
<code>com::sun::star::beans::XVetoableChangeListener</code>s) are
|
||
|
|
notified of the disposing source. Any subsequent calls to this function
|
||
|
|
are ignored.
|
||
|
|
|
||
|
|
@descr May throw <code>com::sun::star::uno::RuntimeException</code> and
|
||
|
|
<code>std::bad_alloc</code>.
|
||
|
|
*/
|
||
|
|
void dispose();
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short A function used by subclasses of
|
||
|
|
<code>cppu::PropertySetMixin</code> when implementing
|
||
|
|
<code>com::sun::star::uno::XInterface::queryInterface</code>.
|
||
|
|
|
||
|
|
@descr This function checks for support of any of the UNO interface types
|
||
|
|
specified in the call of the <code>cppu::PropertySetMixin</code>
|
||
|
|
constructor. It does not check for any other UNO interface types (not
|
||
|
|
even for <code>com::sun::star::uno::XInterface</code>), and should not
|
||
|
|
be used directly as the implementation of
|
||
|
|
<code>com::sun::star::uno::XInterface::queryInterface</code> of this UNO
|
||
|
|
object.
|
||
|
|
*/
|
||
|
|
virtual com::sun::star::uno::Any SAL_CALL queryInterface(
|
||
|
|
com::sun::star::uno::Type const & type)
|
||
|
|
throw (com::sun::star::uno::RuntimeException);
|
||
|
|
|
||
|
|
// @see com::sun::star::beans::XPropertySet::getPropertySetInfo
|
||
|
|
virtual
|
||
|
|
com::sun::star::uno::Reference< com::sun::star::beans::XPropertySetInfo >
|
||
|
|
SAL_CALL getPropertySetInfo() throw (com::sun::star::uno::RuntimeException);
|
||
|
|
|
||
|
|
// @see com::sun::star::beans::XPropertySet::setPropertyValue
|
||
|
|
virtual void SAL_CALL setPropertyValue(
|
||
|
|
rtl::OUString const & propertyName,
|
||
|
|
com::sun::star::uno::Any const & 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);
|
||
|
|
|
||
|
|
// @see com::sun::star::beans::XPropertySet::getPropertyValue
|
||
|
|
virtual com::sun::star::uno::Any SAL_CALL getPropertyValue(
|
||
|
|
rtl::OUString const & propertyName)
|
||
|
|
throw (
|
||
|
|
com::sun::star::beans::UnknownPropertyException,
|
||
|
|
com::sun::star::lang::WrappedTargetException,
|
||
|
|
com::sun::star::uno::RuntimeException);
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short Adds a
|
||
|
|
<code>com::sun::star::beans::XPropertyChangeListener</code>.
|
||
|
|
|
||
|
|
@descr If the given property name is neither empty nor the name of a
|
||
|
|
bound property, the listener is registered nonetheless: it can be removed
|
||
|
|
again with a call to <code>removePropertyChangeListener</code>, and it is
|
||
|
|
notified when this object is disposed, but it will never be notified
|
||
|
|
about a property change event. Since this function does not check
|
||
|
|
whether the given property name is valid, it never throws
|
||
|
|
<code>com::sun::star::beans::UnknownPropertyException</code>.
|
||
|
|
|
||
|
|
@descr If a listener is added more than once, it will receive all
|
||
|
|
relevant notifications multiple times.
|
||
|
|
|
||
|
|
@see com::sun::star::beans::XPropertySet::addPropertyChangeListener
|
||
|
|
*/
|
||
|
|
virtual void SAL_CALL addPropertyChangeListener(
|
||
|
|
rtl::OUString const & propertyName,
|
||
|
|
com::sun::star::uno::Reference<
|
||
|
|
com::sun::star::beans::XPropertyChangeListener > const & listener)
|
||
|
|
throw (
|
||
|
|
com::sun::star::beans::UnknownPropertyException,
|
||
|
|
com::sun::star::lang::WrappedTargetException,
|
||
|
|
com::sun::star::uno::RuntimeException);
|
||
|
|
|
||
|
|
// @see com::sun::star::beans::XPropertySet::removePropertyChangeListener
|
||
|
|
virtual void SAL_CALL removePropertyChangeListener(
|
||
|
|
rtl::OUString const & propertyName,
|
||
|
|
com::sun::star::uno::Reference<
|
||
|
|
com::sun::star::beans::XPropertyChangeListener > const & listener)
|
||
|
|
throw (
|
||
|
|
com::sun::star::beans::UnknownPropertyException,
|
||
|
|
com::sun::star::lang::WrappedTargetException,
|
||
|
|
com::sun::star::uno::RuntimeException);
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short Adds a
|
||
|
|
<code>com::sun::star::beans::XVetoableChangeListener</code>.
|
||
|
|
|
||
|
|
@descr If the given property name is neither empty nor the name of a
|
||
|
|
constrained property, the listener is registered nonetheless: it can be
|
||
|
|
removed again with a call to <code>removeVetoableChangeListener</code>,
|
||
|
|
and it is notified when this object is disposed, but it will never be
|
||
|
|
notified about a property change event. Since this function does not
|
||
|
|
check whether the given property name is valid, it never throws
|
||
|
|
<code>com::sun::star::beans::UnknownPropertyException</code>.
|
||
|
|
|
||
|
|
@descr If a listener is added more than once, it will receive all
|
||
|
|
relevant notifications multiple times.
|
||
|
|
|
||
|
|
@see com::sun::star::beans::XPropertySet::addVetoableChangeListener
|
||
|
|
*/
|
||
|
|
virtual void SAL_CALL addVetoableChangeListener(
|
||
|
|
rtl::OUString const & propertyName,
|
||
|
|
com::sun::star::uno::Reference<
|
||
|
|
com::sun::star::beans::XVetoableChangeListener > const & listener)
|
||
|
|
throw (
|
||
|
|
com::sun::star::beans::UnknownPropertyException,
|
||
|
|
com::sun::star::lang::WrappedTargetException,
|
||
|
|
com::sun::star::uno::RuntimeException);
|
||
|
|
|
||
|
|
// @see com::sun::star::beans::XPropertySet::removeVetoableChangeListener
|
||
|
|
virtual void SAL_CALL removeVetoableChangeListener(
|
||
|
|
rtl::OUString const & propertyName,
|
||
|
|
com::sun::star::uno::Reference<
|
||
|
|
com::sun::star::beans::XVetoableChangeListener > const & listener)
|
||
|
|
throw (
|
||
|
|
com::sun::star::beans::UnknownPropertyException,
|
||
|
|
com::sun::star::lang::WrappedTargetException,
|
||
|
|
com::sun::star::uno::RuntimeException);
|
||
|
|
|
||
|
|
// @see com::sun::star::beans::XFastPropertySet::setFastPropertyValue
|
||
|
|
virtual void SAL_CALL setFastPropertyValue(
|
||
|
|
sal_Int32 handle, com::sun::star::uno::Any const & 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);
|
||
|
|
|
||
|
|
// @see com::sun::star::beans::XFastPropertySet::getFastPropertyValue
|
||
|
|
virtual com::sun::star::uno::Any SAL_CALL getFastPropertyValue(
|
||
|
|
sal_Int32 handle)
|
||
|
|
throw (
|
||
|
|
com::sun::star::beans::UnknownPropertyException,
|
||
|
|
com::sun::star::lang::WrappedTargetException,
|
||
|
|
com::sun::star::uno::RuntimeException);
|
||
|
|
|
||
|
|
// @see com::sun::star::beans::XPropertyAccess::getPropertyValues
|
||
|
|
virtual
|
||
|
|
com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >
|
||
|
|
SAL_CALL getPropertyValues() throw (com::sun::star::uno::RuntimeException);
|
||
|
|
|
||
|
|
// @see com::sun::star::beans::XPropertyAccess::setPropertyValues
|
||
|
|
virtual void SAL_CALL setPropertyValues(
|
||
|
|
com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >
|
||
|
|
const & 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);
|
||
|
|
|
||
|
|
private:
|
||
|
|
PropertySetMixinImpl(PropertySetMixinImpl &); // not defined
|
||
|
|
void operator =(PropertySetMixinImpl &); // not defined
|
||
|
|
|
||
|
|
PropertySetMixinImpl(
|
||
|
|
com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext >
|
||
|
|
const & context,
|
||
|
|
Implements implements,
|
||
|
|
com::sun::star::uno::Sequence< rtl::OUString > const & absentOptional,
|
||
|
|
com::sun::star::uno::Type const & type);
|
||
|
|
|
||
|
|
~PropertySetMixinImpl();
|
||
|
|
|
||
|
|
class Impl;
|
||
|
|
Impl * m_impl;
|
||
|
|
|
||
|
|
friend class Impl;
|
||
|
|
template< typename T > friend class PropertySetMixin;
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short A helper mixin to implement certain UNO interfaces related to property
|
||
|
|
set handling on top of the attributes of a given UNO interface type.
|
||
|
|
|
||
|
|
@descr The UNO interface type is specified by the type parameter
|
||
|
|
<code>T</code> (which must correspond to a UNO interface type).
|
||
|
|
|
||
|
|
@descr No specializations of this class template should be added by client
|
||
|
|
code.
|
||
|
|
|
||
|
|
@since #i51720#
|
||
|
|
*/
|
||
|
|
template< typename T > class PropertySetMixin: public PropertySetMixinImpl {
|
||
|
|
protected:
|
||
|
|
/**
|
||
|
|
@short The constructor.
|
||
|
|
|
||
|
|
@descr May throw <code>com::sun::star::uno::RuntimeException</code> and
|
||
|
|
<code>std::bad_alloc</code>.
|
||
|
|
|
||
|
|
@param context the component context used by this class template; must
|
||
|
|
not be null, and must supply the service
|
||
|
|
<code>com.sun.star.reflection.CoreReflection</code> and the singleton
|
||
|
|
<code>com.sun.star.reflection.theTypeDescriptionManager</code>
|
||
|
|
|
||
|
|
@param implements a combination of zero or more flags specifying what
|
||
|
|
UNO interface types shall be supported
|
||
|
|
|
||
|
|
@param absentOptional a list of optional properties that are not
|
||
|
|
present, and should thus not be visible via
|
||
|
|
<code>com::sun::star::beans::XPropertySet::getPropertySetInfo</code>.
|
||
|
|
For consistency reasons, the given <code>absentOptional</code> 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 <code>com::sun::star::beans::UnknownPropertyException</code>),
|
||
|
|
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
|
||
|
|
<code>com::sun::star::beans::UnknownPropertyException</code>) but is not
|
||
|
|
contained in the given <code>absentOptional</code>, then it will be
|
||
|
|
visible via
|
||
|
|
<code>com::sun::star::beans::XPropertySet::getPropertySetInfo</code> as a
|
||
|
|
<code>com::sun::star::beans::Property</code> with a set
|
||
|
|
<code>com::sun::star::beans::PropertyAttribute::OPTIONAL</code>. If the
|
||
|
|
given <code>implements</code> specifies that
|
||
|
|
<code>com::sun::star::beans::XPropertySet</code> is not supported, then
|
||
|
|
the given <code>absentOptional</code> is effectively ignored and can be
|
||
|
|
empty.
|
||
|
|
*/
|
||
|
|
PropertySetMixin(
|
||
|
|
com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext >
|
||
|
|
const & context,
|
||
|
|
Implements implements,
|
||
|
|
com::sun::star::uno::Sequence< rtl::OUString > const & absentOptional):
|
||
|
|
PropertySetMixinImpl(
|
||
|
|
context, implements, absentOptional, T::static_type())
|
||
|
|
{}
|
||
|
|
|
||
|
|
/**
|
||
|
|
@short The destructor.
|
||
|
|
|
||
|
|
@descr Does not throw.
|
||
|
|
*/
|
||
|
|
~PropertySetMixin() {}
|
||
|
|
|
||
|
|
private:
|
||
|
|
PropertySetMixin(PropertySetMixin &); // not defined
|
||
|
|
void operator =(PropertySetMixin); // not defined
|
||
|
|
};
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
#endif
|