include/comphelper/propmultiplex.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
  20 #ifndef INCLUDED_COMPHELPER_PROPMULTIPLEX_HXX
  21 #define INCLUDED_COMPHELPER_PROPMULTIPLEX_HXX
  22
  23 #include <comphelper/propstate.hxx>
  24 #include <cppuhelper/implbase.hxx>
  25 #include <comphelper/comphelperdllapi.h>
  26 #include <rtl/ref.hxx>
  27
  28
  29 //= property helper classes
  30
  31
  32 namespace comphelper
  33 {
  34
  35
  36     class OPropertyChangeMultiplexer;
  37
  38
  39     //= OPropertyChangeListener
  40
  41     /// simple listener adapter for property sets
  42     class COMPHELPER_DLLPUBLIC OPropertyChangeListener
  43     {
  44         friend class OPropertyChangeMultiplexer;
  45
  46         rtl::Reference<OPropertyChangeMultiplexer> m_xAdapter;
  47         ::osl::Mutex&               m_rMutex;
  48
  49     public:
  50         OPropertyChangeListener(::osl::Mutex& _rMutex)
  51             : m_rMutex(_rMutex) { }
  52         virtual ~OPropertyChangeListener();
  53
  54         /// @throws css::uno::RuntimeException
  55         virtual void _propertyChanged(const css::beans::PropertyChangeEvent& _rEvent) = 0;
  56         /// @throws css::uno::RuntimeException
  57         virtual void _disposing(const css::lang::EventObject& _rSource);
  58
  59     protected:
  60         /** If the derivee also owns the mutex which we know as reference, then call this within your
  61             derivee's dtor.
  62         */
  63         void    disposeAdapter();
  64
  65         // pseudo-private. Making it private now could break compatibility
  66         void    setAdapter( OPropertyChangeMultiplexer* _pAdapter );
  67     };
  68
  69
  70     //= OPropertyChangeMultiplexer
  71
  72     /// multiplexer for property changes
  73     class COMPHELPER_DLLPUBLIC OPropertyChangeMultiplexer   :public cppu::WeakImplHelper< css::beans::XPropertyChangeListener>
  74     {
  75         friend class OPropertyChangeListener;
  76         std::vector< OUString >                         m_aProperties;
  77         css::uno::Reference< css::beans::XPropertySet>  m_xSet;
  78         OPropertyChangeListener*                        m_pListener;
  79         sal_Int32                                       m_nLockCount;
  80         bool                                            m_bListening        : 1;
  81         bool                                            m_bAutoSetRelease   : 1;
  82
  83
  84         virtual ~OPropertyChangeMultiplexer() override;
  85     public:
  86         OPropertyChangeMultiplexer(OPropertyChangeListener* _pListener, const  css::uno::Reference< css::beans::XPropertySet>& _rxSet, bool _bAutoReleaseSet = true);
  87
  88     // XEventListener
  89         virtual void SAL_CALL disposing( const  css::lang::EventObject& Source ) override;
  90
  91     // XPropertyChangeListener
  92         virtual void SAL_CALL propertyChange( const  css::beans::PropertyChangeEvent& evt ) override;
  93
  94         /// incremental lock
  95         void        lock();
  96         /// incremental unlock
  97         void        unlock();
  98         /// get the lock count
  99         sal_Int32   locked() const { return m_nLockCount; }
 100
 101         void addProperty(const OUString& aPropertyName);
 102         void dispose();
 103     };
 104
 105
 106 }   // namespace comphelper
 107
 108
 109 #endif // INCLUDED_COMPHELPER_PROPMULTIPLEX_HXX
 110
 111 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */