inc/FUiIAnimationEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://floralicense.org/license/
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an AS IS BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17 /**
  18  * @file                FUiIAnimationEventListener.h
  19  * @brief               This is the header file for the %IAnimationEventListener interface.
  20  *
  21  * This header file contains the declarations of the %IAnimationEventListener interface.
  22  * If a change event is generated, a method of this interface is called.
  23  * So, for tasks related to change events, use the methods of this interface.
  24  *
  25  */
  26 #ifndef _FUI_IANIMATION_EVENT_LISTENER_H_
  27 #define _FUI_IANIMATION_EVENT_LISTENER_H_
  28
  29 #include <FBaseRtIEventListener.h>
  30 #include <FBaseObject.h>
  31
  32 namespace Tizen { namespace Ui
  33 {
  34
  35 class Control;
  36
  37 /**
  38  * @interface   IAnimationEventListener
  39  * @brief               This interface implements the listener for animation events.
  40  *
  41  * @since               2.0
  42  *
  43  * The %IAnimationEventListener interface is the listener interface for receiving animation events.
  44  * The class that processes an animation event implements this interface, and the instance created with that class is registered
  45  * with a UI control, using the control's @ref Tizen::Ui::Controls::Animation::AddAnimationEventListener() method. When the animation event occurs, the
  46  * @ref OnAnimationStopped() method of that instance is invoked.
  47  * @n
  48  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_animation.htm">Animation</a>.
  49  *
  50  *
  51  */
  52 class IAnimationEventListener
  53         : public Tizen::Base::Runtime::IEventListener
  54 {
  55
  56 public:
  57         /**
  58          * This is the destructor for this class.
  59          *
  60          * @since               2.0
  61          */
  62         virtual ~IAnimationEventListener(void) {}
  63
  64         /**
  65          * Called when the animation is stopped.
  66          *
  67          * @since               2.0
  68          *
  69          * @param[in]   source          The source of the event
  70          */
  71         virtual void OnAnimationStopped(const Tizen::Ui::Control& source) = 0;
  72
  73 protected:
  74         //
  75         // This method is for internal use only.
  76         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  77         //
  78         // This method is reserved and may change its name at any time without
  79         // without prior notice.
  80         //
  81         // @since      2.0
  82         //
  83         virtual void IAnimationEventListener_Reserved1(void) {}
  84
  85         //
  86         // This method is for internal use only.
  87         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  88         //
  89         // This method is reserved and may change its name at any time without
  90         // without prior notice.
  91         //
  92         // @since      2.0
  93         //
  94         virtual void IAnimationEventListener_Reserved2(void) {}
  95
  96         //
  97         // This method is for internal use only.
  98         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  99         //
 100         // This method is reserved and may change its name at any time without
 101         // without prior notice.
 102         //
 103         // @since      2.0
 104         //
 105         virtual void IAnimationEventListener_Reserved3(void) {}
 106
 107 }; // IAnimationEventListener
 108
 109 }} // Tizen::Ui
 110
 111 #endif // _FUI_IANIMATION_EVENT_LISTENER_H_