chart2/source/inc/ControllerLockGuard.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_CHART2_SOURCE_INC_CONTROLLERLOCKGUARD_HXX
  20 #define INCLUDED_CHART2_SOURCE_INC_CONTROLLERLOCKGUARD_HXX
  21
  22 #include <com/sun/star/frame/XModel.hpp>
  23 #include "charttoolsdllapi.hxx"
  24 #include "ChartModel.hxx"
  25
  26 namespace chart
  27 {
  28
  29 /** This guard calls lockControllers at the given Model in the CTOR and
  30     unlockControllers in the DTOR.  Using this ensures that controllers do not
  31     remain locked when leaving a function even in case an exception is thrown.
  32  */
  33 class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockGuardUNO
  34 {
  35 public:
  36     explicit ControllerLockGuardUNO(
  37         const ::com::sun::star::uno::Reference<
  38             ::com::sun::star::frame::XModel > & xModel );
  39     ~ControllerLockGuardUNO();
  40
  41 private:
  42     com::sun::star::uno::Reference< com::sun::star::frame::XModel > mxModel;
  43 };
  44
  45 class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockGuard
  46 {
  47 public:
  48     explicit ControllerLockGuard( ChartModel& rModel );
  49     ~ControllerLockGuard();
  50
  51 private:
  52     ChartModel& mrModel;
  53 };
  54
  55 /** This helper class can be used to pass a locking mechanism to other objects
  56     without exposing the full XModel to it.
  57
  58     Use the ControllerLockHelperGuard to lock/unlock the model during a block of
  59     instructions.
  60  */
  61 class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockHelper
  62 {
  63 public:
  64     explicit ControllerLockHelper(
  65         const ::com::sun::star::uno::Reference<
  66             ::com::sun::star::frame::XModel > & xModel );
  67     ~ControllerLockHelper();
  68
  69     SAL_DLLPRIVATE void lockControllers();
  70     SAL_DLLPRIVATE void unlockControllers();
  71
  72 private:
  73     ::com::sun::star::uno::Reference<
  74             ::com::sun::star::frame::XModel > m_xModel;
  75 };
  76
  77 /** This guard calls lockControllers at the given ControllerLockHelper in the
  78     CTOR and unlockControllers in the DTOR.  Using this ensures that controllers
  79     do not remain locked when leaving a function even in case an exception is
  80     thrown.
  81  */
  82 class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockHelperGuard
  83 {
  84 public:
  85     explicit ControllerLockHelperGuard( ControllerLockHelper & rHelper );
  86     ~ControllerLockHelperGuard();
  87
  88 private:
  89     ControllerLockHelper & m_rHelper;
  90 };
  91
  92 } //  namespace chart
  93
  94 // INCLUDED_CHART2_SOURCE_INC_CONTROLLERLOCKGUARD_HXX
  95 #endif
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */