sc/inc/chartlock.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
  20 #pragma once
  21
  22 #include <vcl/timer.hxx>
  23
  24 #include <cppuhelper/weakref.hxx>
  25
  26 #include <memory>
  27 #include <vector>
  28
  29 namespace com::sun::star::frame { class XModel; }
  30
  31 class ScDocument;
  32
  33 /** All current charts in the calc will be locked in constructor and unlocked in destructor.
  34 */
  35 class ScChartLockGuard final
  36 {
  37 public:
  38                     ScChartLockGuard( ScDocument* pDoc );
  39                     ~ScChartLockGuard();
  40
  41     void            AlsoLockThisChart( const css::uno::Reference< css::frame::XModel >& xModel );
  42
  43 private:
  44     std::vector< css::uno::WeakReference< css::frame::XModel > > maChartModels;
  45
  46     ScChartLockGuard( const ScChartLockGuard& ) = delete;
  47 };
  48
  49 /** Use this to lock all charts in the calc for a little time.
  50     They will unlock automatically unless you call StartOrContinueLocking() again.
  51 */
  52 class ScTemporaryChartLock final
  53 {
  54 public:
  55                     ScTemporaryChartLock( ScDocument* pDoc );
  56                     ~ScTemporaryChartLock();
  57
  58     void            StartOrContinueLocking();
  59     void            StopLocking();
  60     void            AlsoLockThisChart( const css::uno::Reference< css::frame::XModel >& xModel );
  61
  62 private:
  63     ScDocument*                         mpDoc;
  64     Timer                               maTimer;
  65     std::unique_ptr< ScChartLockGuard >   mapScChartLockGuard;
  66
  67     DECL_LINK(TimeoutHdl, Timer *, void);
  68
  69     ScTemporaryChartLock( const ScTemporaryChartLock& ) = delete;
  70 };
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */