idlehomescreen/widgetmanager/inc/wmeffectmanager.h
changeset 1 5315654608de
child 11 ff572dfe6d86
equal deleted inserted replaced
0:f72a12da539e 1:5315654608de
       
     1 /*
       
     2 * Copyright (c) 2009 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:
       
    15 * CImageConverter declaration
       
    16 *
       
    17 */
       
    18 
       
    19 #ifndef WMEFFECTMANAGER_H
       
    20 #define WMEFFECTMANAGER_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32base.h>
       
    24 
       
    25 class CCoeEnv;
       
    26 // CONSTANTS
       
    27 // Effects
       
    28 const TInt KAppStartCommonDefaultStyle = 3;
       
    29 const TInt KAppExitCommonDefaultStyle = 5;
       
    30 
       
    31 /**
       
    32  *  Struct which holds needed info of effect.
       
    33  */
       
    34 NONSHARABLE_STRUCT( TWmEffect )
       
    35     {
       
    36     TInt iState;
       
    37     TInt iType;
       
    38     TInt iId;
       
    39     };
       
    40 
       
    41 /**
       
    42  *  Effect manager.
       
    43  *  Handles starting and ending effects.
       
    44  *
       
    45  *  @since S60 v5.0
       
    46  */
       
    47 NONSHARABLE_CLASS( CWmEffectManager ) : public CBase
       
    48     {
       
    49 public:
       
    50     /**
       
    51      * Two-phased constructor.
       
    52      * @return new instance of CWmEffectManager.
       
    53      */
       
    54     static CWmEffectManager* NewL( CCoeEnv& aCoeEnv );
       
    55 
       
    56     /**
       
    57      * Destructor.
       
    58      */
       
    59     ~CWmEffectManager();
       
    60     
       
    61 public:
       
    62     /**
       
    63      * Begin handling of fullscreen effect.
       
    64      * @param aId effect id
       
    65      */
       
    66     void BeginFullscreenEffectL( TInt aId );
       
    67     
       
    68     /**
       
    69      * When UiRendered is called effect is ended and will be drawn
       
    70      */
       
    71     void UiRendered();
       
    72     
       
    73 private:    
       
    74     /**
       
    75      * C++ default constructor.
       
    76      */
       
    77     CWmEffectManager( CCoeEnv& aCoeEnv );
       
    78 
       
    79     /**
       
    80      * By default Symbian 2nd phase constructor is private.
       
    81      */
       
    82     void ConstructL();
       
    83     
       
    84 private:
       
    85     /**
       
    86      * Starts fullscreen effect.
       
    87      * @param aEffect effect data
       
    88      */
       
    89     void DoBeginFullscreenEffect( TWmEffect& aEffect );
       
    90     
       
    91     /**
       
    92      * Removes and destroys effect from effect list.
       
    93      * @param aEffect effect data
       
    94      */
       
    95     void RemoveEffect( TWmEffect* aEffect );
       
    96     
       
    97 private: // data
       
    98     /**
       
    99      * List of started effects.
       
   100      */
       
   101     RPointerArray<TWmEffect> iEffects;
       
   102     
       
   103     /**
       
   104      * COE env
       
   105      */
       
   106     CCoeEnv& iCoeEnv;
       
   107     };
       
   108 
       
   109 #endif // WMEFFECTMANAGER_H
       
   110 
       
   111 // End of file