office-gobmx/sc/inc/refreshtimer.hxx
2011-02-21 10:51:24 -08:00

136 lines
3.5 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef SC_REFRESHTIMER_HXX
#define SC_REFRESHTIMER_HXX
#include <vcl/timer.hxx>
#include <osl/mutex.hxx>
#include <scdllapi.h>
class ScRefreshTimerControl
{
private:
::osl::Mutex aMutex;
USHORT nBlockRefresh;
public:
ScRefreshTimerControl() : nBlockRefresh(0) {}
void SetAllowRefresh( BOOL b )
{
if ( b && nBlockRefresh )
--nBlockRefresh;
else if ( !b && nBlockRefresh < (USHORT)(~0) )
++nBlockRefresh;
}
BOOL IsRefreshAllowed() const { return !nBlockRefresh; }
::osl::Mutex& GetMutex() { return aMutex; }
};
class ScRefreshTimerProtector
{
private:
ScRefreshTimerControl * const * ppControl;
public:
ScRefreshTimerProtector( ScRefreshTimerControl * const * pp );
~ScRefreshTimerProtector()
{
if ( ppControl && *ppControl )
(*ppControl)->SetAllowRefresh( TRUE );
}
};
class ScRefreshTimer : public AutoTimer
{
private:
ScRefreshTimerControl * const * ppControl;
void AppendToControl() {}
void RemoveFromControl() {}
void Start()
{
if ( GetTimeout() )
AutoTimer::Start();
}
public:
ScRefreshTimer() : ppControl(0) { SetTimeout( 0 ); }
ScRefreshTimer( ULONG nSeconds ) : ppControl(0)
{
SetTimeout( nSeconds * 1000 );
Start();
}
ScRefreshTimer( const ScRefreshTimer& r ) : AutoTimer( r ), ppControl(0) {}
virtual ~ScRefreshTimer();
ScRefreshTimer& operator=( const ScRefreshTimer& r )
{
SetRefreshControl(0);
AutoTimer::operator=( r );
return *this;
}
BOOL operator==( const ScRefreshTimer& r ) const
{ return GetTimeout() == r.GetTimeout(); }
BOOL operator!=( const ScRefreshTimer& r ) const
{ return !ScRefreshTimer::operator==( r ); }
void StartRefreshTimer() { Start(); }
void SetRefreshControl( ScRefreshTimerControl * const * pp )
{
RemoveFromControl();
ppControl = pp;
AppendToControl();
}
void SetRefreshHandler( const Link& rLink ) { SetTimeoutHdl( rLink ); }
ULONG GetRefreshDelay() const { return GetTimeout() / 1000; }
void StopRefreshTimer() { Stop(); }
SC_DLLPUBLIC virtual void SetRefreshDelay( ULONG nSeconds );
SC_DLLPUBLIC virtual void Timeout();
};
#endif // SC_REFRESHTIMER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */