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