chart2/source/inc/WrappedPropertySet.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_CHART2_SOURCE_INC_WRAPPEDPROPERTYSET_HXX
  20 #define INCLUDED_CHART2_SOURCE_INC_WRAPPEDPROPERTYSET_HXX
  21
  22 #include "WrappedProperty.hxx"
  23 #include "MutexContainer.hxx"
  24 #include "charttoolsdllapi.hxx"
  25 #include <com/sun/star/beans/XMultiPropertySet.hpp>
  26 #include <com/sun/star/beans/XMultiPropertyStates.hpp>
  27 #include <com/sun/star/beans/XPropertySet.hpp>
  28 #include <com/sun/star/beans/XPropertyState.hpp>
  29 #include <cppuhelper/implbase.hxx>
  30
  31 #include <memory>
  32 #include <vector>
  33
  34 namespace cppu { class IPropertyArrayHelper; }
  35 namespace cppu { class OPropertyArrayHelper; }
  36
  37 namespace chart
  38 {
  39
  40 class OOO_DLLPUBLIC_CHARTTOOLS WrappedPropertySet :
  41                            public MutexContainer
  42                          , public ::cppu::WeakImplHelper
  43                          < css::beans::XPropertySet
  44                          , css::beans::XMultiPropertySet
  45                          , css::beans::XPropertyState
  46                          , css::beans::XMultiPropertyStates
  47                          >
  48 {
  49 public:
  50     WrappedPropertySet();
  51     virtual ~WrappedPropertySet() override;
  52
  53     void clearWrappedPropertySet();
  54
  55 public:
  56     //XPropertySet
  57     virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) override;
  58
  59     virtual void SAL_CALL setPropertyValue( const OUString& aPropertyName, const css::uno::Any& aValue ) override;
  60     virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
  61
  62     virtual void SAL_CALL addPropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener ) override;
  63     virtual void SAL_CALL removePropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& aListener ) override;
  64     virtual void SAL_CALL addVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
  65     virtual void SAL_CALL removeVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
  66
  67     //XMultiPropertySet
  68     //getPropertySetInfo() already declared in XPropertySet
  69     virtual void SAL_CALL setPropertyValues( const css::uno::Sequence< OUString >& aPropertyNames, const css::uno::Sequence< css::uno::Any >& aValues ) override;
  70     virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPropertyValues( const css::uno::Sequence< OUString >& aPropertyNames ) override;
  71     virtual void SAL_CALL addPropertiesChangeListener( const css::uno::Sequence< OUString >& aPropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener >& xListener ) override;
  72     virtual void SAL_CALL removePropertiesChangeListener( const css::uno::Reference< css::beans::XPropertiesChangeListener >& xListener ) override;
  73     virtual void SAL_CALL firePropertiesChangeEvent( const css::uno::Sequence< OUString >& aPropertyNames, const css::uno::Reference< css::beans::XPropertiesChangeListener >& xListener ) override;
  74
  75     //XPropertyState
  76     virtual css::beans::PropertyState SAL_CALL getPropertyState( const OUString& PropertyName ) override;
  77     virtual css::uno::Sequence< css::beans::PropertyState > SAL_CALL getPropertyStates( const css::uno::Sequence< OUString >& aPropertyName ) override;
  78     virtual void SAL_CALL setPropertyToDefault( const OUString& PropertyName ) override;
  79     virtual css::uno::Any SAL_CALL getPropertyDefault( const OUString& aPropertyName ) override;
  80
  81     //XMultiPropertyStates
  82     //getPropertyStates() already declared in XPropertyState
  83     virtual void SAL_CALL setAllPropertiesToDefault(  ) override;
  84     virtual void SAL_CALL setPropertiesToDefault( const css::uno::Sequence< OUString >& aPropertyNames ) override;
  85     virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPropertyDefaults( const css::uno::Sequence< OUString >& aPropertyNames ) override;
  86
  87 protected: //methods
  88     /** give all the properties that should be visible to the outer side
  89     */
  90     virtual const css::uno::Sequence< css::beans::Property >& getPropertySequence()=0;
  91     /** give a list of all properties that need a special treatment;
  92     properties that are not in this list will be wrapped identical.
  93     The base class 'WrappedPropertySet' will take ownership on the contained pointer.
  94     It is not allowed to have duplicate entries in this list.
  95     */
  96     virtual std::vector< std::unique_ptr<WrappedProperty> > createWrappedProperties()=0;
  97
  98     virtual css::uno::Reference< css::beans::XPropertySet > getInnerPropertySet() = 0;
  99     SAL_DLLPRIVATE css::uno::Reference< css::beans::XPropertyState > getInnerPropertyState();
 100
 101     ::cppu::IPropertyArrayHelper&   getInfoHelper();
 102     SAL_DLLPRIVATE tWrappedPropertyMap&            getWrappedPropertyMap();
 103
 104     const WrappedProperty*          getWrappedProperty( const OUString& rOuterName );
 105     const WrappedProperty*          getWrappedProperty( sal_Int32 nHandle );
 106
 107 protected: //member
 108     css::uno::Reference< css::beans::XPropertySetInfo >     m_xInfo;//outer PropertySetInfo
 109
 110     std::unique_ptr<::cppu::OPropertyArrayHelper>       m_pPropertyArrayHelper;//holds all possible outer properties
 111
 112     std::unique_ptr<tWrappedPropertyMap>                m_pWrappedPropertyMap;//holds all wrapped properties (containing the special mapping from inner to outer properties)
 113
 114     //Container for the XPropertyChangedListener. The listeners are inserted by handle.
 115     //OMultiTypeInterfaceContainerHelperInt32             m_aBoundListenerContainer;
 116
 117     //Container for the XPropertyVetoableListener. The listeners are inserted by handle.
 118     //OMultiTypeInterfaceContainerHelperInt32             m_aVetoableListenerContainer;
 119 };
 120
 121 } //namespace chart
 122
 123 // INCLUDED_CHART2_SOURCE_INC_WRAPPEDPROPERTYSET_HXX
 124 #endif
 125
 126 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */