inc/FUiAnimIAnimationTransactionEventListener.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        FUiAnimIAnimationTransactionEventListener.h
  20  * @brief       This is the header file for the %IAnimationTransactionEventListener interface.
  21  *
  22  * This header file contains the declarations of the %IAnimationTransactionEventListener interface.
  23  */
  24
  25 #ifndef _FUI_ANIM_IANIMATION_TRANSACTION_EVENT_LISTENER_H_
  26 #define _FUI_ANIM_IANIMATION_TRANSACTION_EVENT_LISTENER_H_
  27
  28 #include <FBaseTypes.h>
  29 #include <FBaseRtIEventListener.h>
  30 #include <FUiAnimTypes.h>
  31
  32 namespace Tizen { namespace Ui { namespace Animations
  33 {
  34
  35
  36 /**
  37  * @interface   IAnimationTransactionEventListener
  38  * @brief               This interface implements the listener for the animation transaction events defined in the Tizen::Ui::Animations namespace.
  39  *
  40  * @since               2.0
  41  *
  42  * The %IAnimationTransactionEventListener interface is the listener interface for receiving animation transaction events.
  43  * The class that processes an animation transaction event implements this interface, and the instance created with that class is
  44  * registered with AnimationTransaction, using the AnimationTransaction::SetTransactionEventListener() method. When the animation
  45  * transaction event occurs, a method of that instance is invoked.
  46  *
  47  */
  48 class _OSP_EXPORT_ IAnimationTransactionEventListener
  49         : virtual public Tizen::Base::Runtime::IEventListener
  50 {
  51 public:
  52
  53         /**
  54          * This is the destructor for this class.
  55          *
  56          * @since       2.0
  57          */
  58         virtual ~IAnimationTransactionEventListener(void) {}
  59
  60
  61         /**
  62          * Called when the transaction starts.
  63          *
  64          * @since               2.0
  65          *
  66          * @param[in]   transactionId           The transaction ID of the transaction for which the event has occurred
  67          */
  68         virtual void OnAnimationTransactionStarted(int transactionId) = 0;
  69
  70
  71         /**
  72          * Called when the transaction stops.
  73          *
  74          * @since               2.0
  75          *
  76          * @param[in]   transactionId           The transaction ID of the transaction for which the event has occurred
  77          * @remarks     This callback is called when user calls AnimationTransaction::Stop().
  78          */
  79         virtual void OnAnimationTransactionStopped(int transactionId) = 0;
  80
  81
  82         /**
  83          * Called when the transaction is finished.
  84          *
  85          * @since               2.0
  86          *
  87          * @param[in]   transactionId           The ID of the transaction for which the event has occurred
  88          * @remarks     This callback is called when all the animations in a transaction are finished.
  89          */
  90         virtual void OnAnimationTransactionFinished(int transactionId) = 0;
  91
  92
  93 protected:
  94
  95         //
  96         // This method is for internal use only. Using this method can cause behavioral, security-related,
  97         // and consistency-related issues in the application.
  98         //
  99         // This method is reserved and may change its name at any time without
 100         // prior notice.
 101         //
 102         // @since  2.0
 103         //
 104         virtual void IAnimationTransactionEventListener_Reserved1(void) { }
 105
 106
 107         //
 108         // This method is for internal use only. Using this method can cause behavioral, security-related,
 109         // and consistency-related issues in the application.
 110         //
 111         // This method is reserved and may change its name at any time without
 112         // prior notice.
 113         //
 114         // @since  2.0
 115         //
 116         virtual void IAnimationTransactionEventListener_Reserved2(void) { }
 117
 118
 119         //
 120         // This method is for internal use only. Using this method can cause behavioral, security-related,
 121         // and consistency-related issues in the application.
 122         //
 123         // This method is reserved and may change its name at any time without
 124         // prior notice.
 125         //
 126         // @since  2.0
 127         //
 128         virtual void IAnimationTransactionEventListener_Reserved3(void) { }
 129 };              // IAnimationTransactionEventListener
 130
 131
 132 }}}             // Tizen::Ui::Animations
 133
 134 #endif // _FUI_ANIM_IANIMATION_TRANSACTION_EVENT_LISTENER_H_