| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef CHART2_CONTROLLERLOCKGUARD_HXX |
| #define CHART2_CONTROLLERLOCKGUARD_HXX |
| |
| #include <com/sun/star/frame/XModel.hpp> |
| #include "charttoolsdllapi.hxx" |
| |
| namespace chart |
| { |
| |
| /** This guard calls lockControllers at the given Model in the CTOR and |
| unlockControllers in the DTOR. Using this ensures that controllers do not |
| remain locked when leaving a function even in case an exception is thrown. |
| */ |
| class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockGuard |
| { |
| public: |
| explicit ControllerLockGuard( |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::frame::XModel > & xModel ); |
| ~ControllerLockGuard(); |
| |
| private: |
| ::com::sun::star::uno::Reference< |
| ::com::sun::star::frame::XModel > m_xModel; |
| }; |
| |
| /** This helper class can be used to pass a locking mechanism to other objects |
| without exposing the full XModel to it. |
| |
| Use the ControllerLockHelperGuard to lock/unlock the model during a block of |
| instructions. |
| */ |
| class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockHelper |
| { |
| public: |
| explicit ControllerLockHelper( |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::frame::XModel > & xModel ); |
| ~ControllerLockHelper(); |
| |
| SAL_DLLPRIVATE void lockControllers(); |
| SAL_DLLPRIVATE void unlockControllers(); |
| |
| private: |
| ::com::sun::star::uno::Reference< |
| ::com::sun::star::frame::XModel > m_xModel; |
| }; |
| |
| /** This guard calls lockControllers at the given ControllerLockHelper in the |
| CTOR and unlockControllers in the DTOR. Using this ensures that controllers |
| do not remain locked when leaving a function even in case an exception is |
| thrown. |
| */ |
| class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockHelperGuard |
| { |
| public: |
| explicit ControllerLockHelperGuard( ControllerLockHelper & rHelper ); |
| ~ControllerLockHelperGuard(); |
| |
| private: |
| ControllerLockHelper & m_rHelper; |
| }; |
| |
| } // namespace chart |
| |
| // CHART2_CONTROLLERLOCKGUARD_HXX |
| #endif |