sc/source/core/tool/refreshtimer.cxx

   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 #include "refreshtimer.hxx"
  21 #include "refreshtimerprotector.hxx"
  22
  23 void ScRefreshTimerControl::SetAllowRefresh( sal_Bool b )
  24 {
  25     if ( b && nBlockRefresh )
  26         --nBlockRefresh;
  27     else if ( !b && nBlockRefresh < (sal_uInt16)(~0) )
  28         ++nBlockRefresh;
  29 }
  30
  31 ScRefreshTimerProtector::ScRefreshTimerProtector( ScRefreshTimerControl * const * pp )
  32         :
  33         ppControl( pp )
  34 {
  35     if ( ppControl && *ppControl )
  36     {
  37         (*ppControl)->SetAllowRefresh( false );
  38         // wait for any running refresh in another thread to finnish
  39         ::osl::MutexGuard aGuard( (*ppControl)->GetMutex() );
  40     }
  41 }
  42
  43 ScRefreshTimerProtector::~ScRefreshTimerProtector()
  44 {
  45     if ( ppControl && *ppControl )
  46         (*ppControl)->SetAllowRefresh( true );
  47 }
  48
  49 ScRefreshTimer::ScRefreshTimer() : ppControl(0)
  50 {
  51     SetTimeout( 0 );
  52 }
  53
  54 ScRefreshTimer::ScRefreshTimer( sal_uLong nSeconds ) : ppControl(0)
  55 {
  56     SetTimeout( nSeconds * 1000 );
  57     Start();
  58 }
  59
  60 ScRefreshTimer::ScRefreshTimer( const ScRefreshTimer& r ) : AutoTimer( r ), ppControl(0)
  61 {
  62 }
  63
  64 ScRefreshTimer::~ScRefreshTimer()
  65 {
  66     if ( IsActive() )
  67         Stop();
  68 }
  69
  70 ScRefreshTimer& ScRefreshTimer::operator=( const ScRefreshTimer& r )
  71 {
  72     SetRefreshControl(0);
  73     AutoTimer::operator=( r );
  74     return *this;
  75 }
  76
  77 sal_Bool ScRefreshTimer::operator==( const ScRefreshTimer& r ) const
  78 {
  79     return GetTimeout() == r.GetTimeout();
  80 }
  81
  82 sal_Bool ScRefreshTimer::operator!=( const ScRefreshTimer& r ) const
  83 {
  84     return !ScRefreshTimer::operator==( r );
  85 }
  86
  87 void ScRefreshTimer::StartRefreshTimer()
  88 {
  89     Start();
  90 }
  91
  92 void ScRefreshTimer::SetRefreshControl( ScRefreshTimerControl * const * pp )
  93 {
  94     ppControl = pp;
  95 }
  96
  97 void ScRefreshTimer::SetRefreshHandler( const Link& rLink )
  98 {
  99     SetTimeoutHdl( rLink );
 100 }
 101
 102 sal_uLong ScRefreshTimer::GetRefreshDelay() const
 103 {
 104     return GetTimeout() / 1000;
 105 }
 106
 107 void ScRefreshTimer::StopRefreshTimer()
 108 {
 109     Stop();
 110 }
 111
 112 void ScRefreshTimer::SetRefreshDelay( sal_uLong nSeconds )
 113 {
 114     sal_Bool bActive = IsActive();
 115     if ( bActive && !nSeconds )
 116         Stop();
 117     SetTimeout( nSeconds * 1000 );
 118     if ( !bActive && nSeconds )
 119         Start();
 120 }
 121
 122 void ScRefreshTimer::Timeout()
 123 {
 124     if ( ppControl && *ppControl && (*ppControl)->IsRefreshAllowed() )
 125     {
 126         // now we COULD make the call in another thread ...
 127         ::osl::MutexGuard aGuard( (*ppControl)->GetMutex() );
 128         maTimeoutHdl.Call( this );
 129         // restart from now on, don't execute immediately again if timed out
 130         // a second time during refresh
 131         if ( IsActive() )
 132             Start();
 133     }
 134 }
 135
 136 void ScRefreshTimer::Start()
 137 {
 138     if ( GetTimeout() )
 139         AutoTimer::Start();
 140 }
 141
 142 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */