Merge "Add SetInterval, Pause, and Resume APIs in Timer" into devel/master
[platform/core/uifw/dali-adaptor.git] / dali / internal / system / common / timer-interface.h
1 #ifndef __DALI_INTERNAL_ADAPTOR_BASE_TIMER_INTERFACE_H__
2 #define __DALI_INTERNAL_ADAPTOR_BASE_TIMER_INTERFACE_H__
3
4 /*
5  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 namespace Dali
22 {
23 namespace Internal
24 {
25 namespace Adaptor
26 {
27
28 /**
29  * Interface for a timer class
30  */
31 class TimerInterface
32 {
33 public:
34   /**
35    * @copydoc Dali::Timer::Start()
36    */
37   virtual void Start() = 0;
38
39   /**
40    * @copydoc Dali::Timer::Stop()
41    */
42   virtual void Stop() = 0;
43
44   /**
45    * @copydoc Dali::Timer::Pause()
46    */
47   virtual void Pause() = 0;
48
49   /**
50    * @copydoc Dali::Timer::Resume()
51    */
52   virtual void Resume() = 0;
53
54   /**
55    * @copydoc Dali::Timer::SetInterval()
56    */
57   virtual void SetInterval( unsigned int intervalInMilliseconds, bool restart ) = 0;
58
59   /**
60    * @copydoc Dali::Timer::GetInterval()
61    */
62   virtual unsigned int GetInterval() const = 0;
63
64   /**
65    * @copydoc Dali::Timer::IsRunning()
66    */
67   virtual bool IsRunning() const = 0;
68
69 protected:
70   /**
71    * Virtual protected destructor, no deletion through this interface
72    */
73   virtual ~TimerInterface() { }
74 };
75
76
77 } // Adaptor
78 } // Internal
79 } // Dali
80
81 #endif // __DALI_INTERNAL_ADAPTOR_BASE_TIMER_INTERFACE_H__