inc/FBaseRtITimerEventListener.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 // http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 /**
  18  * @file                FBaseRtITimerEventListener.h
  19  * @brief               This is the header file for the %ITimerEventListener interface.
  20  *
  21  */
  22 #ifndef _FBASE_RT_I_TIMER_EVENT_LISTENER_H_
  23 #define _FBASE_RT_I_TIMER_EVENT_LISTENER_H_
  24
  25
  26 #include <FBaseResult.h>
  27 #include <FBaseRtIEventListener.h>
  28
  29
  30 namespace Tizen { namespace Base { namespace Runtime
  31 {
  32 class Timer;
  33
  34 /**
  35  * @interface ITimerEventListener
  36  * @brief     This interface is the listener of the timer event.
  37  *
  38  * @since 2.0
  39  *
  40  * The %ITimerEventListener interface is the listener of the timer event.
  41  *
  42  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/timer.htm">Timer</a>.
  43  *
  44  * @see             Timer()
  45  */
  46 class _OSP_EXPORT_ ITimerEventListener
  47         : virtual public IEventListener
  48 {
  49 public:
  50         /**
  51          * This is the destructor for this class.
  52          *
  53          * @since 2.0
  54          */
  55         virtual ~ITimerEventListener(void) {}
  56
  57         /**
  58          *      Called when the timer has expired.
  59          *
  60          *  @since 2.0
  61          *
  62          *      @param[in]      timer   The timer that has expired
  63          */
  64         virtual void OnTimerExpired(Timer& timer) = 0;
  65
  66 }; // ITimerEventListener
  67
  68 } } } // Tizen::Runtime
  69
  70
  71 #endif // _FBASE_RT_I_TIMER_EVENT_LISTENER_H_