mmappfw_plat/mpx_view_utility_api/inc/mpxviewactivationobserver.h
changeset 0 a2952bb97e68
equal deleted inserted replaced
-1:000000000000 0:a2952bb97e68
       
     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:  MPX view activcation observer interface definition
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef MMPXVIEWACTIVATIONOBSERVER_H
       
    21 #define MMPXVIEWACTIVATIONOBSERVER_H
       
    22 
       
    23 
       
    24 // INCLUDES
       
    25 #include <e32std.h>
       
    26 
       
    27 
       
    28 // FORWARD DECLARATIONS
       
    29 
       
    30 
       
    31 // CLASS DECLARATION
       
    32 
       
    33 /**
       
    34  *  MPX view activation observer.
       
    35  *
       
    36  *  @lib mpxviewutility.lib
       
    37  */
       
    38 NONSHARABLE_CLASS( MMPXViewActivationObserver )
       
    39     {
       
    40 public:
       
    41     enum TViewUpdateEvent
       
    42         {
       
    43         EViewPluginAdd,
       
    44         EViewPluginUpdate,
       
    45         EViewPluginRemove
       
    46         };
       
    47 
       
    48 public:
       
    49 
       
    50     /**
       
    51      * Handle view activation.
       
    52      *
       
    53      * @since S60 3.2.3
       
    54      * @param aCurrentViewType Current view type Uid.
       
    55      * @param aPreviousViewType Previous view type Uid.
       
    56      */
       
    57     virtual void HandleViewActivation(
       
    58         const TUid& aCurrentViewType,
       
    59         const TUid& aPreviousViewType ) = 0;
       
    60 
       
    61     /**
       
    62      * Called in case a view plugin is added/updated/removed through a SIS install.
       
    63      *
       
    64      * @since S60 3.2.3
       
    65      * @param aViewUid view UID
       
    66      * @param aUpdateEvent Defines the update type (addition/update/removal).
       
    67      * @param aLoaded ETrue if the view plugin is loaded, EFalse otherwise. It is recommended
       
    68      *          that client applications exit when loaded plugins are updated or removed.
       
    69      *          This would normally be handled in the AppUi.
       
    70      * @param aData Its meaning depends on the update event:
       
    71      *            EViewPluginAdd - new view plugin version
       
    72      *            EViewPluginUpdate - new view plugin version
       
    73      *            EViewPluginRemove - old view plugin version
       
    74      */
       
    75     virtual void HandleViewUpdate(
       
    76         TUid /* aViewUid */,
       
    77         TViewUpdateEvent /* aUpdateEvent */,
       
    78         TBool /* aLoaded */,
       
    79         TInt /* aData */) {};
       
    80     };
       
    81 
       
    82 #endif  // MMPXVIEWACTIVATIONOBSERVER_H
       
    83 
       
    84 // End of File