Fork for IVI: mesa fixing
[profile/ivi/uifw.git] / src / ui / effects / inc / FUiEffects_RuntimeIEffectModelListener.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  * @file        FUiEffects_RuntimeIEffectModelListener.h
19  * @brief       This is the header file for the IEffectModelListener class.
20  */
21
22 #ifndef _FUI_EFFECTS_INTERNAL_RUNTIME_IEFFECT_MODEL_LISTENER_H_
23 #define _FUI_EFFECTS_INTERNAL_RUNTIME_IEFFECT_MODEL_LISTENER_H_
24
25 #include <FUiEffectsTypes.h>
26 #include <FUiEffects_RuntimeModel.h>
27
28 namespace Tizen { namespace Ui { namespace Effects { namespace _Runtime
29 {
30
31 /**
32  * @class       IEffectModelListener
33  * @brief       This class is an interface between EffectModel and _EffectImpl
34  *                      for handling EffectModel events by _EffectImpl
35  *
36  * @since 2.0
37  *
38  */
39 class IEffectModelListener
40 {
41 public:
42         /**
43          * Class destructor
44          *
45          * @since 2.0
46          *
47          */
48         virtual ~IEffectModelListener(void)
49         {
50         }
51
52         /**
53          * Informs effect impl about effect model started
54          *
55          * @since 2.0
56          *
57          */
58         virtual void OnEffectStarted(void) = 0;
59
60         /**
61          * Informs effect impl about effect model finished and it's results
62          *
63          * @since 2.0
64          *
65          */
66         virtual void OnEffectFinished(Tizen::Ui::Effects::EffectResult result, const LastShownBitmapIdCollection& bitmapTargetId) = 0;
67
68         /**
69          * Request to effect impl for bitmap resource updating
70          *
71          * @since 2.0
72          *
73          * @return              bool    true on success and false otherwise
74          */
75         virtual bool OnBitmapRequested(long bitmapId) = 0;
76
77 }; // IEffectModelListener
78
79 } } } } // Tizen::Ui::Effects::_Runtime
80
81 #endif //_FUI_EFFECTS_INTERNAL_RUNTIME_IEFFECT_MODEL_LISTENER_H_