timer.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib 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 ClanLib 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 "../api_core.h"
32 #include <memory>
33 
34 namespace clan
35 {
36 
37 class Timer_Impl;
38 class Callback_v0;
39 
41 class CL_API_CORE Timer
42 {
45 public:
47  Timer();
48 
50  virtual ~Timer();
51 
53  bool is_repeating() const;
54 
56  unsigned int get_timeout() const;
58 
61 public:
63  Callback_v0 &func_expired();
65 
68 public:
70  void start(unsigned int timeout, bool repeat=true);
71 
73  void stop();
75 
78 private:
79  std::shared_ptr<Timer_Impl> impl;
81 };
82 
83 }
Timer class that invokes a callback on a specified interval.
Definition: timer.h:41
Callback_v0.
Definition: callback_v0.h:152