1 /*

     2 * Copyright (c) 2007-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:  

    15 *

    16 */

    17 

    18 

    19 #ifndef HNCONTROLLERINTERFACE_H

    20 #define HNCONTROLLERINTERFACE_H

    21 

    22 #include "hnsuiteobserver.h"

    23 

    24 class CLiwGenericParamList; 

    25 

    26 /**

    27  * @ingroup group_hnengine

    28  * User interface refresh type 

    29  */

    30 enum THnUiRefreshType

    31     {

    32         ERefreshSuite,

    33         ERefreshToolbar,

    34         EStartEditMode,

    35         EStopEditMode,

    36         EZoomLarge,

    37         EZoomSmall,

    38         EZoomNormal,

    39         EForegroundGain,

    40         EBackgroundGain,

    41         ELightOn,

    42         ELightOff,

    43         ERemoveLiwObjects

    44     };

    45 

    46 

    47 /**

    48  * @ingroup group_hnengine

    49  * UI refresh observer. The implementing class can be notified about the ui being refreshed.

    50  *

    51  * @lib hnengine

    52  * @since S60 v3.2

    53  */

    54 class MHnControllerInterface : public MHnSuiteObserver

    55     {

    56 public:

    57 

    58     /**

    59      * Called when the ui needs to be refreshed,

    60      * for a reason indicated in aRefreshType.

    61      *

    62      * @since S60 v3.2

    63      * @param aRefreshType Defines reason for refresh.

    64      */

    65     virtual void NotifyUiRefreshL( const THnUiRefreshType aRefreshType ) = 0;

    66     

    67     /**

    68      * Trigger appropriate action on suite model.

    69      * 

    70      * @param aCustomSuiteEvent Event that is associated

    71      *                          with the lifecycle of a suite

    72      * @param aModel Suite model on that custom event should be performed.

    73      */

    74     virtual void HandleSuiteEventL ( THnCustomSuiteEvent aCustomSuiteEvent, 

    75             CHnSuiteModel *aModel ) = 0;

    76     

    77     /**

    78      * Whenever an action for extension manager occurs it invokes

    79      * this method to execute one, passing the information needed

    80      * by extension manager about the action as a parameters.

    81      * 

    82      * @param aUid UID of the ECom plugin's.

    83      * @param aCommand Command which has to be executed on the plugin.

    84      *                 Request to the Service.

    85      * @param aEventParamList List of the event parameters needed to

    86      *                        execute action. Extention Manager is its owner.

    87      * @return Number representing error code.

    88      */

    89     virtual TInt ExecuteExtensionActionL( const TUid aUid , const TDesC& aCommand,

    90             CLiwGenericParamList* aEventParamList ) = 0;

    91     };

    92 

    93 #endif //HNCONTROLLERINTERFACE_H