idlefw/tsrc/framework/ut_aifw/stub/inc/aiuicontrollermanager_stub.h
branchRCL_3
changeset 27 2c7f27287390
equal deleted inserted replaced
25:9e077f9a342c 27:2c7f27287390
       
     1 /*
       
     2 * Copyright (c) 2005-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:  UI controller manager stub
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef _AIUICONTROLLERMANAGER_STUB_H
       
    20 #define _AIUICONTROLLERMANAGER_STUB_H
       
    21 
       
    22 // System includes
       
    23 #include <e32base.h>
       
    24 
       
    25 // User includes
       
    26 
       
    27 // Forward declarations
       
    28 class CAiUiController;
       
    29 
       
    30 // Class declaration
       
    31 /**
       
    32  * @ingroup group_aifw
       
    33  * 
       
    34  *  Active Idle UI Controller manager.
       
    35  *
       
    36  *  @since S60 5.2
       
    37  */
       
    38 NONSHARABLE_CLASS( CAiUiControllerManager ) : public CBase                             
       
    39 	{
       
    40 public: 		
       
    41     // Constructors and destructor
       
    42     
       
    43     /**
       
    44      * Two-phased constructor.
       
    45      */ 
       
    46     static CAiUiControllerManager* NewL();
       
    47     
       
    48     /**
       
    49      * Destructor
       
    50      */        
       
    51     ~CAiUiControllerManager();
       
    52     
       
    53 public: 
       
    54     // new functions
       
    55     
       
    56     /**
       
    57      * Gets UI controllers
       
    58      * 
       
    59      * @since S60 5.2
       
    60      * @return Array of UI controllers
       
    61      */
       
    62     RPointerArray< CAiUiController >& UiControllers() const;
       
    63     
       
    64     /**
       
    65      * Actives UI by calling ActivateUI() for each UI controller 
       
    66      * 
       
    67      * @since S60 5.2
       
    68      */
       
    69     //void ActivateUI();
       
    70     
       
    71     /**
       
    72      * Gets the main UI controller
       
    73      * 
       
    74      * @since S60 5.2
       
    75      * @return Main UI controller
       
    76      */
       
    77     //MAiMainUiController& MainUiController() const;
       
    78     
       
    79     /**
       
    80      * Queries whether aUiController is the main UI controller
       
    81      * 
       
    82      * @since S60 5.2
       
    83      * @return ETrue if main UI controller, EFalse otherwise
       
    84      */
       
    85     //TBool IsMainUiController( CAiUiController& aUiController ) const;
       
    86             
       
    87     /**
       
    88      * Calls RunApplicationL for the main UI controller.
       
    89      * 
       
    90      * @since S60 5.2
       
    91      */
       
    92     //void RunApplicationL();
       
    93     
       
    94     /**
       
    95      * Calls LoadUIDefinitionL for each UI controller.
       
    96      * 
       
    97      * @since S60 5.2
       
    98      */
       
    99     //void LoadUIDefinition();
       
   100     
       
   101     /**
       
   102      * Returns the main UI Controller's CONE environment object.
       
   103      * 
       
   104      * @since S60 5.2
       
   105      * @return Control Environment
       
   106      */
       
   107     //CCoeEnv& CoeEnv() const;
       
   108     
       
   109     /**
       
   110      * Destroys all UI controllers except the main controller.
       
   111      * 
       
   112      * @since S60 5.2
       
   113      */
       
   114     //void DestroySecondaryUiControllers();
       
   115         
       
   116     /**
       
   117      * Exits main UI controller
       
   118      * 
       
   119      * @since S60 5.2
       
   120      */		
       
   121     //void ExitMainController();
       
   122     
       
   123     /** 
       
   124      * Sets Fw state handler for each UI conttroller
       
   125      * 
       
   126      * @since S60 5.2
       
   127      * @param aHandler State handler to set
       
   128      */
       
   129     //void SetStateHandler( MAiFwStateHandler& aHandler );    
       
   130                     
       
   131 private: 
       
   132     // private constructors
       
   133 
       
   134     /**
       
   135      * Leaving constructor
       
   136      */    
       
   137     void ConstructL();
       
   138     
       
   139     /**
       
   140      * C++ default constructor
       
   141      */     
       
   142     CAiUiControllerManager();
       
   143         
       
   144 private: 
       
   145     // data
       
   146     
       
   147     /** UI controllers, Owned */
       
   148     mutable RPointerArray< CAiUiController > iUiControllerArray;    
       
   149 	};
       
   150 
       
   151 #endif // _AIUICONTROLLERMANAGER_STUB_H
       
   152