1*de7b3f82SAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3*de7b3f82SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*de7b3f82SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*de7b3f82SAndrew Rist * distributed with this work for additional information 6*de7b3f82SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*de7b3f82SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*de7b3f82SAndrew Rist * "License"); you may not use this file except in compliance 9*de7b3f82SAndrew Rist * with the License. You may obtain a copy of the License at 10*de7b3f82SAndrew Rist * 11*de7b3f82SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*de7b3f82SAndrew Rist * 13*de7b3f82SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*de7b3f82SAndrew Rist * software distributed under the License is distributed on an 15*de7b3f82SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*de7b3f82SAndrew Rist * KIND, either express or implied. See the License for the 17*de7b3f82SAndrew Rist * specific language governing permissions and limitations 18*de7b3f82SAndrew Rist * under the License. 19*de7b3f82SAndrew Rist * 20*de7b3f82SAndrew Rist *************************************************************/ 21*de7b3f82SAndrew Rist 22*de7b3f82SAndrew Rist 23cdf0e10cSrcweir #ifndef CHART2_CONTROLLERLOCKGUARD_HXX 24cdf0e10cSrcweir #define CHART2_CONTROLLERLOCKGUARD_HXX 25cdf0e10cSrcweir 26cdf0e10cSrcweir #include <com/sun/star/frame/XModel.hpp> 27cdf0e10cSrcweir #include "charttoolsdllapi.hxx" 28cdf0e10cSrcweir 29cdf0e10cSrcweir namespace chart 30cdf0e10cSrcweir { 31cdf0e10cSrcweir 32cdf0e10cSrcweir /** This guard calls lockControllers at the given Model in the CTOR and 33cdf0e10cSrcweir unlockControllers in the DTOR. Using this ensures that controllers do not 34cdf0e10cSrcweir remain locked when leaving a function even in case an exception is thrown. 35cdf0e10cSrcweir */ 36cdf0e10cSrcweir class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockGuard 37cdf0e10cSrcweir { 38cdf0e10cSrcweir public: 39cdf0e10cSrcweir explicit ControllerLockGuard( 40cdf0e10cSrcweir const ::com::sun::star::uno::Reference< 41cdf0e10cSrcweir ::com::sun::star::frame::XModel > & xModel ); 42cdf0e10cSrcweir ~ControllerLockGuard(); 43cdf0e10cSrcweir 44cdf0e10cSrcweir private: 45cdf0e10cSrcweir ::com::sun::star::uno::Reference< 46cdf0e10cSrcweir ::com::sun::star::frame::XModel > m_xModel; 47cdf0e10cSrcweir }; 48cdf0e10cSrcweir 49cdf0e10cSrcweir /** This helper class can be used to pass a locking mechanism to other objects 50cdf0e10cSrcweir without exposing the full XModel to it. 51cdf0e10cSrcweir 52cdf0e10cSrcweir Use the ControllerLockHelperGuard to lock/unlock the model during a block of 53cdf0e10cSrcweir instructions. 54cdf0e10cSrcweir */ 55cdf0e10cSrcweir class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockHelper 56cdf0e10cSrcweir { 57cdf0e10cSrcweir public: 58cdf0e10cSrcweir explicit ControllerLockHelper( 59cdf0e10cSrcweir const ::com::sun::star::uno::Reference< 60cdf0e10cSrcweir ::com::sun::star::frame::XModel > & xModel ); 61cdf0e10cSrcweir ~ControllerLockHelper(); 62cdf0e10cSrcweir 63cdf0e10cSrcweir SAL_DLLPRIVATE void lockControllers(); 64cdf0e10cSrcweir SAL_DLLPRIVATE void unlockControllers(); 65cdf0e10cSrcweir 66cdf0e10cSrcweir private: 67cdf0e10cSrcweir ::com::sun::star::uno::Reference< 68cdf0e10cSrcweir ::com::sun::star::frame::XModel > m_xModel; 69cdf0e10cSrcweir }; 70cdf0e10cSrcweir 71cdf0e10cSrcweir /** This guard calls lockControllers at the given ControllerLockHelper in the 72cdf0e10cSrcweir CTOR and unlockControllers in the DTOR. Using this ensures that controllers 73cdf0e10cSrcweir do not remain locked when leaving a function even in case an exception is 74cdf0e10cSrcweir thrown. 75cdf0e10cSrcweir */ 76cdf0e10cSrcweir class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockHelperGuard 77cdf0e10cSrcweir { 78cdf0e10cSrcweir public: 79cdf0e10cSrcweir explicit ControllerLockHelperGuard( ControllerLockHelper & rHelper ); 80cdf0e10cSrcweir ~ControllerLockHelperGuard(); 81cdf0e10cSrcweir 82cdf0e10cSrcweir private: 83cdf0e10cSrcweir ControllerLockHelper & m_rHelper; 84cdf0e10cSrcweir }; 85cdf0e10cSrcweir 86cdf0e10cSrcweir } // namespace chart 87cdf0e10cSrcweir 88cdf0e10cSrcweir // CHART2_CONTROLLERLOCKGUARD_HXX 89cdf0e10cSrcweir #endif 90