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  * This header file contains the declarations of the %ITimerEventListener interface.
  22  */
  23 #ifndef _FBASE_RT_I_TIMER_EVENT_LISTENER_H_
  24 #define _FBASE_RT_I_TIMER_EVENT_LISTENER_H_
  25
  26
  27 #include <FBaseResult.h>
  28 #include <FBaseRtIEventListener.h>
  29
  30
  31 namespace Tizen { namespace Base { namespace Runtime
  32 {
  33 class Timer;
  34
  35 /**
  36  * @interface ITimerEventListener
  37  * @brief     This interface is the listener of the timer event.
  38  *
  39  * @since 2.0
  40  *
  41  * The %ITimerEventListener interface is the listener of the timer event.
  42  *
  43  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/timer.htm">Timer</a>.
  44  *
  45  * @see             Timer
  46  */
  47 class _OSP_EXPORT_ ITimerEventListener
  48         : virtual public IEventListener
  49 {
  50 public:
  51         /**
  52          * This is the destructor for this class.
  53          *
  54          * @since 2.0
  55          */
  56         virtual ~ITimerEventListener(void) {}
  57
  58         /**
  59          *      Called when the timer has expired.
  60          *
  61          *  @since 2.0
  62          *
  63          *      @param[in]      timer   The expired timer
  64          */
  65         virtual void OnTimerExpired(Timer& timer) = 0;
  66
  67 }; // ITimerEventListener
  68
  69 } } } // Tizen::Runtime
  70
  71
  72 #endif // _FBASE_RT_I_TIMER_EVENT_LISTENER_H_