sc/inc/chartlock.hxx

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