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