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 #ifndef CHART2_CONTROLLERLOCKGUARD_HXX 24*b1cdbd2cSJim Jagielski #define CHART2_CONTROLLERLOCKGUARD_HXX 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/XModel.hpp> 27*b1cdbd2cSJim Jagielski #include "charttoolsdllapi.hxx" 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski namespace chart 30*b1cdbd2cSJim Jagielski { 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski /** This guard calls lockControllers at the given Model in the CTOR and 33*b1cdbd2cSJim Jagielski unlockControllers in the DTOR. Using this ensures that controllers do not 34*b1cdbd2cSJim Jagielski remain locked when leaving a function even in case an exception is thrown. 35*b1cdbd2cSJim Jagielski */ 36*b1cdbd2cSJim Jagielski class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockGuard 37*b1cdbd2cSJim Jagielski { 38*b1cdbd2cSJim Jagielski public: 39*b1cdbd2cSJim Jagielski explicit ControllerLockGuard( 40*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< 41*b1cdbd2cSJim Jagielski ::com::sun::star::frame::XModel > & xModel ); 42*b1cdbd2cSJim Jagielski ~ControllerLockGuard(); 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski private: 45*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< 46*b1cdbd2cSJim Jagielski ::com::sun::star::frame::XModel > m_xModel; 47*b1cdbd2cSJim Jagielski }; 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski /** This helper class can be used to pass a locking mechanism to other objects 50*b1cdbd2cSJim Jagielski without exposing the full XModel to it. 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski Use the ControllerLockHelperGuard to lock/unlock the model during a block of 53*b1cdbd2cSJim Jagielski instructions. 54*b1cdbd2cSJim Jagielski */ 55*b1cdbd2cSJim Jagielski class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockHelper 56*b1cdbd2cSJim Jagielski { 57*b1cdbd2cSJim Jagielski public: 58*b1cdbd2cSJim Jagielski explicit ControllerLockHelper( 59*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< 60*b1cdbd2cSJim Jagielski ::com::sun::star::frame::XModel > & xModel ); 61*b1cdbd2cSJim Jagielski ~ControllerLockHelper(); 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski SAL_DLLPRIVATE void lockControllers(); 64*b1cdbd2cSJim Jagielski SAL_DLLPRIVATE void unlockControllers(); 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski private: 67*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< 68*b1cdbd2cSJim Jagielski ::com::sun::star::frame::XModel > m_xModel; 69*b1cdbd2cSJim Jagielski }; 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski /** This guard calls lockControllers at the given ControllerLockHelper in the 72*b1cdbd2cSJim Jagielski CTOR and unlockControllers in the DTOR. Using this ensures that controllers 73*b1cdbd2cSJim Jagielski do not remain locked when leaving a function even in case an exception is 74*b1cdbd2cSJim Jagielski thrown. 75*b1cdbd2cSJim Jagielski */ 76*b1cdbd2cSJim Jagielski class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockHelperGuard 77*b1cdbd2cSJim Jagielski { 78*b1cdbd2cSJim Jagielski public: 79*b1cdbd2cSJim Jagielski explicit ControllerLockHelperGuard( ControllerLockHelper & rHelper ); 80*b1cdbd2cSJim Jagielski ~ControllerLockHelperGuard(); 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski private: 83*b1cdbd2cSJim Jagielski ControllerLockHelper & m_rHelper; 84*b1cdbd2cSJim Jagielski }; 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski } // namespace chart 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski // CHART2_CONTROLLERLOCKGUARD_HXX 89*b1cdbd2cSJim Jagielski #endif 90