1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef SC_REFRESHTIMER_HXX 29*cdf0e10cSrcweir #define SC_REFRESHTIMER_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir #include <tools/list.hxx> 32*cdf0e10cSrcweir #include <vcl/timer.hxx> 33*cdf0e10cSrcweir #include <vos/mutex.hxx> 34*cdf0e10cSrcweir #include <scdllapi.h> 35*cdf0e10cSrcweir 36*cdf0e10cSrcweir #define SC_REFRESHTIMER_CONTROL_LIST 0 37*cdf0e10cSrcweir #if SC_REFRESHTIMER_CONTROL_LIST 38*cdf0e10cSrcweir class ScRefreshTimer; 39*cdf0e10cSrcweir DECLARE_LIST( ScRefreshTimerList, ScRefreshTimer* ) 40*cdf0e10cSrcweir #endif 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir class ScRefreshTimerControl 43*cdf0e10cSrcweir { 44*cdf0e10cSrcweir private: 45*cdf0e10cSrcweir ::vos::OMutex aMutex; 46*cdf0e10cSrcweir sal_uInt16 nBlockRefresh; 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir public: 49*cdf0e10cSrcweir #if SC_REFRESHTIMER_CONTROL_LIST 50*cdf0e10cSrcweir ScRefreshTimerList aList; 51*cdf0e10cSrcweir #endif 52*cdf0e10cSrcweir 53*cdf0e10cSrcweir ScRefreshTimerControl() : nBlockRefresh(0) {} 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir void SetAllowRefresh( sal_Bool b ) 56*cdf0e10cSrcweir { 57*cdf0e10cSrcweir if ( b && nBlockRefresh ) 58*cdf0e10cSrcweir --nBlockRefresh; 59*cdf0e10cSrcweir else if ( !b && nBlockRefresh < (sal_uInt16)(~0) ) 60*cdf0e10cSrcweir ++nBlockRefresh; 61*cdf0e10cSrcweir } 62*cdf0e10cSrcweir sal_Bool IsRefreshAllowed() const { return !nBlockRefresh; } 63*cdf0e10cSrcweir ::vos::OMutex& GetMutex() { return aMutex; } 64*cdf0e10cSrcweir }; 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir class ScRefreshTimerProtector 68*cdf0e10cSrcweir { 69*cdf0e10cSrcweir private: 70*cdf0e10cSrcweir ScRefreshTimerControl * const * ppControl; 71*cdf0e10cSrcweir public: 72*cdf0e10cSrcweir ScRefreshTimerProtector( ScRefreshTimerControl * const * pp ); 73*cdf0e10cSrcweir ~ScRefreshTimerProtector() 74*cdf0e10cSrcweir { 75*cdf0e10cSrcweir if ( ppControl && *ppControl ) 76*cdf0e10cSrcweir (*ppControl)->SetAllowRefresh( sal_True ); 77*cdf0e10cSrcweir } 78*cdf0e10cSrcweir }; 79*cdf0e10cSrcweir 80*cdf0e10cSrcweir 81*cdf0e10cSrcweir class ScRefreshTimer : public AutoTimer 82*cdf0e10cSrcweir { 83*cdf0e10cSrcweir private: 84*cdf0e10cSrcweir ScRefreshTimerControl * const * ppControl; 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir void AppendToControl() 87*cdf0e10cSrcweir { 88*cdf0e10cSrcweir #if SC_REFRESHTIMER_CONTROL_LIST 89*cdf0e10cSrcweir if ( ppControl && *ppControl ) 90*cdf0e10cSrcweir (*ppControl)->aList.Insert( this, LIST_APPEND ); 91*cdf0e10cSrcweir #endif 92*cdf0e10cSrcweir } 93*cdf0e10cSrcweir void RemoveFromControl() 94*cdf0e10cSrcweir { 95*cdf0e10cSrcweir #if SC_REFRESHTIMER_CONTROL_LIST 96*cdf0e10cSrcweir if ( ppControl && *ppControl ) 97*cdf0e10cSrcweir (*ppControl)->aList.Remove( this ); 98*cdf0e10cSrcweir #endif 99*cdf0e10cSrcweir } 100*cdf0e10cSrcweir 101*cdf0e10cSrcweir void Start() 102*cdf0e10cSrcweir { 103*cdf0e10cSrcweir if ( GetTimeout() ) 104*cdf0e10cSrcweir AutoTimer::Start(); 105*cdf0e10cSrcweir } 106*cdf0e10cSrcweir 107*cdf0e10cSrcweir public: 108*cdf0e10cSrcweir ScRefreshTimer() : ppControl(0) 109*cdf0e10cSrcweir { SetTimeout( 0 ); } 110*cdf0e10cSrcweir ScRefreshTimer( sal_uLong nSeconds ) : ppControl(0) 111*cdf0e10cSrcweir { 112*cdf0e10cSrcweir SetTimeout( nSeconds * 1000 ); 113*cdf0e10cSrcweir Start(); 114*cdf0e10cSrcweir } 115*cdf0e10cSrcweir ScRefreshTimer( const ScRefreshTimer& r ) 116*cdf0e10cSrcweir : AutoTimer( r ), ppControl(0) 117*cdf0e10cSrcweir {} 118*cdf0e10cSrcweir virtual ~ScRefreshTimer(); 119*cdf0e10cSrcweir 120*cdf0e10cSrcweir ScRefreshTimer& operator=( const ScRefreshTimer& r ) 121*cdf0e10cSrcweir { 122*cdf0e10cSrcweir SetRefreshControl(0); 123*cdf0e10cSrcweir AutoTimer::operator=( r ); 124*cdf0e10cSrcweir return *this; 125*cdf0e10cSrcweir } 126*cdf0e10cSrcweir 127*cdf0e10cSrcweir sal_Bool operator==( const ScRefreshTimer& r ) const 128*cdf0e10cSrcweir { return GetTimeout() == r.GetTimeout(); } 129*cdf0e10cSrcweir 130*cdf0e10cSrcweir sal_Bool operator!=( const ScRefreshTimer& r ) const 131*cdf0e10cSrcweir { return !ScRefreshTimer::operator==( r ); } 132*cdf0e10cSrcweir 133*cdf0e10cSrcweir void StartRefreshTimer() 134*cdf0e10cSrcweir { Start(); } 135*cdf0e10cSrcweir 136*cdf0e10cSrcweir void SetRefreshControl( ScRefreshTimerControl * const * pp ) 137*cdf0e10cSrcweir { 138*cdf0e10cSrcweir RemoveFromControl(); 139*cdf0e10cSrcweir ppControl = pp; 140*cdf0e10cSrcweir AppendToControl(); 141*cdf0e10cSrcweir } 142*cdf0e10cSrcweir 143*cdf0e10cSrcweir void SetRefreshHandler( const Link& rLink ) 144*cdf0e10cSrcweir { SetTimeoutHdl( rLink ); } 145*cdf0e10cSrcweir 146*cdf0e10cSrcweir sal_uLong GetRefreshDelay() const 147*cdf0e10cSrcweir { return GetTimeout() / 1000; } 148*cdf0e10cSrcweir 149*cdf0e10cSrcweir void StopRefreshTimer() 150*cdf0e10cSrcweir { Stop(); } 151*cdf0e10cSrcweir 152*cdf0e10cSrcweir SC_DLLPUBLIC virtual void SetRefreshDelay( sal_uLong nSeconds ); 153*cdf0e10cSrcweir SC_DLLPUBLIC virtual void Timeout(); 154*cdf0e10cSrcweir }; 155*cdf0e10cSrcweir 156*cdf0e10cSrcweir 157*cdf0e10cSrcweir #endif // SC_REFRESHTIMER_HXX 158*cdf0e10cSrcweir 159