LibreOffice Module sc (master)  1
refreshtimer.hxx
Go to the documentation of this file.
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 <vcl/timer.hxx>
25 #include "scdllapi.h"
26 #include <memory>
27 #include <mutex>
28 
30 {
31  std::recursive_mutex aMutex;
32  sal_uInt16 nBlockRefresh;
33 
34 public:
35  ScRefreshTimerControl() : nBlockRefresh(0) {}
36  void SetAllowRefresh( bool b );
37  bool IsRefreshAllowed() const { return !nBlockRefresh; }
38  std::recursive_mutex& GetMutex() { return aMutex; }
39 };
40 
41 class ScRefreshTimer : public AutoTimer
42 {
43  std::unique_ptr<ScRefreshTimerControl> const * ppControl;
44 
45 public:
47  ScRefreshTimer( sal_Int32 nSeconds );
48  ScRefreshTimer( const ScRefreshTimer& r );
49  virtual ~ScRefreshTimer() override;
50 
52  bool operator==( const ScRefreshTimer& r ) const;
53  bool operator!=( const ScRefreshTimer& r ) const;
54 
55  void SetRefreshControl( std::unique_ptr<ScRefreshTimerControl> const * pp );
56  void SetRefreshHandler( const Link<Timer *, void>& rLink );
57  sal_Int32 GetRefreshDelaySeconds() const;
58  void StopRefreshTimer();
59 
60  void SetRefreshDelay( sal_Int32 nSeconds );
61  SC_DLLPUBLIC virtual void Invoke() override;
62 
63 private:
64  void Launch();
65 };
66 
67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
ScRefreshTimer & operator=(const ScRefreshTimer &r)
bool operator!=(const ScRefreshTimer &r) const
bool IsRefreshAllowed() const
void SetAllowRefresh(bool b)
void SetRefreshHandler(const Link< Timer *, void > &rLink)
virtual ~ScRefreshTimer() override
virtual SC_DLLPUBLIC void Invoke() override
sal_Int32 GetRefreshDelaySeconds() const
void StopRefreshTimer()
void SetRefreshControl(std::unique_ptr< ScRefreshTimerControl > const *pp)
void SetRefreshDelay(sal_Int32 nSeconds)
std::recursive_mutex aMutex
#define SC_DLLPUBLIC
Definition: scdllapi.h:27
std::unique_ptr< ScRefreshTimerControl > const * ppControl
bool operator==(const ScRefreshTimer &r) const
std::recursive_mutex & GetMutex()