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