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