sc/inc/chartlock.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef SC_CHARTLOCK_HXX
  29 #define SC_CHARTLOCK_HXX
  30
  31
  32 #include <vcl/timer.hxx>
  33
  34 #include <cppuhelper/weakref.hxx>
  35 #include <com/sun/star/frame/XModel.hpp>
  36
  37 #include <memory>
  38
  39 class ScDocument;
  40
  41 /** All current charts in the calc will be locked in constructor and unlocked in destructor.
  42 */
  43 class ScChartLockGuard
  44 {
  45 public:
  46                     ScChartLockGuard( ScDocument* pDoc );
  47     virtual         ~ScChartLockGuard();
  48
  49     void            AlsoLockThisChart( const ::com::sun::star::uno::Reference<
  50                         ::com::sun::star::frame::XModel >& xModel );
  51
  52 private:
  53     std::vector< ::com::sun::star::uno::WeakReference<
  54         ::com::sun::star::frame::XModel > > maChartModels;
  55
  56     ScChartLockGuard();
  57     ScChartLockGuard( const ScChartLockGuard& );
  58 };
  59
  60 /** Use this to lock all charts in the calc for a little time.
  61     They will unlock automatically unless you call StartOrContinueLocking() again.
  62 */
  63 class ScTemporaryChartLock
  64 {
  65 public:
  66                     ScTemporaryChartLock( ScDocument* pDoc );
  67     virtual         ~ScTemporaryChartLock();
  68
  69     void            StartOrContinueLocking();
  70     void            StopLocking();
  71     void            AlsoLockThisChart( const ::com::sun::star::uno::Reference<
  72                         ::com::sun::star::frame::XModel >& xModel );
  73
  74 private:
  75     ScDocument*                         mpDoc;
  76     Timer                               maTimer;
  77     std::auto_ptr< ScChartLockGuard >   mapScChartLockGuard;
  78
  79     DECL_LINK( TimeoutHdl, Timer* );
  80
  81     ScTemporaryChartLock();
  82     ScTemporaryChartLock( const ScTemporaryChartLock& );
  83 };
  84
  85
  86 #endif