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 /**
  19  * @file                FUiIAnimationEventListener.h
  20  * @brief               This is the header file for the %IAnimationEventListener interface.
  21  *
  22  * This header file contains the declarations of the %IAnimationEventListener interface.
  23  * If a change event is generated, a method of this interface is called.
  24  * So, for tasks related to change events, use the methods of this interface.
  25  *
  26  */
  27 #ifndef _FUI_IANIMATION_EVENT_LISTENER_H_
  28 #define _FUI_IANIMATION_EVENT_LISTENER_H_
  29
  30 #include <FBaseRtIEventListener.h>
  31 #include <FBaseObject.h>
  32
  33 namespace Tizen { namespace Ui
  34 {
  35
  36 class Control;
  37
  38 /**
  39  * @interface   IAnimationEventListener
  40  * @brief               This interface implements the listener for animation events.
  41  *
  42  * @since               2.0
  43  *
  44  * The %IAnimationEventListener interface is the listener interface for receiving animation events.
  45  * The class that processes an animation event implements this interface, and the instance created with that class is registered
  46  * with a UI control, using the control's @ref Tizen::Ui::Controls::Animation::AddAnimationEventListener() method. When the animation event occurs, the
  47  * @ref OnAnimationStopped() method of that instance is invoked.
  48  * @n
  49  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_animation.htm">Animation</a>.
  50  *
  51  *
  52  */
  53 class IAnimationEventListener
  54         : public Tizen::Base::Runtime::IEventListener
  55 {
  56
  57 public:
  58         /**
  59          * This is the destructor for this class.
  60          *
  61          * @since               2.0
  62          */
  63         virtual ~IAnimationEventListener(void) {}
  64
  65         /**
  66          * Called when the animation is stopped.
  67          *
  68          * @since               2.0
  69          *
  70          * @param[in]   source          The source of the event
  71          */
  72         virtual void OnAnimationStopped(const Tizen::Ui::Control& source) = 0;
  73
  74 protected:
  75         //
  76         // This method is for internal use only.
  77         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  78         //
  79         // This method is reserved and may change its name at any time without
  80         // without prior notice.
  81         //
  82         // @since      2.0
  83         //
  84         virtual void IAnimationEventListener_Reserved1(void) {}
  85
  86         //
  87         // This method is for internal use only.
  88         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  89         //
  90         // This method is reserved and may change its name at any time without
  91         // without prior notice.
  92         //
  93         // @since      2.0
  94         //
  95         virtual void IAnimationEventListener_Reserved2(void) {}
  96
  97         //
  98         // This method is for internal use only.
  99         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 100         //
 101         // This method is reserved and may change its name at any time without
 102         // without prior notice.
 103         //
 104         // @since      2.0
 105         //
 106         virtual void IAnimationEventListener_Reserved3(void) {}
 107
 108 }; // IAnimationEventListener
 109
 110 }} // Tizen::Ui
 111
 112 #endif // _FUI_IANIMATION_EVENT_LISTENER_H_