inc/FUiAnimIVisualElementAnimationStatusEventListener.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        FUiAnimIVisualElementAnimationStatusEventListener.h
  20  * @brief       This is the header file for the %IVisualElementAnimationStatusEventListener interface.
  21  *
  22  * This header file contains the declarations of the %IVisualElementAnimationStatusEventListener interface.
  23  */
  24
  25 #ifndef _FUI_ANIM_IVISUAL_ELEMENT_ANIMATION_STATUS_EVENT_LISTENER_H_
  26 #define _FUI_ANIM_IVISUAL_ELEMENT_ANIMATION_STATUS_EVENT_LISTENER_H_
  27
  28 #include <FBaseRtIEventListener.h>
  29
  30 namespace Tizen { namespace Base {
  31 class String;
  32 }} // Tizen::Base
  33
  34 namespace Tizen { namespace Ui { namespace Animations
  35 {
  36
  37 class VisualElement;
  38 class VisualElementAnimation;
  39
  40 /**
  41  * @interface   IVisualElementAnimationStatusEventListener
  42  * @brief               This interface implements the listener for the %VisualElementAnimation status events defined in the %Tizen::Ui::Animations namespace.
  43  *
  44  * @since               2.0
  45  *
  46  * The %IVisualElementAnimationStatusEventListener interface is the listener interface for receiving animation status events.
  47  * The class that processes an animation status event implements this interface, and the instance created with that class is
  48  * registered with an animation, using the VisualElementAnimation::SetVisualElementAnimationStatusEventListener() method or
  49  * the AnimationTransaction::SetVisualElementAnimationStatusEventListener() method.
  50  * When the animation status is changing, a method of that instance is invoked.
  51  *
  52  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/animation_event_handling.htm">Event Handling</a>.
  53  *
  54  */
  55 class _OSP_EXPORT_ IVisualElementAnimationStatusEventListener
  56         : virtual public Tizen::Base::Runtime::IEventListener
  57 {
  58 public:
  59
  60         /**
  61          * This is the destructor for this class.
  62          *
  63          * @since       2.0
  64          */
  65         virtual ~IVisualElementAnimationStatusEventListener(void);
  66
  67
  68         /**
  69          * Called when the animation is started.
  70          *
  71          * @since       2.0
  72          *
  73          * @param[in]   animation               The animation that is started
  74          * @param[in]   keyName                 The key name of the animation
  75          * @param[in]   target                  An instance of VisualElement to which the animation is applied
  76          * @remarks             If the key name of the animation is not set, @c keyName is empty string.
  77          */
  78         virtual void OnVisualElementAnimationStarted(const Tizen::Ui::Animations::VisualElementAnimation& animation, const Tizen::Base::String& keyName, Tizen::Ui::Animations::VisualElement& target) = 0;
  79
  80
  81         /**
  82          * Called when the animation is repeated.
  83          *
  84          * @since       2.0
  85          *
  86          * @param[in]   animation               The animation that is repeated
  87          * @param[in]   keyName                 The key name of the animation
  88          * @param[in]   target                  An instance of VisualElement to which the animation is applied
  89          * @param[in]   currentRepeatCount      The current repeat count
  90          * @remarks             If the key name of the animation is not set, @c keyName is empty string.
  91          */
  92         virtual void OnVisualElementAnimationRepeated(const Tizen::Ui::Animations::VisualElementAnimation& animation, const Tizen::Base::String& keyName, Tizen::Ui::Animations::VisualElement& target, long currentRepeatCount) = 0;
  93
  94
  95         /**
  96          * Called when the animation is finished.
  97          *
  98          * @since       2.0
  99          *
 100          * @param[in]   animation               The animation that is finished
 101          * @param[in]   keyName                 The key name of the animation
 102          * @param[in]   target                  An instance of VisualElement to which the animation is applied
 103          * @param[in]   completedNormally       @c true if the animation is completed normally, @n
 104          *                                                                      else @c false
 105          * @remarks             If the key name of the animation is not set, @c keyName is empty string.
 106          */
 107         virtual void OnVisualElementAnimationFinished(const Tizen::Ui::Animations::VisualElementAnimation& animation, const Tizen::Base::String& keyName, Tizen::Ui::Animations::VisualElement& target, bool completedNormally) = 0;
 108
 109
 110 protected:
 111
 112         //
 113         // This method is for internal use only. Using this method can cause behavioral, security-related,
 114         // and consistency-related issues in the application.
 115         //
 116         //
 117         // This method is reserved and may change its name at any time without prior notice.
 118         //
 119         // @since        2.0
 120         //
 121         virtual void IVisualElementAnimationStatusEventListener_Reserved1(void) {}
 122
 123
 124         //
 125         // This method is for internal use only. Using this method can cause behavioral, security-related,
 126         // and consistency-related issues in the application.
 127         //
 128         //
 129         // This method is reserved and may change its name at any time without prior notice.
 130         //
 131         // @since        2.0
 132         //
 133         virtual void IVisualElementAnimationStatusEventListener_Reserved2(void) {}
 134
 135
 136         //
 137         // This method is for internal use only. Using this method can cause behavioral, security-related,
 138         // and consistency-related issues in the application.
 139         //
 140         //
 141         // This method is reserved and may change its name at any time without prior notice.
 142         //
 143         // @since        2.0
 144         //
 145         virtual void IVisualElementAnimationStatusEventListener_Reserved3(void) {}
 146 };              // IVisualElementAnimationStatusEventListener
 147
 148
 149 }}}             // Tizen::Ui::Animations
 150
 151 #endif //_FUI_ANIM_IVISUAL_ELEMENT_ANIMATION_STATUS_EVENT_LISTENER_H_