timer.h
1 /*
2 ** UICore
3 ** Copyright (c) 1997-2015 The UICore Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries UICore may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 #pragma once
30 
31 #include <memory>
32 #include <functional>
33 
34 namespace uicore
35 {
37  class Timer
38  {
39  public:
41  static std::shared_ptr<Timer> create();
42 
44  virtual bool repeating() const = 0;
45 
47  virtual unsigned int timeout() const = 0;
48 
50  virtual std::function<void()> &func_expired() = 0;
51 
53  virtual void start(unsigned int timeout, bool repeat = true) = 0;
54 
56  virtual void stop() = 0;
57  };
58 
59  typedef std::shared_ptr<Timer> TimerPtr;
60 }
virtual bool repeating() const =0
Returns true if the timer repeats until it is stopped.
virtual void stop()=0
Stop the timer.
virtual void start(unsigned int timeout, bool repeat=true)=0
Starts the timer. Timeout in milliseconds.
Timer class that invokes a callback on a specified interval.
Definition: timer.h:37
static std::shared_ptr< Timer > create()
Constructs a timer object.
virtual unsigned int timeout() const =0
Returns the current timeout. In milliseconds.
std::shared_ptr< Timer > TimerPtr
Definition: timer.h:59
virtual std::function< void()> & func_expired()=0
Callback invoked every time the timer interval occurs.
Definition: Application/application.h:35