reportdesign/source/core/inc/FormattedField.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: FormattedField.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef RPT_FORMATTEDFIELD_HXX
  31 #define RPT_FORMATTEDFIELD_HXX
  32
  33 #include <cppuhelper/propertysetmixin.hxx>
  34 #include <com/sun/star/report/XFormattedField.hpp>
  35 #include <com/sun/star/report/Function.hpp>
  36 #include "ReportControlModel.hxx"
  37 #include <cppuhelper/compbase2.hxx>
  38 #include <comphelper/broadcasthelper.hxx>
  39 #include <com/sun/star/lang/XServiceInfo.hpp>
  40 #include "ReportHelperDefines.hxx"
  41 namespace reportdesign
  42 {
  43     typedef ::cppu::PropertySetMixin<            com::sun::star::report::XFormattedField        > FormattedFieldPropertySet;
  44     typedef ::cppu::WeakComponentImplHelper2<    com::sun::star::report::XFormattedField
  45                                                 ,com::sun::star::lang::XServiceInfo     > FormattedFieldBase;
  46
  47     /** \class OFormattedField Defines the implementation of a \interface com:::sun::star::report::XFormattedField
  48      * \ingroup reportdesign_api
  49      *
  50      */
  51     class OFormattedField :     public comphelper::OBaseMutex,
  52                             public FormattedFieldBase,
  53                             public FormattedFieldPropertySet
  54     {
  55         friend class OShapeHelper;
  56
  57         OReportControlModel                                                             m_aProps;
  58         ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier >
  59                                                         m_xFormatsSupplier;
  60         ::com::sun::star::uno::Reference< ::com::sun::star::report::XFunction> m_xFunction;
  61         ::sal_Int32                                     m_nFormatKey;
  62
  63     private:
  64         OFormattedField(const OFormattedField&);
  65         OFormattedField& operator=(const OFormattedField&);
  66
  67         template <typename T> void set(  const ::rtl::OUString& _sProperty
  68                                         ,const T& _Value
  69                                         ,T& _member)
  70         {
  71             BoundListeners l;
  72             {
  73                 ::osl::MutexGuard aGuard(m_aMutex);
  74                 if ( _member != _Value )
  75                 {
  76                     prepareSet(_sProperty, ::com::sun::star::uno::makeAny(_member), ::com::sun::star::uno::makeAny(_Value), &l);
  77                     _member = _Value;
  78                 }
  79             }
  80             l.notify();
  81         }
  82         void checkIndex(sal_Int32 _nIndex);
  83     protected:
  84         virtual ~OFormattedField();
  85     public:
  86         explicit OFormattedField(::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > const & _xContext);
  87         explicit OFormattedField(::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > const & _xContext
  88                                  ,const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > & _xFactory
  89                                  ,::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape >& _xShape);
  90
  91         DECLARE_XINTERFACE( )
  92         // ::com::sun::star::lang::XServiceInfo
  93         virtual ::sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName ) throw (::com::sun::star::uno::RuntimeException);
  94         virtual ::rtl::OUString SAL_CALL getImplementationName(  ) throw(::com::sun::star::uno::RuntimeException);
  95         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  ) throw(::com::sun::star::uno::RuntimeException);
  96
  97         static ::com::sun::star::uno::Sequence< ::rtl::OUString > getSupportedServiceNames_Static(void) throw( ::com::sun::star::uno::RuntimeException );
  98         static ::rtl::OUString getImplementationName_Static(void) throw( ::com::sun::star::uno::RuntimeException );
  99         static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL
 100             create(::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > const & xContext);
 101         // com::sun::star::beans::XPropertySet
 102         virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) throw(::com::sun::star::uno::RuntimeException);
 103         virtual void SAL_CALL setPropertyValue( const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Any& aValue ) 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);
 104         virtual ::com::sun::star::uno::Any SAL_CALL getPropertyValue( const ::rtl::OUString& PropertyName ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 105         virtual void SAL_CALL addPropertyChangeListener( const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& xListener ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 106         virtual void SAL_CALL removePropertyChangeListener( const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& aListener ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 107         virtual void SAL_CALL addVetoableChangeListener( const ::rtl::OUString& PropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener >& aListener ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 108         virtual void SAL_CALL removeVetoableChangeListener( const ::rtl::OUString& PropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener >& aListener ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 109
 110         // XContainer
 111         virtual void SAL_CALL addContainerListener( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XContainerListener >& xListener ) throw (::com::sun::star::uno::RuntimeException);
 112         virtual void SAL_CALL removeContainerListener( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XContainerListener >& xListener ) throw (::com::sun::star::uno::RuntimeException);
 113
 114         // XElementAccess
 115         virtual ::com::sun::star::uno::Type SAL_CALL getElementType(  ) throw (::com::sun::star::uno::RuntimeException);
 116         virtual ::sal_Bool SAL_CALL hasElements(  ) throw (::com::sun::star::uno::RuntimeException);
 117
 118         // XIndexReplace
 119         virtual void SAL_CALL replaceByIndex( ::sal_Int32 Index, const ::com::sun::star::uno::Any& Element ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 120
 121         // XIndexContainer
 122         virtual void SAL_CALL insertByIndex( ::sal_Int32 Index, const ::com::sun::star::uno::Any& Element ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 123         virtual void SAL_CALL removeByIndex( ::sal_Int32 Index ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 124
 125         // XIndexAccess
 126         virtual ::sal_Int32 SAL_CALL getCount(  ) throw (::com::sun::star::uno::RuntimeException);
 127         virtual ::com::sun::star::uno::Any SAL_CALL getByIndex( ::sal_Int32 Index ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
 128
 129         // XReportComponent
 130         REPORTCOMPONENT_HEADER()
 131
 132         // XShape
 133         SHAPE_HEADER()
 134
 135         // XShapeDescriptor
 136         virtual ::rtl::OUString SAL_CALL getShapeType(  ) throw (::com::sun::star::uno::RuntimeException);
 137
 138         // XReportControlModel
 139         REPORTCONTROLMODEL_HEADER()
 140
 141         // XReportControlFormat
 142         REPORTCONTROLFORMAT_HEADER()
 143
 144         // XCloneable
 145         virtual ::com::sun::star::uno::Reference< ::com::sun::star::util::XCloneable > SAL_CALL createClone(  ) throw (::com::sun::star::uno::RuntimeException);
 146
 147         // XFormattedField
 148         virtual ::sal_Int32 SAL_CALL getFormatKey() throw (::com::sun::star::uno::RuntimeException);
 149         virtual void SAL_CALL setFormatKey(::sal_Int32 the_value) throw (::com::sun::star::uno::RuntimeException);
 150         virtual ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier > SAL_CALL getFormatsSupplier() throw (::com::sun::star::uno::RuntimeException);
 151         virtual void SAL_CALL setFormatsSupplier( const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier >& _formatssupplier ) throw (::com::sun::star::uno::RuntimeException);
 152
 153         // XComponent
 154         virtual void SAL_CALL dispose() throw(::com::sun::star::uno::RuntimeException);
 155         virtual void SAL_CALL addEventListener(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener > & aListener) throw(::com::sun::star::uno::RuntimeException)
 156         {
 157             cppu::WeakComponentImplHelperBase::addEventListener(aListener);
 158         }
 159         virtual void SAL_CALL removeEventListener(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener > & aListener) throw(::com::sun::star::uno::RuntimeException)
 160         {
 161             cppu::WeakComponentImplHelperBase::removeEventListener(aListener);
 162         }
 163
 164         // XChild
 165         virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getParent(  ) throw (::com::sun::star::uno::RuntimeException);
 166         virtual void SAL_CALL setParent( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& Parent ) throw (::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException);
 167     };
 168 }
 169 #endif //RPT_FORMATTEDFIELD_HXX
 170