reportdesign/source/core/inc/Section.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: Section.hxx,v $
  10  * $Revision: 1.4 $
  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 REPORTDESIGN_API_SECTION_HXX
  31 #define REPORTDESIGN_API_SECTION_HXX
  32
  33 #include <com/sun/star/report/XSection.hpp>
  34 #include <cppuhelper/compbase3.hxx>
  35 #include <comphelper/broadcasthelper.hxx>
  36 #include <comphelper/uno3.hxx>
  37 #include <comphelper/types.hxx>
  38 #include <cppuhelper/propertysetmixin.hxx>
  39 #include <com/sun/star/uno/XComponentContext.hpp>
  40 #include <com/sun/star/drawing/XShapes.hpp>
  41 #include <com/sun/star/uno/XAggregation.hpp>
  42 #include <comphelper/stl_types.hxx>
  43 #include <comphelper/implementationreference.hxx>
  44 #include <com/sun/star/lang/XUnoTunnel.hpp>
  45 #include <com/sun/star/lang/XServiceInfo.hpp>
  46
  47 namespace reportdesign
  48 {
  49     typedef ::cppu::WeakComponentImplHelper3<   ::com::sun::star::report::XSection
  50                                             ,   ::com::sun::star::lang::XServiceInfo
  51                                             ,   ::com::sun::star::lang::XUnoTunnel> SectionBase;
  52         typedef ::cppu::PropertySetMixin<com::sun::star::report::XSection> SectionPropertySet;
  53
  54         class OSection : public comphelper::OMutexAndBroadcastHelper,
  55                                         public SectionBase,
  56                                         public SectionPropertySet
  57         {
  58         ::cppu::OInterfaceContainerHelper                                                                                                       m_aContainerListeners;
  59                 ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >            m_xContext;
  60         ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShapes >                  m_xDrawPage;
  61         ::com::sun::star::uno::Reference< ::com::sun::star::uno::XAggregation >             m_xProxy;
  62                 ::com::sun::star::uno::WeakReference< ::com::sun::star::report::XGroup >                        m_xGroup;
  63                 ::com::sun::star::uno::WeakReference< ::com::sun::star::report::XReportDefinition > m_xReportDefinition;
  64                 ::rtl::OUString                                                                                                                                         m_sName;
  65                 ::rtl::OUString                                                                                                                                         m_sConditionalPrintExpression;
  66                 ::sal_uInt32                                                                                                                                            m_nHeight;
  67                 ::sal_Int32                                                                                                                                             m_nBackgroundColor;
  68                 ::sal_Int16                                                                                                                                             m_nForceNewPage;
  69                 ::sal_Int16                                                                                                                                             m_nNewRowOrCol;
  70                 ::sal_Bool                                                                                                                                                      m_bKeepTogether;
  71                 ::sal_Bool                                                                                                                                                      m_bCanGrow;
  72                 ::sal_Bool                                                                                                                                                      m_bCanShrink;
  73                 ::sal_Bool                                                                                                                                                      m_bRepeatSection;
  74                 ::sal_Bool                                                                                                                                                      m_bVisible;
  75         ::sal_Bool                                                                                                                                                      m_bBacktransparent;
  76         bool                                                                                m_bInRemoveNotify;
  77         bool                                                                                m_bInInsertNotify;
  78
  79         private:
  80                 OSection(const OSection&);
  81                 OSection& operator=(const OSection&);
  82
  83                 template <typename T> void set(  const ::rtl::OUString& _sProperty
  84                                                                                 ,const T& _Value
  85                                                                                 ,T& _member)
  86                 {
  87                         BoundListeners l;
  88                         {
  89                                 ::osl::MutexGuard aGuard(m_aMutex);
  90                 if ( _member != _Value )
  91                 {
  92                                     prepareSet(_sProperty, ::com::sun::star::uno::makeAny(_member), ::com::sun::star::uno::makeAny(_Value), &l);
  93                                     _member = _Value;
  94                 }
  95                         }
  96                         l.notify();
  97                 }
  98
  99         /** checks if this section is eiter the page header or footer and if so it throws an UnknownPropertyException
 100         *
 101         */
 102         void checkNotPageHeaderFooter();
 103
 104         void init();
 105         protected:
 106         // TODO: VirtualFunctionFinder: This is virtual function!
 107         //
 108         virtual ~OSection();
 109
 110         /** this function is called upon disposing the component
 111         */
 112         // TODO: VirtualFunctionFinder: This is virtual function!
 113         //
 114         virtual void SAL_CALL disposing();
 115         public:
 116                 typedef ::comphelper::ImplementationReference< OSection ,::com::sun::star::report::XSection,::com::sun::star::uno::XWeak > TSection;
 117
 118                 OSection(const ::com::sun::star::uno::Reference< ::com::sun::star::report::XReportDefinition >& _xParent
 119                                 ,const com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext >& context,bool _bPageSection=false);
 120                 OSection(const ::com::sun::star::uno::Reference< ::com::sun::star::report::XGroup >& _xParent
 121                                 ,const com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext >& context,bool _bPageSection=false);
 122
 123                 DECLARE_XINTERFACE( )
 124
 125                 // ::com::sun::star::lang::XServiceInfo
 126                 virtual ::sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName ) throw (::com::sun::star::uno::RuntimeException);
 127                 virtual ::rtl::OUString SAL_CALL getImplementationName(  ) throw(::com::sun::star::uno::RuntimeException);
 128                 virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  ) throw(::com::sun::star::uno::RuntimeException);
 129
 130                 static ::com::sun::star::uno::Sequence< ::rtl::OUString > getSupportedServiceNames_Static(void) throw( ::com::sun::star::uno::RuntimeException );
 131                 // com::sun::star::beans::XPropertySet
 132                 virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) throw(::com::sun::star::uno::RuntimeException);
 133                 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);
 134                 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);
 135                 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);
 136                 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);
 137                 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);
 138                 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);
 139
 140                 // XSection
 141                 virtual ::sal_Bool SAL_CALL getVisible() throw (::com::sun::star::uno::RuntimeException);
 142                 virtual void SAL_CALL setVisible( ::sal_Bool _visible ) throw (::com::sun::star::uno::RuntimeException);
 143                 virtual ::rtl::OUString SAL_CALL getName() throw (::com::sun::star::uno::RuntimeException);
 144                 virtual void SAL_CALL setName( const ::rtl::OUString& _name ) throw (::com::sun::star::uno::RuntimeException);
 145                 virtual ::sal_uInt32 SAL_CALL getHeight() throw (::com::sun::star::uno::RuntimeException);
 146                 virtual void SAL_CALL setHeight( ::sal_uInt32 _height ) throw (::com::sun::star::uno::RuntimeException);
 147                 virtual ::sal_Int32 SAL_CALL getBackColor() throw (::com::sun::star::uno::RuntimeException);
 148                 virtual void SAL_CALL setBackColor( ::sal_Int32 _backgroundcolor ) throw (::com::sun::star::uno::RuntimeException);
 149         virtual ::sal_Bool SAL_CALL getBackTransparent() throw (::com::sun::star::uno::RuntimeException);
 150         virtual void SAL_CALL setBackTransparent( ::sal_Bool _backtransparent ) throw (::com::sun::star::uno::RuntimeException);
 151                 virtual ::rtl::OUString SAL_CALL getConditionalPrintExpression() throw (::com::sun::star::uno::RuntimeException);
 152                 virtual void SAL_CALL setConditionalPrintExpression( const ::rtl::OUString& _conditionalprintexpression ) throw (::com::sun::star::uno::RuntimeException);
 153                 virtual ::sal_Int16 SAL_CALL getForceNewPage() throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
 154                 virtual void SAL_CALL setForceNewPage( ::sal_Int16 _forcenewpage ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
 155                 virtual ::sal_Int16 SAL_CALL getNewRowOrCol() throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
 156                 virtual void SAL_CALL setNewRowOrCol( ::sal_Int16 _newroworcol ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
 157                 virtual ::sal_Bool SAL_CALL getKeepTogether() throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
 158                 virtual void SAL_CALL setKeepTogether( ::sal_Bool _keeptogether ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
 159                 virtual ::sal_Bool SAL_CALL getCanGrow() throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
 160                 virtual void SAL_CALL setCanGrow( ::sal_Bool _cangrow ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
 161                 virtual ::sal_Bool SAL_CALL getCanShrink() throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
 162                 virtual void SAL_CALL setCanShrink( ::sal_Bool _canshrink ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
 163                 virtual ::sal_Bool SAL_CALL getRepeatSection() throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
 164                 virtual void SAL_CALL setRepeatSection( ::sal_Bool _repeatsection ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
 165                 virtual ::com::sun::star::uno::Reference< ::com::sun::star::report::XGroup > SAL_CALL getGroup() throw (::com::sun::star::uno::RuntimeException);
 166                 virtual ::com::sun::star::uno::Reference< ::com::sun::star::report::XReportDefinition > SAL_CALL getReportDefinition() throw (::com::sun::star::uno::RuntimeException);
 167
 168                 virtual ::com::sun::star::uno::Reference< ::com::sun::star::report::XReportComponent > SAL_CALL createReportComponent( const ::rtl::OUString& _sReportComponentSpecifier ) throw (::com::sun::star::uno::Exception, ::com::sun::star::lang::IllegalArgumentException,::com::sun::star::uno::RuntimeException);
 169             virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getAvailableReportComponentNames(  ) throw (::com::sun::star::uno::RuntimeException);
 170                 // XChild
 171                 virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getParent(  ) throw (::com::sun::star::uno::RuntimeException);
 172                 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);
 173                 // XContainer
 174                 virtual void SAL_CALL addContainerListener( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XContainerListener >& xListener ) throw (::com::sun::star::uno::RuntimeException);
 175                 virtual void SAL_CALL removeContainerListener( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XContainerListener >& xListener ) throw (::com::sun::star::uno::RuntimeException);
 176                 // XElementAccess
 177                 virtual ::com::sun::star::uno::Type SAL_CALL getElementType(  ) throw (::com::sun::star::uno::RuntimeException);
 178                 virtual ::sal_Bool SAL_CALL hasElements(  ) throw (::com::sun::star::uno::RuntimeException);
 179         // XShapes
 180         virtual void SAL_CALL add( const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape >& xShape ) throw (::com::sun::star::uno::RuntimeException);
 181         virtual void SAL_CALL remove( const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape >& xShape ) throw (::com::sun::star::uno::RuntimeException);
 182                 // XIndexAccess
 183                 virtual ::sal_Int32 SAL_CALL getCount(  ) throw (::com::sun::star::uno::RuntimeException);
 184                 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);
 185                 // XEnumerationAccess
 186                 virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XEnumeration > SAL_CALL createEnumeration(  ) throw (::com::sun::star::uno::RuntimeException);
 187
 188         // XComponent
 189                 virtual void SAL_CALL dispose() throw(::com::sun::star::uno::RuntimeException);
 190                 virtual void SAL_CALL addEventListener(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener > & aListener) throw(::com::sun::star::uno::RuntimeException)
 191                 {
 192                         cppu::WeakComponentImplHelperBase::addEventListener(aListener);
 193                 }
 194                 virtual void SAL_CALL removeEventListener(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener > & aListener) throw(::com::sun::star::uno::RuntimeException)
 195                 {
 196                         cppu::WeakComponentImplHelperBase::removeEventListener(aListener);
 197                 }
 198
 199         // com::sun::star::lang::XUnoTunnel
 200                 virtual sal_Int64 SAL_CALL getSomething( const ::com::sun::star::uno::Sequence< sal_Int8 >& aIdentifier ) throw(::com::sun::star::uno::RuntimeException);
 201         static OSection* getImplementation( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxComponent );
 202         static ::com::sun::star::uno::Sequence< sal_Int8 > getUnoTunnelImplementationId();
 203
 204                 static void lcl_copySection(const ::com::sun::star::uno::Reference< ::com::sun::star::report::XSection>& _xSource
 205                                                                                  ,::com::sun::star::uno::Reference< ::com::sun::star::report::XSection>& _xDest);
 206
 207         void notifyElementAdded(const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape >& xShape);
 208         void notifyElementRemoved(const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape >& xShape);
 209         };
 210 }
 211 #endif //REPORTDESIGN_API_SECTION_HXX