idlehomescreen/widgetmanager/inc/wmeffectmanager.h
branchRCL_3
changeset 23 7be2816dbabd
parent 11 ff572dfe6d86
equal deleted inserted replaced
19:79311d856354 23:7be2816dbabd
    21 
    21 
    22 //  INCLUDES
    22 //  INCLUDES
    23 #include <e32base.h>
    23 #include <e32base.h>
    24 
    24 
    25 class CCoeEnv;
    25 class CCoeEnv;
       
    26 class CAlfEffectObserver;
       
    27 
    26 // CONSTANTS
    28 // CONSTANTS
    27 // Effects
    29 // Effects
    28 const TInt KAppStartEffectStyle = 1007;
    30 const TInt KAppStartEffectStyle = 1007;
    29 const TInt KAppExitEffectStyle = 1008;
    31 const TInt KAppExitEffectStyle = 1008;
    30 
    32 
    68     /**
    70     /**
    69      * When UiRendered is called effect is ended and will be drawn
    71      * When UiRendered is called effect is ended and will be drawn
    70      */
    72      */
    71     void UiRendered();
    73     void UiRendered();
    72     
    74     
       
    75     /**
       
    76      * Returns true if effect is ongoing.
       
    77      */
       
    78     TBool IsEffectActive();
       
    79     
    73 private:    
    80 private:    
    74     /**
    81     /**
    75      * C++ default constructor.
    82      * C++ default constructor.
    76      */
    83      */
    77     CWmEffectManager( CCoeEnv& aCoeEnv );
    84     CWmEffectManager( CCoeEnv& aCoeEnv );
    83     
    90     
    84 private:
    91 private:
    85     /**
    92     /**
    86      * Starts fullscreen effect.
    93      * Starts fullscreen effect.
    87      * @param aEffect effect data
    94      * @param aEffect effect data
       
    95      * @return ETrue if effect is started, EFalse otherwise.
    88      */
    96      */
    89     void DoBeginFullscreenEffect( TWmEffect& aEffect );
    97     TBool DoBeginFullscreenEffect( TWmEffect& aEffect );
       
    98     
       
    99     /**
       
   100      * Waits ongoing effect to complete.
       
   101      * @param aInterval Time to wait for complete.
       
   102      * @return ETrue if effect completed in given time, EFalse otherwise.
       
   103      */
       
   104     TBool WaitActiveEffect( TInt aInterval );
    90     
   105     
    91     /**
   106     /**
    92      * Removes and destroys effect from effect list.
   107      * Removes and destroys effect from effect list.
    93      * @param aEffect effect data
   108      * @param aEffect effect data
    94      */
   109      */
   102     
   117     
   103     /**
   118     /**
   104      * COE env
   119      * COE env
   105      */
   120      */
   106     CCoeEnv& iCoeEnv;
   121     CCoeEnv& iCoeEnv;
       
   122     
       
   123     /**
       
   124      * Effect observer
       
   125      */
       
   126     CAlfEffectObserver* iObserver;
   107     };
   127     };
   108 
   128 
   109 #endif // WMEFFECTMANAGER_H
   129 #endif // WMEFFECTMANAGER_H
   110 
   130 
   111 // End of file
   131 // End of file