1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef SD_TOOLS_PROPERTY_SET_HXX 25*b1cdbd2cSJim Jagielski #define SD_TOOLS_PROPERTY_SET_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <cppuhelper/basemutex.hxx> 28*b1cdbd2cSJim Jagielski #include <cppuhelper/compbase1.hxx> 29*b1cdbd2cSJim Jagielski #include <com/sun/star/beans/XPropertySet.hpp> 30*b1cdbd2cSJim Jagielski #include <boost/scoped_ptr.hpp> 31*b1cdbd2cSJim Jagielski #include <map> 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski namespace css = ::com::sun::star; 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski namespace sd { namespace tools { 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski namespace { 38*b1cdbd2cSJim Jagielski typedef ::cppu::WeakComponentImplHelper1 < 39*b1cdbd2cSJim Jagielski css::beans::XPropertySet 40*b1cdbd2cSJim Jagielski > PropertySetInterfaceBase; 41*b1cdbd2cSJim Jagielski } 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski /** A very simple implementation of the XPropertySet interface. It does not 45*b1cdbd2cSJim Jagielski support constrained properties and thus does not support vetoable 46*b1cdbd2cSJim Jagielski listeners. It does not support the optional property set info. 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski In order to use it you have to derive from this class and implement the 49*b1cdbd2cSJim Jagielski GetPropertyValue() and SetPropertyValue() methods. 50*b1cdbd2cSJim Jagielski */ 51*b1cdbd2cSJim Jagielski class PropertySet 52*b1cdbd2cSJim Jagielski : protected ::cppu::BaseMutex, 53*b1cdbd2cSJim Jagielski public PropertySetInterfaceBase 54*b1cdbd2cSJim Jagielski { 55*b1cdbd2cSJim Jagielski public: 56*b1cdbd2cSJim Jagielski explicit PropertySet (void); 57*b1cdbd2cSJim Jagielski virtual ~PropertySet (void); 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski virtual void SAL_CALL disposing (void); 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski // XPropertySet 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski virtual css::uno::Reference<css::beans::XPropertySetInfo> 64*b1cdbd2cSJim Jagielski SAL_CALL getPropertySetInfo (void) 65*b1cdbd2cSJim Jagielski throw(css::uno::RuntimeException); 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski virtual void SAL_CALL setPropertyValue ( 68*b1cdbd2cSJim Jagielski const rtl::OUString& rsPropertyName, 69*b1cdbd2cSJim Jagielski const css::uno::Any& rsPropertyValue) 70*b1cdbd2cSJim Jagielski throw(css::beans::UnknownPropertyException, 71*b1cdbd2cSJim Jagielski css::beans::PropertyVetoException, 72*b1cdbd2cSJim Jagielski css::lang::IllegalArgumentException, 73*b1cdbd2cSJim Jagielski css::lang::WrappedTargetException, 74*b1cdbd2cSJim Jagielski css::uno::RuntimeException); 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski virtual css::uno::Any SAL_CALL getPropertyValue (const rtl::OUString& rsPropertyName) 77*b1cdbd2cSJim Jagielski throw(css::beans::UnknownPropertyException, 78*b1cdbd2cSJim Jagielski css::lang::WrappedTargetException, 79*b1cdbd2cSJim Jagielski css::uno::RuntimeException); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski virtual void SAL_CALL addPropertyChangeListener ( 82*b1cdbd2cSJim Jagielski const rtl::OUString& rsPropertyName, 83*b1cdbd2cSJim Jagielski const css::uno::Reference<css::beans::XPropertyChangeListener>& rxListener) 84*b1cdbd2cSJim Jagielski throw(css::beans::UnknownPropertyException, 85*b1cdbd2cSJim Jagielski css::lang::WrappedTargetException, 86*b1cdbd2cSJim Jagielski css::uno::RuntimeException); 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski virtual void SAL_CALL removePropertyChangeListener ( 89*b1cdbd2cSJim Jagielski const rtl::OUString& rsPropertyName, 90*b1cdbd2cSJim Jagielski const css::uno::Reference<css::beans::XPropertyChangeListener>& rxListener) 91*b1cdbd2cSJim Jagielski throw(css::beans::UnknownPropertyException, 92*b1cdbd2cSJim Jagielski css::lang::WrappedTargetException, 93*b1cdbd2cSJim Jagielski css::uno::RuntimeException); 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski virtual void SAL_CALL addVetoableChangeListener ( 96*b1cdbd2cSJim Jagielski const rtl::OUString& rsPropertyName, 97*b1cdbd2cSJim Jagielski const css::uno::Reference<css::beans::XVetoableChangeListener>& rxListener) 98*b1cdbd2cSJim Jagielski throw(css::beans::UnknownPropertyException, 99*b1cdbd2cSJim Jagielski css::lang::WrappedTargetException, 100*b1cdbd2cSJim Jagielski css::uno::RuntimeException); 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski virtual void SAL_CALL removeVetoableChangeListener ( 103*b1cdbd2cSJim Jagielski const rtl::OUString& rsPropertyName, 104*b1cdbd2cSJim Jagielski const css::uno::Reference<css::beans::XVetoableChangeListener>& rxListener) 105*b1cdbd2cSJim Jagielski throw(css::beans::UnknownPropertyException, 106*b1cdbd2cSJim Jagielski css::lang::WrappedTargetException, 107*b1cdbd2cSJim Jagielski css::uno::RuntimeException); 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski protected: 110*b1cdbd2cSJim Jagielski /** Return the requested property value. 111*b1cdbd2cSJim Jagielski @throw com::sun::star::beans::UnknownPropertyException when the 112*b1cdbd2cSJim Jagielski property is not supported. 113*b1cdbd2cSJim Jagielski */ 114*b1cdbd2cSJim Jagielski virtual css::uno::Any GetPropertyValue (const ::rtl::OUString& rsPropertyName) = 0; 115*b1cdbd2cSJim Jagielski /** Set the given property value. 116*b1cdbd2cSJim Jagielski @return the old value. 117*b1cdbd2cSJim Jagielski @throw com::sun::star::beans::UnknownPropertyException when the 118*b1cdbd2cSJim Jagielski property is not supported. 119*b1cdbd2cSJim Jagielski */ 120*b1cdbd2cSJim Jagielski virtual css::uno::Any SetPropertyValue ( 121*b1cdbd2cSJim Jagielski const ::rtl::OUString& rsPropertyName, 122*b1cdbd2cSJim Jagielski const css::uno::Any& rValue) = 0; 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski private: 125*b1cdbd2cSJim Jagielski typedef ::std::multimap<rtl::OUString, 126*b1cdbd2cSJim Jagielski css::uno::Reference<css::beans::XPropertyChangeListener> > ChangeListenerContainer; 127*b1cdbd2cSJim Jagielski ::boost::scoped_ptr<ChangeListenerContainer> mpChangeListeners; 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski /** Call all listeners that are registered for the given property name. 130*b1cdbd2cSJim Jagielski Call this method with an empty property name to call listeners that 131*b1cdbd2cSJim Jagielski are registered for all properties. 132*b1cdbd2cSJim Jagielski */ 133*b1cdbd2cSJim Jagielski void CallListeners ( 134*b1cdbd2cSJim Jagielski const rtl::OUString& rsPropertyName, 135*b1cdbd2cSJim Jagielski const css::beans::PropertyChangeEvent& rEvent); 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski /** This method throws a DisposedException when the object has already been 138*b1cdbd2cSJim Jagielski disposed. 139*b1cdbd2cSJim Jagielski */ 140*b1cdbd2cSJim Jagielski void ThrowIfDisposed (void) 141*b1cdbd2cSJim Jagielski throw (css::lang::DisposedException); 142*b1cdbd2cSJim Jagielski }; 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski } } // end of namespace ::sd::tools 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski #endif 147