framework/inc/classes/propertysethelper.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_FRAMEWORK_INC_CLASSES_PROPERTYSETHELPER_HXX
  21 #define INCLUDED_FRAMEWORK_INC_CLASSES_PROPERTYSETHELPER_HXX
  22
  23 #include <threadhelp/transactionbase.hxx>
  24 #include <general.h>
  25 #include <stdtypes.h>
  26
  27 #include <com/sun/star/beans/XPropertySet.hpp>
  28 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  29 #include <com/sun/star/beans/PropertyExistException.hpp>
  30 #include <com/sun/star/beans/UnknownPropertyException.hpp>
  31
  32 #include <cppuhelper/weakref.hxx>
  33 #include <fwidllapi.h>
  34
  35 namespace framework{
  36
  37 /** supports the API XPropertySet and XPropertySetInfo.
  38  *
  39  *  It must be used as baseclass. The internal list of supported
  40  *  properties can be changed every time so dynamic property set's
  41  *  can be implemented.
  42  *
  43  *  Further the derived and this base class share the same lock.
  44  *  So it's possible to be threadsafe if it's needed.
  45 */
  46 class FWI_DLLPUBLIC PropertySetHelper : public css::beans::XPropertySet
  47                         , public css::beans::XPropertySetInfo
  48 {
  49
  50     /* types */
  51     protected:
  52
  53         typedef BaseHash< css::beans::Property > TPropInfoHash;
  54
  55     /* member */
  56     protected:
  57
  58         PropertySetHelper::TPropInfoHash m_lProps;
  59
  60         ListenerHash m_lSimpleChangeListener;
  61         ListenerHash m_lVetoChangeListener;
  62
  63         bool m_bReleaseLockOnCall;
  64
  65         // hold it weak ... otherwise this helper has to be "killed" explicitly .-)
  66         css::uno::WeakReference< css::uno::XInterface > m_xBroadcaster;
  67
  68         TransactionManager& m_rTransactionManager;
  69
  70     /* native interface */
  71     public:
  72
  73         /** initialize new instance of this helper.
  74          *
  75          *  @param  pExternalTransactionManager
  76          *          this helper must be used as a baseclass ...
  77          *          but then it should synchronize its own calls
  78          *          with the same transaction manager then it's superclass.
  79          *
  80          *  @param  bReleaseLockOnCall
  81          *          see member m_bReleaseLockOnCall
  82          */
  83         PropertySetHelper(      osl::Mutex & mutex,
  84                                 TransactionManager*                                     pExternalTransactionManager ,
  85                                 bool                                                bReleaseLockOnCall          );
  86
  87         /** free all needed memory.
  88          */
  89         virtual ~PropertySetHelper();
  90
  91         /** set a new owner for this helper.
  92          *
  93          *  This owner is used as source for all broadcasted events.
  94          *  Further we hold it weak, because we dont wish to be disposed() .-)
  95          */
  96         void impl_setPropertyChangeBroadcaster(const css::uno::Reference< css::uno::XInterface >& xBroadcaster);
  97
  98         /** add a new property info to the set of supported ones.
  99          *
 100          *  @param  aProperty
 101          *          describes the new property.
 102          *
 103          *  @throw  [com::sun::star::beans::PropertyExistException]
 104          *          if a property with the same name already exists.
 105          *
 106          *  Note:   The consistence of the whole set of properties is not checked here.
 107          *          Means e.g. ... a handle which exists more than once is not detected.
 108          *          The owner of this class has to be sure, that every new property does
 109          *          not clash with any existing one.
 110          */
 111         void SAL_CALL impl_addPropertyInfo(const css::beans::Property& aProperty)
 112             throw(css::beans::PropertyExistException,
 113                   css::uno::Exception               );
 114
 115         /** mark the object as "useable for working" or "dead".
 116          *
 117          *  This correspond to the lifetime handling implemented by the base class TransactionBase.
 118          *  There is no chance to reactive a "dead" object by calling impl_enablePropertySet()
 119          *  again!
 120          */
 121         void SAL_CALL impl_disablePropertySet();
 122
 123         /**
 124          */
 125         virtual void SAL_CALL impl_setPropertyValue(const OUString& sProperty,
 126                                                           sal_Int32        nHandle  ,
 127                                                     const css::uno::Any&   aValue   ) = 0;
 128
 129         virtual css::uno::Any SAL_CALL impl_getPropertyValue(const OUString& sProperty,
 130                                                                    sal_Int32        nHandle  ) = 0;
 131
 132     /* uno interface */
 133     public:
 134
 135         // XPropertySet
 136         virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo()
 137             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 138
 139         virtual void SAL_CALL setPropertyValue(const OUString& sProperty,
 140                                                const css::uno::Any&   aValue   )
 141             throw(css::beans::UnknownPropertyException,
 142                   css::beans::PropertyVetoException   ,
 143                   css::lang::IllegalArgumentException ,
 144                   css::lang::WrappedTargetException   ,
 145                   css::uno::RuntimeException, std::exception          ) SAL_OVERRIDE;
 146
 147         virtual css::uno::Any SAL_CALL getPropertyValue(const OUString& sProperty)
 148             throw(css::beans::UnknownPropertyException,
 149                   css::lang::WrappedTargetException   ,
 150                   css::uno::RuntimeException, std::exception          ) SAL_OVERRIDE;
 151
 152         virtual void SAL_CALL addPropertyChangeListener(const OUString&                                            sProperty,
 153                                                         const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener)
 154             throw(css::beans::UnknownPropertyException,
 155                   css::lang::WrappedTargetException   ,
 156                   css::uno::RuntimeException, std::exception          ) SAL_OVERRIDE;
 157
 158         virtual void SAL_CALL removePropertyChangeListener(const OUString&                                            sProperty,
 159                                                            const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener)
 160             throw(css::beans::UnknownPropertyException,
 161                   css::lang::WrappedTargetException   ,
 162                   css::uno::RuntimeException, std::exception          ) SAL_OVERRIDE;
 163
 164         virtual void SAL_CALL addVetoableChangeListener(const OUString&                                            sProperty,
 165                                                         const css::uno::Reference< css::beans::XVetoableChangeListener >& xListener)
 166             throw(css::beans::UnknownPropertyException,
 167                   css::lang::WrappedTargetException   ,
 168                   css::uno::RuntimeException, std::exception          ) SAL_OVERRIDE;
 169
 170         virtual void SAL_CALL removeVetoableChangeListener(const OUString&                                            sProperty,
 171                                                            const css::uno::Reference< css::beans::XVetoableChangeListener >& xListener)
 172             throw(css::beans::UnknownPropertyException,
 173                   css::lang::WrappedTargetException   ,
 174                   css::uno::RuntimeException, std::exception          ) SAL_OVERRIDE;
 175
 176         // XPropertySetInfo
 177         virtual css::uno::Sequence< css::beans::Property > SAL_CALL getProperties()
 178             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 179
 180         virtual css::beans::Property SAL_CALL getPropertyByName(const OUString& sName)
 181             throw(css::beans::UnknownPropertyException,
 182                   css::uno::RuntimeException, std::exception          ) SAL_OVERRIDE;
 183
 184         virtual sal_Bool SAL_CALL hasPropertyByName(const OUString& sName)
 185             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 186
 187     /* internal helper */
 188     private:
 189
 190         bool impl_existsVeto(const css::beans::PropertyChangeEvent& aEvent);
 191
 192         void impl_notifyChangeListener(const css::beans::PropertyChangeEvent& aEvent);
 193 };
 194
 195 } // namespace framework
 196
 197 #endif // INCLUDED_FRAMEWORK_INC_CLASSES_PROPERTYSETHELPER_HXX
 198
 199 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */