1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir #ifndef CHART2_CONTROLLERLOCKGUARD_HXX
28*cdf0e10cSrcweir #define CHART2_CONTROLLERLOCKGUARD_HXX
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir #include <com/sun/star/frame/XModel.hpp>
31*cdf0e10cSrcweir #include "charttoolsdllapi.hxx"
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir namespace chart
34*cdf0e10cSrcweir {
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir /** This guard calls lockControllers at the given Model in the CTOR and
37*cdf0e10cSrcweir     unlockControllers in the DTOR.  Using this ensures that controllers do not
38*cdf0e10cSrcweir     remain locked when leaving a function even in case an exception is thrown.
39*cdf0e10cSrcweir  */
40*cdf0e10cSrcweir class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockGuard
41*cdf0e10cSrcweir {
42*cdf0e10cSrcweir public:
43*cdf0e10cSrcweir 	explicit ControllerLockGuard(
44*cdf0e10cSrcweir         const ::com::sun::star::uno::Reference<
45*cdf0e10cSrcweir             ::com::sun::star::frame::XModel > & xModel );
46*cdf0e10cSrcweir     ~ControllerLockGuard();
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir private:
49*cdf0e10cSrcweir     ::com::sun::star::uno::Reference<
50*cdf0e10cSrcweir             ::com::sun::star::frame::XModel > m_xModel;
51*cdf0e10cSrcweir };
52*cdf0e10cSrcweir 
53*cdf0e10cSrcweir /** This helper class can be used to pass a locking mechanism to other objects
54*cdf0e10cSrcweir     without exposing the full XModel to it.
55*cdf0e10cSrcweir 
56*cdf0e10cSrcweir     Use the ControllerLockHelperGuard to lock/unlock the model during a block of
57*cdf0e10cSrcweir     instructions.
58*cdf0e10cSrcweir  */
59*cdf0e10cSrcweir class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockHelper
60*cdf0e10cSrcweir {
61*cdf0e10cSrcweir public:
62*cdf0e10cSrcweir     explicit ControllerLockHelper(
63*cdf0e10cSrcweir         const ::com::sun::star::uno::Reference<
64*cdf0e10cSrcweir             ::com::sun::star::frame::XModel > & xModel );
65*cdf0e10cSrcweir     ~ControllerLockHelper();
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir     SAL_DLLPRIVATE void lockControllers();
68*cdf0e10cSrcweir     SAL_DLLPRIVATE void unlockControllers();
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir private:
71*cdf0e10cSrcweir     ::com::sun::star::uno::Reference<
72*cdf0e10cSrcweir             ::com::sun::star::frame::XModel > m_xModel;
73*cdf0e10cSrcweir };
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir /** This guard calls lockControllers at the given ControllerLockHelper in the
76*cdf0e10cSrcweir     CTOR and unlockControllers in the DTOR.  Using this ensures that controllers
77*cdf0e10cSrcweir     do not remain locked when leaving a function even in case an exception is
78*cdf0e10cSrcweir     thrown.
79*cdf0e10cSrcweir  */
80*cdf0e10cSrcweir class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockHelperGuard
81*cdf0e10cSrcweir {
82*cdf0e10cSrcweir public:
83*cdf0e10cSrcweir 	explicit ControllerLockHelperGuard( ControllerLockHelper & rHelper );
84*cdf0e10cSrcweir     ~ControllerLockHelperGuard();
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir private:
87*cdf0e10cSrcweir     ControllerLockHelper & m_rHelper;
88*cdf0e10cSrcweir };
89*cdf0e10cSrcweir 
90*cdf0e10cSrcweir } //  namespace chart
91*cdf0e10cSrcweir 
92*cdf0e10cSrcweir // CHART2_CONTROLLERLOCKGUARD_HXX
93*cdf0e10cSrcweir #endif
94