OPropertySet.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 .
 */
#pragma once
 
// helper classes
#include <cppuhelper/basemutex.hxx>
#include <cppuhelper/propshlp.hxx>
 
// interfaces and types
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/beans/XPropertyState.hpp>
#include <com/sun/star/beans/XMultiPropertyStates.hpp>
#include <com/sun/star/style/XStyleSupplier.hpp>
#include "charttoolsdllapi.hxx"
 
#include <unordered_map>
 
namespace property
{
 
class OOO_DLLPUBLIC_CHARTTOOLS OPropertySet :
    protected cppu::BaseMutex,
    public ::cppu::OBroadcastHelper,
    // includes beans::XPropertySet, XMultiPropertySet and XFastPropertySet
    public ::cppu::OPropertySetHelper,
    // includes uno::XWeak (and XInterface, esp. ref-counting)
 
    public css::lang::XTypeProvider,
    public css::beans::XPropertyState,
    public css::beans::XMultiPropertyStates,
    public css::style::XStyleSupplier
{
public:
    OPropertySet();
    virtual ~OPropertySet();
 
protected:
    explicit OPropertySet( const OPropertySet & rOther );
 
    void SetNewValuesExplicitlyEvenIfTheyEqualDefault();
 
    virtual void GetDefaultValue( sal_Int32 nHandle, css::uno::Any& rAny ) const = 0;
 
    virtual ::cppu::IPropertyArrayHelper & SAL_CALL getInfoHelper() override = 0;
 
    virtual sal_Bool SAL_CALL convertFastPropertyValue
        ( css::uno::Any & rConvertedValue,
          css::uno::Any & rOldValue,
          sal_Int32 nHandle,
          const css::uno::Any& rValue ) override final;
 
    virtual void SAL_CALL setFastPropertyValue_NoBroadcast
        ( sal_Int32 nHandle,
          const css::uno::Any& rValue ) override;
 
    virtual void SAL_CALL getFastPropertyValue
        ( css::uno::Any& rValue,
          sal_Int32 nHandle ) const override;
 
    virtual void firePropertyChangeEvent();
 
public:
    using ::cppu::OPropertySetHelper::getFastPropertyValue;
 
    // Interfaces
 
    // ____ XInterface ____
    virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& aType ) override;
 
    // ____ XTypeProvider ____
    virtual css::uno::Sequence< css::uno::Type > SAL_CALL
        getTypes() override;
    virtual css::uno::Sequence< sal_Int8 > SAL_CALL
        getImplementationId() override;
 
    // ____ XPropertyState ____
    virtual css::beans::PropertyState SAL_CALL
        getPropertyState( const OUString& PropertyName ) override final;
    virtual css::uno::Sequence< css::beans::PropertyState > SAL_CALL
        getPropertyStates( const css::uno::Sequence< OUString >& aPropertyName ) override final;
    virtual void SAL_CALL
        setPropertyToDefault( const OUString& PropertyName ) override final;
    virtual css::uno::Any SAL_CALL
        getPropertyDefault( const OUString& aPropertyName ) override final;
 
    // ____ XMultiPropertyStates ____
    // Note: getPropertyStates() is already implemented in XPropertyState with the
    // same signature
    virtual void SAL_CALL
        setAllPropertiesToDefault() override final;
    virtual void SAL_CALL
        setPropertiesToDefault( const css::uno::Sequence< OUString >& aPropertyNames ) override final;
    virtual css::uno::Sequence< css::uno::Any > SAL_CALL
        getPropertyDefaults( const css::uno::Sequence< OUString >& aPropertyNames ) override final;
 
    // ____ XStyleSupplier ____
    virtual css::uno::Reference< css::style::XStyle > SAL_CALL getStyle() override final;
    virtual void SAL_CALL setStyle( const css::uno::Reference< css::style::XStyle >& xStyle ) override final;
 
    // ____ XMultiPropertySet ____
    virtual void SAL_CALL setPropertyValues(
        const css::uno::Sequence< OUString >& PropertyNames,
        const css::uno::Sequence< css::uno::Any >& Values ) override final;
 
    // ____ XFastPropertySet ____
    virtual void SAL_CALL setFastPropertyValue( sal_Int32 nHandle, const css::uno::Any& rValue ) override final;
 
    // Note: it is assumed that the base class implements setPropertyValue by
    // using setFastPropertyValue
 
private:
    css::beans::PropertyState
        GetPropertyStateByHandle( sal_Int32 nHandle ) const;
 
    css::uno::Sequence< css::beans::PropertyState >
        GetPropertyStatesByHandle( const std::vector< sal_Int32 > & aHandles ) const;
 
    void SetPropertyToDefault( sal_Int32 nHandle );
    void SetPropertiesToDefault( const std::vector< sal_Int32 > & aHandles );
    void SetAllPropertiesToDefault();
 
    bool GetPropertyValueByHandle(
        css::uno::Any & rValue,
        sal_Int32 nHandle ) const;
 
    void SetPropertyValueByHandle( sal_Int32 nHandle,
                                   const css::uno::Any & rValue );
 
    bool SetStyle( const css::uno::Reference< css::style::XStyle > & xStyle );
 
    bool m_bSetNewValuesExplicitlyEvenIfTheyEqualDefault;
    std::unordered_map< sal_Int32, css::uno::Any >    m_aProperties;
    css::uno::Reference< css::style::XStyle > m_xStyle;
};
 
} //  namespace property
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */