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