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         EForegroundGain,

    37         EBackgroundGain,

    38         ELightOn,

    39         ELightOff,

    40         ERemoveLiwObjects

    41     };

    42 

    43 

    44 /**

    45  * @ingroup group_hnengine

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

    47  *

    48  * @lib hnengine

    49  * @since S60 v3.2

    50  */

    51 class MHnControllerInterface : public MHnSuiteObserver

    52     {

    53 public:

    54 

    55     /**

    56      * Called when the ui needs to be refreshed,

    57      * for a reason indicated in aRefreshType.

    58      *

    59      * @since S60 v3.2

    60      * @param aRefreshType Defines reason for refresh.

    61      */

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

    63 

    64     /**

    65      * Trigger appropriate action on suite model.

    66      *

    67      * @param aCustomSuiteEvent Event that is associated

    68      *                          with the lifecycle of a suite

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

    70      */

    71     virtual void HandleSuiteEventL ( THnCustomSuiteEvent aCustomSuiteEvent,

    72             CHnSuiteModel *aModel ) = 0;

    73 

    74     /**

    75      * Whenever an action for extension manager occurs it invokes

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

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

    78      *

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

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

    81      *                 Request to the Service.

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

    83      *                        execute action. Extention Manager is its owner.

    84      * @return Number representing error code.

    85      */

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

    87             CLiwGenericParamList* aEventParamList ) = 0;

    88     };

    89 

    90 #endif //HNCONTROLLERINTERFACE_H