idlefw/inc/framework/aistateobserver.h
branchRCL_3
changeset 9 d0529222e3f0
child 51 15e4dd19031c
equal deleted inserted replaced
4:1a2a00e78665 9:d0529222e3f0
       
     1 /*
       
     2 * Copyright (c) 2008 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:  State Observer
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef _AISTATEOBSERVER_H
       
    20 #define _AISTATEOBSERVER_H
       
    21 
       
    22 // System includes
       
    23 
       
    24 // User includes
       
    25 #include <aifwdefs.h>
       
    26 
       
    27 // Forward declarations
       
    28 class THsPublisherInfo;
       
    29 
       
    30 /**
       
    31  * State Observer
       
    32  * 
       
    33  * @ingroup group_aifw
       
    34  * @lib aifw.lib
       
    35  * @since S60 5.2
       
    36  */
       
    37 class MAiStateObserver
       
    38     {
       
    39 public:
       
    40     /**
       
    41      * State change notification.
       
    42      * 
       
    43      * @since S60 5.2
       
    44      * @param aReason State change.
       
    45      */
       
    46     virtual void NotifyStateChange( TAiFwState aState ) = 0;
       
    47     
       
    48     /**
       
    49      * Content publisher load request.
       
    50      * 
       
    51      * @since S60 5.2
       
    52      * @param aInfo Publisher Info, which describes the plugin to be loaded.
       
    53      * @param aReason Startup reason, which will be forwarded to the plugin.
       
    54      * @return Error code, KErrNone if succesfully loaded. 
       
    55      */
       
    56     virtual TInt NotifyLoadPlugin( const THsPublisherInfo& aInfo,
       
    57         TAiFwLoadReason aReason ) = 0;
       
    58 
       
    59     /**
       
    60      * Content publisher destroy request.
       
    61      * 
       
    62      * @since S60 5.2
       
    63      * @param aInfo Publisher Info, which describes the plugin to be destroyed.
       
    64      * @param aReason Shutdown reason, which will be forwarded to the plugin.
       
    65      */    
       
    66     virtual void NotifyDestroyPlugin( const THsPublisherInfo& aInfo,
       
    67         TAiFwDestroyReason aReason ) = 0;
       
    68     
       
    69     /**
       
    70      * Notifies to update content publishers after Ecom registry change.
       
    71      * 
       
    72      * @since S60 5.2
       
    73      */    
       
    74     virtual void NotifyUpdatePlugins() = 0;
       
    75     
       
    76     /**
       
    77      * Queries whether online state is in use
       
    78      * by any of the currently loaded plugin.
       
    79      * 
       
    80      * @since S60 5.2
       
    81      * @return ETrue if online/offline state needed, EFalse otherwise
       
    82      */
       
    83     virtual TBool OnlineStateInUse() const = 0;    
       
    84     };
       
    85     
       
    86 #endif // _AISTATEOBSERVER_H
       
    87 
       
    88 // End of file