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:  Active Idle Framework internal state handling interface.

    15 *

    16 */

    17 

    18 

    19 #ifndef M_AIFWSTATEHANDLER_H

    20 #define M_AIFWSTATEHANDLER_H

    21 

    22 // System includes

    23 

    24 // User includes

    25 #include <aifwdefs.h>

    26 

    27 // Forward declarations

    28 class THsPublisherInfo;

    29 

    30 /**

    31  * Active Idle Framework internal state handling interface. 

    32  * Events from UI controllers are forwarded to this interface for processing 

    33  * on the Active Idle Framework side.

    34  *

    35  * @since S60 5.2

    36  */

    37 class MAiFwStateHandler

    38     {

    39 public:

    40     // new functions

    41     

    42     /** 

    43      * Instructs to load plugin

    44      * 

    45      * @since S60 5.2

    46      * @param aPublisherInfo plugin to load

    47      * @param aReason startup reason 

    48      * @return Error code, KErrNone if loaded succesfully.

    49      */    

    50     virtual TInt LoadPlugin( const THsPublisherInfo& aPublisherInfo,

    51         TAiFwLoadReason aReason ) = 0;

    52     

    53     /** 

    54      * Instructs to destroy plugin

    55      * 

    56      * @since S60 5.2

    57      * @param aPublisherInfo plugin to destroy

    58      * @param aReason shutdown reason

    59      */

    60     virtual void DestroyPlugin( const THsPublisherInfo& aPublisherInfo,

    61         TAiFwDestroyReason aReason ) = 0;

    62     

    63     /**

    64      * Instructs to change all plugins' state

    65      * 

    66      * @since S60 5.2

    67      * @param aState State to change

    68      */

    69     virtual void ChangePluginState( TAiFwState aState ) = 0;

    70     

    71     /**

    72      * Queries whether online state is in use

    73      * by any of the currently loaded plugin.

    74      * 

    75      * @since S60 5.2

    76      * @return ETrue if online/offline state needed, EFalse otherwise

    77      */

    78     virtual TBool OnlineStateInUse() const = 0;

    79     };

    80 

    81 #endif // M_AIFWSTATEHANDLER_H

    82 

    83 // End of file