propertysetmixin.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
/*
 * This file is part of LibreOffice published API.
 */
 
#ifndef INCLUDED_CPPUHELPER_PROPERTYSETMIXIN_HXX
#define INCLUDED_CPPUHELPER_PROPERTYSETMIXIN_HXX
 
#include "sal/config.h"
 
#include "com/sun/star/beans/XFastPropertySet.hpp"
#include "com/sun/star/beans/XPropertyAccess.hpp"
#include "com/sun/star/beans/XPropertySet.hpp"
#include "com/sun/star/uno/Reference.h"
#include "com/sun/star/uno/Sequence.hxx"
#include "sal/types.h"
#include "cppuhelper/cppuhelperdllapi.h"
 
namespace com { namespace sun { namespace star {
    namespace beans {
        class XPropertyChangeListener;
        class XPropertySetInfo;
        class XVetoableChangeListener;
        struct PropertyValue;
    }
    namespace uno {
        class Type;
        class XComponentContext;
    }
} } }
 
namespace cppu {
 
class CPPUHELPER_DLLPUBLIC PropertySetMixinImpl:
    public css::beans::XPropertySet,
    public css::beans::XFastPropertySet,
    public css::beans::XPropertyAccess
{
protected:
    enum Implements {
        IMPLEMENTS_PROPERTY_SET = 1,
 
        IMPLEMENTS_FAST_PROPERTY_SET = 2,
 
        IMPLEMENTS_PROPERTY_ACCESS = 4
    };
 
    class CPPUHELPER_DLLPUBLIC BoundListeners {
    public:
        BoundListeners();
 
        ~BoundListeners();
 
        void notify() const;
 
    private:
        BoundListeners( const BoundListeners&) SAL_DELETED_FUNCTION;
        void operator=( const BoundListeners&) SAL_DELETED_FUNCTION;
 
        class Impl;
        Impl * m_impl;
 
        friend class PropertySetMixinImpl;
    };
 
    void prepareSet(
        rtl::OUString const & propertyName,
        css::uno::Any const & oldValue,
        css::uno::Any const & newValue,
        BoundListeners * boundListeners);
 
    void dispose();
 
    virtual css::uno::Any SAL_CALL queryInterface(
        css::uno::Type const & type) SAL_OVERRIDE;
 
    // @see css::beans::XPropertySet::getPropertySetInfo
    virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo() SAL_OVERRIDE;
 
    // @see css::beans::XPropertySet::setPropertyValue
    virtual void SAL_CALL setPropertyValue(
        rtl::OUString const & propertyName,
        css::uno::Any const & value) SAL_OVERRIDE;
 
    // @see css::beans::XPropertySet::getPropertyValue
    virtual css::uno::Any SAL_CALL getPropertyValue(
        rtl::OUString const & propertyName) SAL_OVERRIDE;
 
    virtual void SAL_CALL addPropertyChangeListener(
        rtl::OUString const & propertyName,
        css::uno::Reference<
        css::beans::XPropertyChangeListener > const & listener) SAL_OVERRIDE;
 
    // @see css::beans::XPropertySet::removePropertyChangeListener
    virtual void SAL_CALL removePropertyChangeListener(
        rtl::OUString const & propertyName,
        css::uno::Reference<
        css::beans::XPropertyChangeListener > const & listener) SAL_OVERRIDE;
 
    virtual void SAL_CALL addVetoableChangeListener(
        rtl::OUString const & propertyName,
        css::uno::Reference<
        css::beans::XVetoableChangeListener > const & listener) SAL_OVERRIDE;
 
    // @see css::beans::XPropertySet::removeVetoableChangeListener
    virtual void SAL_CALL removeVetoableChangeListener(
        rtl::OUString const & propertyName,
        css::uno::Reference<
        css::beans::XVetoableChangeListener > const & listener) SAL_OVERRIDE;
 
    // @see css::beans::XFastPropertySet::setFastPropertyValue
    virtual void SAL_CALL setFastPropertyValue(
        sal_Int32 handle, css::uno::Any const & value) SAL_OVERRIDE;
 
    // @see css::beans::XFastPropertySet::getFastPropertyValue
    virtual css::uno::Any SAL_CALL getFastPropertyValue(
        sal_Int32 handle) SAL_OVERRIDE;
 
    // @see css::beans::XPropertyAccess::getPropertyValues
    virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL getPropertyValues() SAL_OVERRIDE;
 
    // @see css::beans::XPropertyAccess::setPropertyValues
    virtual void SAL_CALL setPropertyValues(
        css::uno::Sequence< css::beans::PropertyValue > const & props) SAL_OVERRIDE;
 
private:
    PropertySetMixinImpl( const PropertySetMixinImpl&) SAL_DELETED_FUNCTION;
    void operator=( const PropertySetMixinImpl&) SAL_DELETED_FUNCTION;
 
    PropertySetMixinImpl(
        css::uno::Reference< css::uno::XComponentContext > const & context,
        Implements implements,
        css::uno::Sequence< rtl::OUString > const & absentOptional,
        css::uno::Type const & type);
 
    class Impl;
    Impl * m_impl;
 
    friend class Impl;
    template< typename T > friend class PropertySetMixin;
 
    ~PropertySetMixinImpl();
 
    void checkUnknown(rtl::OUString const & propertyName);
};
 
template< typename T > class PropertySetMixin: public PropertySetMixinImpl {
protected:
    PropertySetMixin(
        css::uno::Reference< css::uno::XComponentContext > const & context,
        Implements implements,
        css::uno::Sequence< rtl::OUString > const & absentOptional):
        PropertySetMixinImpl(
            context, implements, absentOptional, T::static_type())
    {}
 
    ~PropertySetMixin() {}
 
private:
    PropertySetMixin( const PropertySetMixin&) SAL_DELETED_FUNCTION;
    void operator=( const PropertySetMixin&) SAL_DELETED_FUNCTION;
};
 
}
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */