1 /*

     2 * Copyright (c) 2006 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:   Environment class for transition effect plugins.

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef C_ALFSRVEFFECTENV_H

    21 #define C_ALFSRVEFFECTENV_H

    22 

    23 #include <e32base.h>

    24 

    25 class CHuiEnv;

    26 class CHuiControlGroup;

    27 class CHuiDisplay;

    28 class CAlfAppSrvSession;

    29 

    30 /**

    31  * This class implements an environment that can be utilized inside transition

    32  * effect plugins to get access to the UI accelerator toolkit visuals, layouts

    33  * and other resources that are needed in transition effects.

    34  *

    35  */

    36 NONSHARABLE_CLASS(CAlfSrvEffectEnv) : public CBase

    37     {

    38 public:

    39 

    40     /**

    41      * Constructor

    42      */

    43     static CAlfSrvEffectEnv* NewL(CAlfAppSrvSession& aSession);

    44 

    45     /**

    46      * Constructor

    47      */

    48     static CAlfSrvEffectEnv* NewLC(CAlfAppSrvSession& aSession);

    49 

    50     /**

    51      * Destructor

    52      */

    53     ~CAlfSrvEffectEnv();

    54 

    55     /**

    56      * Returns number of available control groups for 

    57      * currently active application.

    58      *

    59      * @return Amount of available control groups.

    60      */

    61     IMPORT_C TInt ControlGroupCountL();

    62 

    63     /**

    64      * Returns number of visible and available control groups

    65      * for currently active application.      

    66      *

    67      * @return Amount of visible and available control groups.

    68      */

    69     IMPORT_C TInt VisibleControlGroupCountL();

    70 

    71     /**

    72      * Returns an available control group based on its index.

    73      *

    74      * @param aIndex Control group index.

    75      * @return Control group

    76      */

    77     IMPORT_C CHuiControlGroup* ControlGroupL( TInt aIndex );

    78     

    79     /**

    80      * Returns a visible control group based on its index.

    81      *

    82      * @param aIndex Control group index.

    83      * @return Control group

    84      */

    85     IMPORT_C CHuiControlGroup* VisibleControlGroupL( TInt aIndex );

    86 

    87     /**

    88      * Returns number of available displays for 

    89      * currently active applicaion.

    90      *

    91      * @return Amount of available displays.

    92      */

    93     IMPORT_C TInt DisplayCountL();

    94 

    95     /**

    96      * Returns an available display based on its index.

    97      *

    98      * @param aIndex Display index.

    99      * @return Display

   100      */

   101     IMPORT_C CHuiDisplay* DisplayL( TInt aIndex );

   102 

   103     /**

   104      * Returns env which is shared between all client apps.

   105      *

   106      * @return HUI Env

   107      */

   108     IMPORT_C CHuiEnv* SharedEnv();

   109 

   110 private:

   111 

   112     // Constructor

   113     CAlfSrvEffectEnv(CAlfAppSrvSession& aSession);

   114     

   115     // ConstructL

   116     void ConstructL();

   117 

   118 private:

   119    

   120    CAlfAppSrvSession* iSession; // Not owned

   121 

   122 };

   123 

   124 

   125 #endif

   126