chart2/source/inc/WrappedProperty.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef CHART_WRAPPEDPROPERTY_HXX
  28 #define CHART_WRAPPEDPROPERTY_HXX
  29
  30 #include <com/sun/star/beans/XPropertySet.hpp>
  31 #include <com/sun/star/beans/XPropertyState.hpp>
  32 #include "charttoolsdllapi.hxx"
  33
  34 #include <map>
  35
  36 //.............................................................................
  37 namespace chart
  38 {
  39 //.............................................................................
  40
  41 class OOO_DLLPUBLIC_CHARTTOOLS WrappedProperty
  42 {
  43     /** The property visible to the outer PropertySet in the PropertySetWrapper may have a different name, type and value than
  44     a corresponding property of the inner PropertySet. Use this class to do the conversion between the two.
  45     */
  46 public:
  47     WrappedProperty( const ::rtl::OUString& rOuterName, const ::rtl::OUString& rInnerName );
  48     virtual ~WrappedProperty();
  49
  50     const ::rtl::OUString& getOuterName() const;
  51     virtual ::rtl::OUString getInnerName() const;
  52
  53     virtual void setPropertyValue( const ::com::sun::star::uno::Any& rOuterValue, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& xInnerPropertySet ) const
  54                         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);
  55
  56     virtual ::com::sun::star::uno::Any getPropertyValue( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& xInnerPropertySet ) const
  57                         throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
  58
  59     virtual void setPropertyToDefault( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyState >& xInnerPropertyState ) const
  60                         throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
  61
  62     virtual ::com::sun::star::uno::Any getPropertyDefault( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyState >& xInnerPropertyState ) const
  63                         throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
  64
  65     virtual ::com::sun::star::beans::PropertyState getPropertyState( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyState >& xInnerPropertyState ) const
  66                         throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
  67
  68 protected:
  69     virtual ::com::sun::star::uno::Any convertInnerToOuterValue( const ::com::sun::star::uno::Any& rInnerValue ) const;
  70     virtual ::com::sun::star::uno::Any convertOuterToInnerValue( const ::com::sun::star::uno::Any& rOuterValue ) const;
  71
  72 protected:
  73     ::rtl::OUString             m_aOuterName;
  74     ::rtl::OUString             m_aInnerName;
  75 };
  76
  77 //.............................................................................
  78
  79 typedef ::std::map< sal_Int32, const WrappedProperty* > tWrappedPropertyMap;
  80
  81 //.............................................................................
  82 } //namespace chart
  83 //.............................................................................
  84
  85 // CHART_WRAPPEDPROPERTY_HXX
  86 #endif