chart2/source/inc/ControllerLockGuard.hxx

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