author | Dario Sestito <darios@symbian.org> |
Fri, 17 Sep 2010 15:37:16 +0100 | |
branch | RCL_3 |
changeset 89 | 9f918e984081 |
parent 88 | 3321d3e205b6 |
child 102 | ba63c83f4716 |
permissions | -rw-r--r-- |
83 | 1 |
/* |
2 |
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). |
|
3 |
* All rights reserved. |
|
4 |
* This component and the accompanying materials are made available |
|
5 |
* under the terms of "Eclipse Public License v1.0" |
|
6 |
* which accompanies this distribution, and is available |
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 |
* |
|
9 |
* Initial Contributors: |
|
10 |
* Nokia Corporation - initial contribution. |
|
11 |
* |
|
12 |
* Contributors: |
|
13 |
* |
|
14 |
* Description: Effect manager. |
|
15 |
* |
|
16 |
*/ |
|
17 |
||
18 |
||
19 |
||
20 |
#ifndef CXNEFFECTMANAGER_H |
|
21 |
#define CXNEFFECTMANAGER_H |
|
22 |
||
23 |
// System incldues |
|
24 |
#include <e32base.h> |
|
25 |
||
26 |
// User includes |
|
27 |
||
28 |
// Forward declarations |
|
29 |
class CAlfEffectObserver; |
|
30 |
class CXnAppUiAdapter; |
|
31 |
class CXnPluginData; |
|
32 |
class CXnViewData; |
|
33 |
class CXnNode; |
|
34 |
||
35 |
// Constants |
|
36 |
||
37 |
// Control effect context ids |
|
38 |
#define KGfxContextAddWidget TUid::Uid( 0x102750F4 ) |
|
39 |
#define KGfxContextRemoveWidget TUid::Uid( 0x102750F4 ) |
|
40 |
#define KGfxContextActivateNextView TUid::Uid( 0x102750F1 ) |
|
41 |
#define KGfxContextActivatePrevView TUid::Uid( 0x102750F2 ) |
|
42 |
#define KGfxContextBgAppear TUid::Uid( 0x102750F3 ) |
|
43 |
||
44 |
// Control effect action ids |
|
45 |
#define KGfxControlActionAppear 3 |
|
46 |
#define KGfxControlActionDisappear 4 |
|
47 |
||
48 |
#define KGfxControlActionAppearPrt 3 |
|
49 |
#define KGfxControlActionDisappearPrt 5 |
|
50 |
#define KGfxControlActionAppearLsc 6 |
|
51 |
#define KGfxControlActionDisappearLsc 7 |
|
52 |
||
53 |
#define KGfxControlActionBgImgToImgAppear 3 |
|
54 |
#define KGfxControlActionBgAnimToImgAppear 5 |
|
55 |
||
56 |
// Full screen effect ids |
|
57 |
#define KGfxContextOpenWallpaperView 1007 |
|
58 |
#define KGfxContextCloseWallpaperView 1008 |
|
59 |
||
60 |
// Class declaration |
|
61 |
/** |
|
62 |
* Struct which holds needed info of effect. |
|
63 |
*/ |
|
64 |
NONSHARABLE_STRUCT( TXnEffect ) |
|
65 |
{ |
|
66 |
TXnEffect() |
|
67 |
: iNode( NULL ), iState( 0 ), iId( 0 ), iExplicitEnd( EFalse ) |
|
68 |
{ |
|
69 |
} |
|
70 |
||
71 |
CXnNode* iNode; |
|
72 |
TBool iExplicitEnd; |
|
73 |
TInt iState; |
|
74 |
TInt iId; |
|
75 |
}; |
|
76 |
||
77 |
/** |
|
78 |
* Effect manager. |
|
79 |
* Handles starting and ending effects. |
|
80 |
* |
|
81 |
* @since S60 v5.0 |
|
82 |
*/ |
|
83 |
NONSHARABLE_CLASS( CXnEffectManager ) : public CTimer |
|
84 |
{ |
|
85 |
public: |
|
86 |
// constructor and destructor |
|
87 |
||
88 |
/** |
|
89 |
* Two-phased constructor. |
|
90 |
* @return new instance of CXnEffectManager. |
|
91 |
*/ |
|
92 |
static CXnEffectManager* NewL( CXnAppUiAdapter& aAppUiAdapter ); |
|
93 |
||
94 |
/** |
|
95 |
* Destructor. |
|
96 |
*/ |
|
97 |
~CXnEffectManager(); |
|
98 |
||
99 |
private: |
|
100 |
// from CTimer |
|
101 |
||
102 |
/** |
|
103 |
* @see CTimer |
|
104 |
*/ |
|
105 |
void RunL(); |
|
106 |
||
107 |
public: |
|
108 |
// new functions |
|
109 |
||
110 |
/** |
|
111 |
* Begin handling of fullscreen effect. |
|
112 |
* |
|
113 |
* @since S60 5.2 |
|
114 |
* @param aId effect id |
|
115 |
* @aView view data |
|
116 |
*/ |
|
117 |
void BeginFullscreenEffectL( TInt aId, CXnViewData& aView ); |
|
118 |
||
119 |
/** |
|
120 |
* Begin handling of fullscreen effect. |
|
121 |
* |
|
122 |
* @since S60 5.2 |
|
123 |
* @param aId effect id |
|
124 |
*/ |
|
125 |
void BeginFullscreenEffectL( TInt aId ); |
|
126 |
||
127 |
/** |
|
128 |
* Ends fullscreen effect. |
|
129 |
* |
|
130 |
* @since S60 5.2 |
|
131 |
* @param aId effect id |
|
132 |
*/ |
|
133 |
void EndFullscreenEffect( TInt aId ); |
|
134 |
||
135 |
/** |
|
136 |
* Begin view change effect |
|
137 |
* |
|
138 |
* @since S60 5.2 |
|
139 |
* @param aThis Active view |
|
140 |
* @param aOther View to activate |
|
141 |
* @param aEffect Effect uid |
|
88
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
142 |
* @param aBgEffectOnly Show only background effect without view animation |
83 | 143 |
* @return ETrue of effect is started, EFalse otherwise |
144 |
*/ |
|
145 |
TBool BeginActivateViewEffect( const CXnViewData& aThis, |
|
146 |
const CXnViewData& aOther, TUid aEffect ); |
|
147 |
||
148 |
/** |
|
149 |
* End view change effect |
|
150 |
* |
|
151 |
* @since S60 5.2 |
|
152 |
* @param aThis Active view |
|
153 |
* @param aOther View to activate |
|
154 |
* @param aEffect Effect uid |
|
155 |
*/ |
|
156 |
void EndActivateViewEffect( const CXnViewData& aThis, |
|
157 |
const CXnViewData& aOther, TUid aEffect ); |
|
158 |
||
159 |
/** |
|
160 |
* Begins background appear effect |
|
161 |
* |
|
162 |
* @since S60 5.2 |
|
163 |
* @param aBg Background control |
|
164 |
* @param aWaitActiveEffect ETrue if active effect is checked, EFalse otherwise |
|
165 |
*/ |
|
166 |
void BgAppearEffect( CCoeControl* aBg, TBool aWaitActiveEffect = EFalse ); |
|
167 |
||
168 |
/** |
|
169 |
* When UiRendered is called effect is ended and will be drawn |
|
170 |
* |
|
171 |
* @since S60 5.2 |
|
172 |
*/ |
|
173 |
void UiRendered(); |
|
174 |
||
175 |
/** |
|
176 |
* When UiLayouted is called effect is started if it was not started earlier. |
|
177 |
* |
|
178 |
* @since S60 5.2 |
|
179 |
*/ |
|
180 |
void UiLayouted(); |
|
181 |
||
182 |
/** |
|
183 |
* Checks if effect is active for control |
|
184 |
* |
|
185 |
* @since S60 5.2 |
|
186 |
* @param aControl Control to check |
|
187 |
* @return ETrue if active, EFalse otherwise |
|
188 |
*/ |
|
189 |
TBool ControlEffectActive( const CCoeControl* aControl ) const; |
|
190 |
||
191 |
/** |
|
192 |
* Updates iLandscape flag |
|
193 |
* |
|
194 |
* @since S60 5.2 |
|
195 |
*/ |
|
196 |
void OrientationChanged(); |
|
197 |
||
198 |
/** |
|
199 |
* Cleanup control effect |
|
200 |
* |
|
201 |
* @since S60 5.2 |
|
202 |
*/ |
|
203 |
void CleanupControlEffect(); |
|
204 |
||
205 |
private: |
|
206 |
// new functions |
|
207 |
||
208 |
/** |
|
209 |
* Starts fullscreen effect. |
|
210 |
* |
|
211 |
* @since S60 5.2 |
|
212 |
* @param aEffect effect data |
|
213 |
* @return ETrue if effect started, otherwise EFalse |
|
214 |
*/ |
|
215 |
TBool DoBeginFullscreenEffect( TXnEffect& aEffect ); |
|
216 |
||
217 |
/** |
|
218 |
* Waits active effects to complete |
|
219 |
* |
|
220 |
* @since S60 5.2 |
|
221 |
* @param aInterval Interval in micro seconds to wait active effects to complete |
|
222 |
* @return ETrue if no active effects ongoing when function returns, EFalse otherwise |
|
223 |
*/ |
|
224 |
TBool WaitActiveEffect( TInt aInterval ); |
|
225 |
||
226 |
private: |
|
227 |
// constructors |
|
228 |
||
229 |
/** |
|
230 |
* C++ default constructor |
|
231 |
*/ |
|
232 |
CXnEffectManager( CXnAppUiAdapter& aAppUiAdapter ); |
|
233 |
||
234 |
/** |
|
235 |
* 2nd phase constructor |
|
236 |
*/ |
|
237 |
void ConstructL(); |
|
238 |
||
239 |
private: |
|
240 |
// data |
|
241 |
||
242 |
/** Effect observer, owned */ |
|
243 |
CAlfEffectObserver* iObserver; |
|
244 |
/** AppUi, not owned */ |
|
245 |
CXnAppUiAdapter& iAppUiAdapter; |
|
246 |
/** List of started effects, owned */ |
|
247 |
RArray< TXnEffect > iEffects; |
|
248 |
/** List of controls in current effect, not owned */ |
|
249 |
RPointerArray< CCoeControl > iControls; |
|
250 |
/** Effect group id */ |
|
251 |
TInt iGroupId; |
|
252 |
/** Flag to indicate whether background effect is started */ |
|
253 |
TBool iBgEffect; |
|
254 |
/** Orientation */ |
|
255 |
TBool iLandscape; |
|
256 |
}; |
|
257 |
||
258 |
#endif // CXNEFFECTMANAGER_H |
|
259 |
||
260 |
// End of File |