inc/FUiAnimIVisualElementAnimationTickEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0/
  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        FUiAnimIVisualElementAnimationTickEventListener.h
  20  * @brief       This is the header file for the %IVisualElementAnimationTickEventListener interface.
  21  *
  22  * This header file contains the declarations of the %IVisualElementAnimationTickEventListener interface.
  23  */
  24
  25 #ifndef _FUI_ANIM_IVISUAL_ELEMENT_ANIMATION_TICK_EVENT_LISTENER_H_
  26 #define _FUI_ANIM_IVISUAL_ELEMENT_ANIMATION_TICK_EVENT_LISTENER_H_
  27
  28 #include <FBaseRtIEventListener.h>
  29
  30 #include <FUiAnimVisualElement.h>
  31 #include <FUiAnimVisualElementAnimation.h>
  32
  33
  34 namespace Tizen { namespace Ui { namespace Animations
  35 {
  36
  37
  38 /**
  39  * @interface   IVisualElementAnimationTickEventListener
  40  * @brief               This interface implements the listener for the %VisualElementAnimation tick events defined in the %Tizen::Ui::Animations namespace.
  41  *
  42  * @since               2.0
  43  *
  44  * The %IVisualElementAnimationTickEventListener interface is the listener interface for receiving animation tick events.
  45  * The class that processes an animation tick event implements this interface, and the instance created with that class is registered with an animation,
  46  * using the VisualElementValueAnimation::SetVisualElementAnimationTickEventListener() method.
  47  * When the animation tick event occurs, a method of that instance is invoked.
  48  *
  49  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/animation_event_handling.htm">Event Handling</a>.
  50  *
  51  */
  52 class _OSP_EXPORT_ IVisualElementAnimationTickEventListener
  53         : virtual public Tizen::Base::Runtime::IEventListener
  54 {
  55 public:
  56
  57         /**
  58          * This is the destructor for this class.
  59          *
  60          * @since       2.0
  61          */
  62         virtual ~IVisualElementAnimationTickEventListener(void);
  63
  64
  65         /**
  66          * Called when a tick event has occurred. @n
  67          * The %OnTickOccurred() callback method will be called with every tick of the animation, using the current value by the UI framework.
  68          *
  69          * @since       2.0
  70          *
  71          * @param[in]   animation       The animation that is running
  72          * @param[in]   keyName         The key name of the animation
  73          * @param[in]   target          The VisualElement object to which the animation is applied
  74          * @param[in]   currentValue    The current value
  75          */
  76         virtual void OnTickOccurred(const Tizen::Ui::Animations::VisualElementAnimation& animation, const Tizen::Base::String& keyName, Tizen::Ui::Animations::VisualElement& target, const Tizen::Ui::Variant& currentValue) = 0;
  77
  78
  79 protected:
  80
  81         //
  82         // This method is for internal use only. Using this method can cause behavioral, security-related,
  83         // and consistency-related issues in the application.
  84         //
  85         //
  86         // This method is reserved and may change its name at any time without prior notice.
  87         //
  88         // @since        2.0
  89         //
  90         virtual void IVisualElementAnimationTickEventListener_Reserved1(void) {}
  91
  92
  93         //
  94         // This method is for internal use only. Using this method can cause behavioral, security-related,
  95         // and consistency-related issues in the application.
  96         //
  97         //
  98         // This method is reserved and may change its name at any time without prior notice.
  99         //
 100         // @since        2.0
 101         //
 102         virtual void IVisualElementAnimationTickEventListener_Reserved2(void) {}
 103
 104
 105         //
 106         // This method is for internal use only. Using this method can cause behavioral, security-related,
 107         // and consistency-related issues in the application.
 108         //
 109         //
 110         // This method is reserved and may change its name at any time without prior notice.
 111         //
 112         // @since        2.0
 113         //
 114         virtual void IVisualElementAnimationTickEventListener_Reserved3(void) {}
 115 };              // IVisualElementAnimationTickEventListener
 116
 117
 118 }}}             // Tizen::Ui::Animations
 119
 120 #endif //_FUI_ANIM_IVISUAL_ELEMENT_ANIMATION_TICK_EVENT_LISTENER_H_