2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
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
9 // http://floralicense.org/license/
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.
19 * @file FUiAnimIControlAnimatorEventListener.h
20 * @brief This is the header file for the %IControlAnimatorEventListener interface.
22 * This header file contains the declarations of the %IControlAnimatorEventListener interface.
25 #ifndef _FUI_ANIM_ICONTROL_ANIMATOR_EVENT_LISTENER_H_
26 #define _FUI_ANIM_ICONTROL_ANIMATOR_EVENT_LISTENER_H_
28 #include <FBaseTypes.h>
29 #include <FBaseObject.h>
30 #include <FBaseRtIEventListener.h>
32 #include <FUiAnimAnimationBase.h>
35 namespace Tizen { namespace Ui
39 namespace Tizen { namespace Ui { namespace Animations
41 class ControlAnimator;
44 namespace Tizen { namespace Ui { namespace Animations
49 * @interface IControlAnimatorEventListener
50 * @brief This interface implements the listener for animation events.
54 * The %IControlAnimatorEventListener interface is the listener interface for receiving control animator events.
55 * The class that processes a control animator event implements this interface, and the instance created with that class is
56 * registered with a UI control, using the ControlAnimator::AddControlAnimatorEventListener() method. When the control animator event
57 * occurs, a method of that instance is invoked.
59 class _OSP_EXPORT_ IControlAnimatorEventListener
60 : virtual public Tizen::Base::Runtime::IEventListener
65 * This is the destructor for this class.
69 virtual ~IControlAnimatorEventListener(void) {}
73 * Called when an animation starts on the specified control.
77 * @param[in] source The source of the event
78 * @param[in] control The control on which an animation starts
80 virtual void OnControlAnimationStarted(Tizen::Ui::Animations::ControlAnimator& source, Tizen::Ui::Control& control) = 0;
84 * Called when all the animations currently associated with a control have finished.
88 * @param[in] source The source of the event
89 * @param[in] control The control on which all the animations have finished
91 virtual void OnControlAnimationFinished(Tizen::Ui::Animations::ControlAnimator& source, Tizen::Ui::Control& control) = 0;
95 * Called when all the animations currently associated with a control have stopped.
99 * @param[in] source The source of the event
100 * @param[in] control The control on which all the animations have stopped
102 virtual void OnControlAnimationStopped(Tizen::Ui::Animations::ControlAnimator& source, Tizen::Ui::Control& control) = 0;
108 // This method is for internal use only. Using this method can cause behavioral, security-related,
109 // and consistency-related issues in the application.
111 // This method is reserved and may change its name at any time without
116 virtual void IControlAnimatorEventListener_Reserved1(void) { }
120 // This method is for internal use only. Using this method can cause behavioral, security-related,
121 // and consistency-related issues in the application.
123 // This method is reserved and may change its name at any time without
128 virtual void IControlAnimatorEventListener_Reserved2(void) { }
132 // This method is for internal use only. Using this method can cause behavioral, security-related,
133 // and consistency-related issues in the application.
135 // This method is reserved and may change its name at any time without
140 virtual void IControlAnimatorEventListener_Reserved3(void) { }
141 }; // IControlAnimatorEventListener
144 }}} // Tizen::Ui::Animations
146 #endif // _FUI_ANIM_ICONTROL_ANIMATOR_EVENT_LISTENER_H_