idlehomescreen/xmluirendering/uiengine/inc/xneffectmanager.h
branchRCL_3
changeset 15 ff572dfe6d86
parent 1 5315654608de
child 16 9674c1a575e9
equal deleted inserted replaced
9:f966699dea19 15:ff572dfe6d86
    33  */
    33  */
    34 NONSHARABLE_STRUCT( TXnEffect )
    34 NONSHARABLE_STRUCT( TXnEffect )
    35     {
    35     {
    36     CXnNode* iNode;
    36     CXnNode* iNode;
    37     TInt iState;
    37     TInt iState;
    38     TInt iType;
       
    39     TInt iId;
    38     TInt iId;
    40     };
    39     };
    41 
    40 
    42 /**
    41 /**
    43  *  Effect manager.
    42  *  Effect manager.
    56 
    55 
    57     /**
    56     /**
    58      * Destructor.
    57      * Destructor.
    59      */
    58      */
    60     ~CXnEffectManager();
    59     ~CXnEffectManager();
    61     
       
    62     /**
       
    63      * Begin handling of control effect.
       
    64      * @param aId effect id
       
    65      * @aPlugin Plugin data
       
    66      */
       
    67     void BeginControlEffectL( TInt aId, CXnPluginData& aPlugin );
       
    68     
       
    69     /**
       
    70      * Begin handling of control effect.
       
    71      * @param aId effect id
       
    72      * @aPlugins Array of plugin datas
       
    73      */
       
    74     void BeginControlEffectL( TInt aId, RPointerArray<CXnPluginData>& aPlugins );
       
    75     
    60     
    76     /**
    61     /**
    77      * Begin handling of fullscreen effect.
    62      * Begin handling of fullscreen effect.
    78      * @param aId effect id
    63      * @param aId effect id
    79      * @aView view data
    64      * @aView view data
    95      * Starts fullscreen effect.
    80      * Starts fullscreen effect.
    96      * @param aEffect effect data
    81      * @param aEffect effect data
    97      * @return ETrue if effect started, otherwise EFalse
    82      * @return ETrue if effect started, otherwise EFalse
    98      */
    83      */
    99     TBool DoBeginFullscreenEffect( TXnEffect& aEffect );
    84     TBool DoBeginFullscreenEffect( TXnEffect& aEffect );
   100 
       
   101     /**
       
   102      * Starts control effect.
       
   103      * @param aEffect effect data
       
   104      * @return ETrue if effect started, otherwise EFalse
       
   105      */
       
   106     TBool DoBeginControlEffect( TXnEffect& aEffect );
       
   107     
    85     
   108     /**
    86     /**
   109      * Removes and destroys effect from effect list.
    87      * Removes and destroys effect from effect list.
   110      * @param aEffect effect data
    88      * @param aEffect effect data
   111      */
    89      */
   112     void RemoveEffect( TXnEffect* aEffect );
    90     void RemoveEffect( TXnEffect* aEffect );
   113 
       
   114     /**
       
   115      * Return number of ongoing effects of given type.
       
   116      * @param aType effect type, fullscreen or control
       
   117      * 
       
   118      * @return Number of ongoing effects of given type
       
   119      */
       
   120     TInt EffectCount( TInt aType );
       
   121     
    91     
   122     /**
    92     /**
   123      * C++ default constructor.
    93      * C++ default constructor.
   124      */
    94      */
   125     CXnEffectManager();
    95     CXnEffectManager();