chart2/source/inc/ModifyListenerHelper.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: ModifyListenerHelper.hxx,v $
  10  * $Revision: 1.4.44.1 $
  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 CHART2_MODIFYLISTENERHELPER_HXX
  31 #define CHART2_MODIFYLISTENERHELPER_HXX
  32
  33 #include <cppuhelper/interfacecontainer.hxx>
  34 #include <com/sun/star/util/XModifyListener.hpp>
  35 #include <com/sun/star/util/XModifyBroadcaster.hpp>
  36 #include <com/sun/star/util/XModifiable.hpp>
  37 #include <com/sun/star/uno/XWeak.hpp>
  38 #include <cppuhelper/implbase1.hxx>
  39 #include <cppuhelper/compbase2.hxx>
  40 #include <cppuhelper/weakref.hxx>
  41
  42 #include "MutexContainer.hxx"
  43 #include "charttoolsdllapi.hxx"
  44
  45 #include <list>
  46 #include <algorithm>
  47 #include <functional>
  48 #include <utility>
  49
  50 namespace com { namespace sun { namespace star {
  51 namespace chart2
  52 {
  53     class XChartDocument;
  54 }}}}
  55
  56 namespace chart
  57 {
  58 namespace ModifyListenerHelper
  59 {
  60
  61 OOO_DLLPUBLIC_CHARTTOOLS ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener > createModifyEventForwarder();
  62
  63 // ================================================================================
  64
  65 /** This helper class serves as forwarder of modify events.  It can be used
  66     whenever an object has to send modify events after it gets a modify event of
  67     one of its children.
  68
  69     <p>The listeners are held as WeakReferences if they support XWeak.  Thus the
  70     life time of the listeners is independent of the broadcaster's lifetime in
  71     this case.</p>
  72  */
  73 class ModifyEventForwarder :
  74         public MutexContainer,
  75         public ::cppu::WeakComponentImplHelper2<
  76             ::com::sun::star::util::XModifyBroadcaster,
  77             ::com::sun::star::util::XModifyListener >
  78 {
  79 public:
  80     ModifyEventForwarder();
  81
  82     void FireEvent( const ::com::sun::star::lang::EventObject & rEvent );
  83
  84     void AddListener(
  85         const ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener >& aListener );
  86     void RemoveListener(
  87         const ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener >& aListener );
  88
  89 protected:
  90     // ____ XModifyBroadcaster ____
  91     virtual void SAL_CALL addModifyListener(
  92         const ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener >& aListener )
  93         throw (::com::sun::star::uno::RuntimeException);
  94     virtual void SAL_CALL removeModifyListener(
  95         const ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener >& aListener )
  96         throw (::com::sun::star::uno::RuntimeException);
  97
  98     // ____ XModifyListener ____
  99     virtual void SAL_CALL modified(
 100         const ::com::sun::star::lang::EventObject& aEvent )
 101         throw (::com::sun::star::uno::RuntimeException);
 102
 103     // ____ XEventListener (base of XModifyListener) ____
 104     virtual void SAL_CALL disposing(
 105         const ::com::sun::star::lang::EventObject& Source )
 106         throw (::com::sun::star::uno::RuntimeException);
 107
 108     // ____ WeakComponentImplHelperBase ____
 109     virtual void SAL_CALL disposing();
 110
 111 private:
 112     /// call disposing() at all listeners and remove all listeners
 113     void DisposeAndClear( const ::com::sun::star::uno::Reference<
 114                               ::com::sun::star::uno::XWeak > & xSource );
 115
 116 //     ::osl::Mutex & m_rMutex;
 117     ::cppu::OBroadcastHelper  m_aModifyListeners;
 118
 119     typedef ::std::list<
 120             ::std::pair<
 121             ::com::sun::star::uno::WeakReference< ::com::sun::star::util::XModifyListener >,
 122             ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener > > >
 123         tListenerMap;
 124
 125     tListenerMap m_aListenerMap;
 126 };
 127
 128 // ================================================================================
 129
 130 namespace impl
 131 {
 132
 133 template< class InterfaceRef >
 134 struct addListenerFunctor : public ::std::unary_function< InterfaceRef, void >
 135 {
 136     explicit addListenerFunctor( const ::com::sun::star::uno::Reference<
 137                                      ::com::sun::star::util::XModifyListener > & xListener ) :
 138             m_xListener( xListener )
 139     {}
 140
 141     void operator() ( const InterfaceRef & xObject )
 142     {
 143         ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyBroadcaster >
 144               xBroadcaster( xObject, ::com::sun::star::uno::UNO_QUERY );
 145         if( xBroadcaster.is() && m_xListener.is())
 146             xBroadcaster->addModifyListener( m_xListener );
 147     }
 148 private:
 149     ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener > m_xListener;
 150 };
 151
 152 template< class InterfaceRef >
 153 struct removeListenerFunctor : public ::std::unary_function< InterfaceRef, void >
 154 {
 155     explicit removeListenerFunctor( const ::com::sun::star::uno::Reference<
 156                                         ::com::sun::star::util::XModifyListener > & xListener ) :
 157             m_xListener( xListener )
 158     {}
 159
 160     void operator() ( const InterfaceRef & xObject )
 161     {
 162         ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyBroadcaster >
 163               xBroadcaster( xObject, ::com::sun::star::uno::UNO_QUERY );
 164         if( xBroadcaster.is() && m_xListener.is())
 165             xBroadcaster->removeModifyListener( m_xListener );
 166     }
 167 private:
 168     ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener > m_xListener;
 169 };
 170
 171 template< class Pair >
 172 struct addListenerToMappedElementFunctor : public ::std::unary_function< Pair, void >
 173 {
 174     explicit addListenerToMappedElementFunctor( const ::com::sun::star::uno::Reference<
 175                                                     ::com::sun::star::util::XModifyListener > & xListener ) :
 176             m_xListener( xListener )
 177     {}
 178
 179     void operator() ( const Pair & aPair )
 180     {
 181         ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyBroadcaster >
 182               xBroadcaster( aPair.second, ::com::sun::star::uno::UNO_QUERY );
 183         if( xBroadcaster.is() && m_xListener.is())
 184             xBroadcaster->addModifyListener( m_xListener );
 185     }
 186 private:
 187     ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener > m_xListener;
 188 };
 189
 190 template< class Pair >
 191 struct removeListenerFromMappedElementFunctor : public ::std::unary_function< Pair, void >
 192 {
 193     explicit removeListenerFromMappedElementFunctor( const ::com::sun::star::uno::Reference<
 194                                                          ::com::sun::star::util::XModifyListener > & xListener ) :
 195             m_xListener( xListener )
 196     {}
 197
 198     void operator() ( const Pair & aPair )
 199     {
 200         ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyBroadcaster >
 201               xBroadcaster( aPair.second, ::com::sun::star::uno::UNO_QUERY );
 202         if( xBroadcaster.is() && m_xListener.is())
 203             xBroadcaster->removeModifyListener( m_xListener );
 204     }
 205 private:
 206     ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener > m_xListener;
 207 };
 208
 209 } //  namespace impl
 210
 211 // --------------------------------------------------------------------------------
 212
 213
 214 template< class InterfaceRef >
 215 void addListener(
 216     const InterfaceRef & xObject,
 217     const ::com::sun::star::uno::Reference<
 218         ::com::sun::star::util::XModifyListener > & xListener )
 219 {
 220     if( xListener.is())
 221     {
 222         impl::addListenerFunctor< InterfaceRef > aFunctor( xListener );
 223         aFunctor( xObject );
 224     }
 225 }
 226
 227 template< class Container >
 228 void addListenerToAllElements(
 229     const Container & rContainer,
 230     const ::com::sun::star::uno::Reference<
 231         ::com::sun::star::util::XModifyListener > & xListener )
 232 {
 233     if( xListener.is())
 234         ::std::for_each( rContainer.begin(), rContainer.end(),
 235                          impl::addListenerFunctor< typename Container::value_type >( xListener ));
 236 }
 237
 238 template< class Container >
 239 void addListenerToAllMapElements(
 240     const Container & rContainer,
 241     const ::com::sun::star::uno::Reference<
 242         ::com::sun::star::util::XModifyListener > & xListener )
 243 {
 244     if( xListener.is())
 245         ::std::for_each( rContainer.begin(), rContainer.end(),
 246                          impl::addListenerToMappedElementFunctor< typename Container::value_type >( xListener ));
 247 }
 248
 249 template< typename T >
 250 void addListenerToAllSequenceElements(
 251     const ::com::sun::star::uno::Sequence< T > & rSequence,
 252     const ::com::sun::star::uno::Reference<
 253         ::com::sun::star::util::XModifyListener > & xListener )
 254 {
 255     if( xListener.is())
 256         ::std::for_each( rSequence.getConstArray(), rSequence.getConstArray() + rSequence.getLength(),
 257                          impl::addListenerFunctor< T >( xListener ));
 258 }
 259
 260 template< class InterfaceRef >
 261 void removeListener(
 262     const InterfaceRef & xObject,
 263     const ::com::sun::star::uno::Reference<
 264         ::com::sun::star::util::XModifyListener > & xListener )
 265 {
 266     if( xListener.is())
 267     {
 268         impl::removeListenerFunctor< InterfaceRef > aFunctor( xListener );
 269         aFunctor( xObject );
 270     }
 271 }
 272
 273 template< class Container >
 274 void removeListenerFromAllElements(
 275     const Container & rContainer,
 276     const ::com::sun::star::uno::Reference<
 277         ::com::sun::star::util::XModifyListener > & xListener )
 278 {
 279     if( xListener.is())
 280         ::std::for_each( rContainer.begin(), rContainer.end(),
 281                          impl::removeListenerFunctor< typename Container::value_type >( xListener ));
 282 }
 283
 284 template< class Container >
 285 void removeListenerFromAllMapElements(
 286     const Container & rContainer,
 287     const ::com::sun::star::uno::Reference<
 288         ::com::sun::star::util::XModifyListener > & xListener )
 289 {
 290     if( xListener.is())
 291         ::std::for_each( rContainer.begin(), rContainer.end(),
 292                          impl::removeListenerFromMappedElementFunctor< typename Container::value_type >( xListener ));
 293 }
 294
 295 template< typename T >
 296 void removeListenerFromAllSequenceElements(
 297     const ::com::sun::star::uno::Sequence< T > & rSequence,
 298     const ::com::sun::star::uno::Reference<
 299         ::com::sun::star::util::XModifyListener > & xListener )
 300 {
 301     if( xListener.is())
 302         ::std::for_each( rSequence.getConstArray(), rSequence.getConstArray() + rSequence.getLength(),
 303                          impl::removeListenerFunctor< T >( xListener ));
 304 }
 305
 306 } //  namespace ModifyListenerHelper
 307 } //  namespace chart
 308
 309 // CHART2_MODIFYLISTENERHELPER_HXX
 310 #endif