sc/inc/refreshtimer.hxx

   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 #ifndef INCLUDED_SC_INC_REFRESHTIMER_HXX
  21 #define INCLUDED_SC_INC_REFRESHTIMER_HXX
  22
  23 #include <vcl/timer.hxx>
  24 #include <osl/mutex.hxx>
  25 #include "scdllapi.h"
  26
  27 class ScRefreshTimerControl
  28 {
  29     ::osl::Mutex    aMutex;
  30     sal_uInt16      nBlockRefresh;
  31
  32 public:
  33     ScRefreshTimerControl() : nBlockRefresh(0) {}
  34     void SetAllowRefresh( bool b );
  35     bool IsRefreshAllowed() const { return !nBlockRefresh; }
  36     ::osl::Mutex& GetMutex() { return aMutex; }
  37 };
  38
  39 class ScRefreshTimer : public AutoTimer
  40 {
  41     ScRefreshTimerControl * const * ppControl;
  42
  43 public:
  44     ScRefreshTimer();
  45     ScRefreshTimer( sal_uLong nSeconds );
  46     ScRefreshTimer( const ScRefreshTimer& r );
  47     virtual ~ScRefreshTimer();
  48
  49     ScRefreshTimer& operator=( const ScRefreshTimer& r );
  50     bool operator==( const ScRefreshTimer& r ) const;
  51     bool operator!=( const ScRefreshTimer& r ) const;
  52
  53     void SetRefreshControl( ScRefreshTimerControl * const * pp );
  54     void SetRefreshHandler( const Link& rLink );
  55     sal_uLong GetRefreshDelay() const;
  56     void StopRefreshTimer();
  57
  58     SC_DLLPUBLIC virtual void SetRefreshDelay( sal_uLong nSeconds );
  59     SC_DLLPUBLIC virtual void Timeout() SAL_OVERRIDE;
  60
  61 private:
  62     void Start();
  63 };
  64
  65 #endif // INCLUDED_SC_INC_REFRESHTIMER_HXX
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */