homescreensrv_plat/idlefw_api/inc/aiuiidleintegration.h
changeset 0 79c6a41cd166
equal deleted inserted replaced
-1:000000000000 0:79c6a41cd166
       
     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:  Window server plug-in manager.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_AIUIIDLEINTEGRATION_H
       
    20 #define C_AIUIIDLEINTEGRATION_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 class CCoeControl;
       
    25 class TWsEvent;
       
    26 class CEikonEnv;
       
    27 class TVwsViewId;
       
    28 class CAknKeySoundSystem;
       
    29 class MAiFwEventHandler;
       
    30 
       
    31 struct TAiIdleKeySoundConfig
       
    32     {
       
    33     /**
       
    34      * Default constructor. Resets all config fields to null values.
       
    35      */
       
    36     TAiIdleKeySoundConfig() : iKeySounds(NULL), iContextResId(0) { }
       
    37 
       
    38     /// Pointer to AVKON Key sound system
       
    39     CAknKeySoundSystem* iKeySounds;
       
    40 
       
    41     /// Key sound context resource id
       
    42     TInt iContextResId;
       
    43     };
       
    44 
       
    45 /**
       
    46  * Handles Idle integration related tasks and events for Active Idle main UI 
       
    47  * Controller.
       
    48  */
       
    49 class CAiUiIdleIntegration : public CBase
       
    50     {
       
    51 
       
    52 public:
       
    53 
       
    54     IMPORT_C static CAiUiIdleIntegration* NewL(
       
    55         CEikonEnv& aEikEnv,
       
    56     	const TAiIdleKeySoundConfig& aKeySoundConfig,
       
    57         MAiFwEventHandler* aAiFwEventHandler  );
       
    58 
       
    59     ~CAiUiIdleIntegration() { }
       
    60     
       
    61 	/**
       
    62 	 * Tries to bring Active Idle UI to the foreground.
       
    63 	 */
       
    64     virtual void ActivateUI() = 0;
       
    65 
       
    66     /**
       
    67      * Call from entry to Main UI Controller AppUi HandleWsEventL.
       
    68      */
       
    69     virtual void HandleWsEventL( const TWsEvent& aEvent,
       
    70     								CCoeControl* aDestination ) = 0;
       
    71     };
       
    72 
       
    73 #endif // C_AIUIIDLEINTEGRATION_H
       
    74