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 #pragma once
  20
  21 #include "charttoolsdllapi.hxx"
  22 #include <rtl/ref.hxx>
  23
  24 namespace chart
  25 {
  26 class ChartModel;
  27 }
  28 namespace com::sun::star::frame
  29 {
  30 class XModel;
  31 }
  32
  33 namespace chart
  34 {
  35 /** This guard calls lockControllers at the given Model in the CTOR and
  36     unlockControllers in the DTOR.  Using this ensures that controllers do not
  37     remain locked when leaving a function even in case an exception is thrown.
  38  */
  39 class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockGuardUNO
  40 {
  41 public:
  42     explicit ControllerLockGuardUNO(rtl::Reference<::chart::ChartModel> xModel);
  43     ~ControllerLockGuardUNO();
  44
  45 private:
  46     rtl::Reference<::chart::ChartModel> mxModel;
  47 };
  48
  49 class ControllerLockGuard
  50 {
  51 public:
  52     explicit ControllerLockGuard(ChartModel& rModel);
  53     ~ControllerLockGuard();
  54
  55 private:
  56     ChartModel& mrModel;
  57 };
  58
  59 /** This helper class can be used to pass a locking mechanism to other objects
  60     without exposing the full XModel to it.
  61
  62     Use the ControllerLockHelperGuard to lock/unlock the model during a block of
  63     instructions.
  64  */
  65 class OOO_DLLPUBLIC_CHARTTOOLS ControllerLockHelper
  66 {
  67 public:
  68     explicit ControllerLockHelper(rtl::Reference<::chart::ChartModel> xModel);
  69     ~ControllerLockHelper();
  70
  71     SAL_DLLPRIVATE void lockControllers();
  72     SAL_DLLPRIVATE void unlockControllers();
  73
  74 private:
  75     rtl::Reference<::chart::ChartModel> 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 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */