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 HNEVENTGENERATOR_H_

    20 #define HNEVENTGENERATOR_H_

    21 

    22 #include <e32def.h>

    23 

    24 class CLiwGenericParamList;

    25 /**

    26  * @ingroup group_hnengine

    27  * Hierarchy navigator event generator.

    28  * 

    29  * This class is an interface for event triggering in hierarchy navigator.

    30  * Events being triggered may be e.g. SuiteLoaded, ItemFocus, etc.

    31  * It also mediates in events being passed from the UI. 

    32  *

    33  * @lib hnengine

    34  * @since S60 5.0 

    35  */

    36 class MHnEventGenerator

    37     {

    38     public:

    39   

    40     /**

    41     * Method is invoked whenever any component wants to trigger an event 

    42     * inside hierarchy navigator.

    43     * 

    44     * @since S60 5.0

    45     * @param aHnEventId Event type id to trigger.

    46     * @param aRecipientId The id of the recipient item which the event concerns.

    47     * @param aEventParameters Event specific parameters used to perform action.

    48     * @return Status code.

    49     */

    50     virtual TInt TriggerHnEventL( const TInt aHnEventId, const TInt aRecipientId,

    51             CLiwGenericParamList* aEventParameters = NULL ) = 0;

    52     };

    53 

    54 

    55 #endif // HNEVENTGENERATOR_H_